XmlTextWriter创建XML文件

引言

　　随着XML的普及以及在动态WEB应用程序中大量应用，如何通过.NET创建，删除，修改XML文件变的也来也重要了。一个简单的概念是，XML文件跟大的文本文件并没有什么区别，同时它是先于.NET出现，很多ASP的开发者，当他需要程序输出XML文件的时候，通常都是用Response.Write()方法输出为XML文档。
　　使用Response.Write()的方式来输出XML文档，并不是一种那么好的方法，首先，我们用这种方法输出字符以组成XML文件的时候，我们会很担心输出的这些字符是不是符合XML规范，不符合XML规范的XML文档将不能得到真确完整的显示，如：＜,＞,&"",和'这些符号，当它们在XML文件里的出现的时候，我们必须手工查找这些不合规范的字符；再次，当我们需要输出的是一个包含很多名字空间，属性和元素的XML文件的时候，使用Response.Write()方法所必须的代码将会变得冗长以及可读性差。

　　幸运的是，.NET FrameWork提供了一个特别为创建XML文件使用的类－System.Xml.XmlTextWriter,使用这个类来创建XML文件，你并不需要担心输出是否符合XML规范的问题，同时代码将会变得非常简洁。在这篇文章中，我们将深入的讲述如何使用XmlTextWriter类来创建XML文件。
　　关于XML的说明

　　这篇文章假定读者具备一定的XML基础，如果你刚接触XML，我建议你在继续阅读本文之前，首先去看看“什么是XML”和“XML起步”这些资料。


　　XmlTextWriter对象简介：

　　XmlTextWriter对象包含了很多可用于在创建XML文件时添加元素和属性到XML文件里的方法，比较重要的有：

　　WriteStartDocument()－创建XML文件首先就需要用到这个方法，它是在创建XML文件的第一行代码，用来指定该文件是XML文件以及设置它的编码类型；

　　WriteStartElement(string)－这个方法的作用是在XML文件中创建新元素，你可以通过String参数设置元素的名称（当然了，你还可以使用optional关键字指定一个可选的参数）；

　　WriteElementString(name, text_value)－如果你需要创建一个除了字符，什么也没有的（如不嵌套元素）的元素，你可以使用该方法；

　　WriteEndElement()－对应WriteStartElement(string)方法，作为一个元素的结尾；

　　WriteEndDocument()－XML文件创建完成后使用该方法结束；

　　Close()－关闭所有的文本流，把创建的XML文件输出到指定位置。


　　使用XmlTextWriter对象创建XML文件，需要在类构造器中指定文件的类型，而且编码类型必须是System.Text.Encoding，如：System.Text.Encoding.ASCII, System.Text.Encoding.Unicode及System.Text.Encoding.UTF8，在XmlTextWriter类构造器指定为何种类型，在输出XML文件将以那种流文件形式输出。

　　使用XmlTextWriter对象创建一个简单的XML文件

　　接下来，我们示范一下如何使用XmlTextWriter对象来创建一个简单的XML文档，并把它保存到指定的位置，这个XML文件将包含访问该文件的用户的相关信息，它的输出格式如下：




＜userInfo＞
＜browserInfo＞
＜urlReferrer＞URL referrer info＜/urlReferrer＞
＜userAgent＞User agent referrer info＜/userAgent＞
＜userLanguages＞languages info＜/userLanguages＞
＜/browserInfo＞
＜visitInfo timeVisited="date/time the page was visited"＞
＜ip＞visitor's IP address＜/ip＞
＜rawUrl＞raw URL requested＜/rawUrl＞
＜/visitInfo＞
＜/userInfo＞

　　选用这个有这种结构的XML文件为输出对象，是为了可以在这里使用所有先前讲过的方法，方便阐述。


　　如下便是创建该XML文件所需的ASP.NET代码：

＜%@ Import Namespace="System.Xml" %＞
＜%@ Import Namespace="System.Text" %＞
＜script language="C#" runat="server"＞
void Page_Load(object sender, EventArgs e)
{
// Create a new XmlTextWriter instance
XmlTextWriter writer = new
XmlTextWriter(Server.MapPath("userInfo.xml"), Encoding.UTF8);

// start writing!
writer.WriteStartDocument();
writer.WriteStartElement("userInfo");

// Creating the ＜browserInfo＞ element
writer.WriteStartElement("browserInfo");

if (Request.UrlReferrer == null)
writer.WriteElementString("urlReferrer", "none");
else
writer.WriteElementString("urlReferrer",
Request.UrlReferrer.PathAndQuery);

writer.WriteElementString("userAgent", Request.UserAgent);
writer.WriteElementString("userLanguages",
String.Join(", ", Request.UserLanguages));
writer.WriteEndElement();

// Creating the ＜visitInfo＞ element
writer.WriteStartElement("visitInfo");
writer.WriteAttributeString("timeVisited", DateTime.Now.ToString());
writer.WriteElementString("ip", Request.UserHostAddress);
writer.WriteElementString("rawUrl", Request.RawUrl);
writer.WriteEndElement();

writer.WriteEndElement();
writer.WriteEndDocument();
writer.Close();
}


　　首先我们要注意是否有导入System.Xml and System.Text命名空间，然后我们在Page_Load事件中创建一个XmlTextWriter对象实例，并且指定创建的XML文件保存为userInfo.xml文件和它的编码类型为UTF8（a translation of 16-bit unicode encoding into 8-bits），然后使用WriteStartElement(elementName)方法来创建嵌套了其他元素的元素，并以WriteEndElement()作为结束，此外，我们使用WriteElementString(elementName, textValue)方法来创建最底层即没有嵌套其他元素的元素。


　　在浏览器窗口中输出XML文件

　　先前的例子示范了如何使用XmlTextWriter对象创建xml文件以及把它保存为一个文件，这个文件可能是你所需要的，但是有时候，我们需要把创建的XML文件在浏览器上显示出来，这个时候，我们可以使用上例代码创建userInfo.xml文件，然后打开它，再使用Response.Write()把它输出，但是这种方法并不是很好。

　　一个好的方法是立即把XmlTextWriter对象的结果显示在浏览器上，要实现这个功能非常地容易，只需要在上例的代码基础上修改一行代码就可以了，在XmlTextWriter的类构造器中，我们不指定为一个文件路径，而是指定为Response.OutputStream，以使ASP.NET程序直接输出XML流到浏览器中，而不是保存为一个文件，当然了，你还可以设定＜@ Page ... ＞指令中的MIME类型为text/xml来实现同样的功能，但是我建议你不要用这种方法来实现，因为有些浏览器不认得该格式而把它当做html来解释（它将蕴藏所有的xml元素，并删除所有的空格）。


　　下面列出了上例修改后的部分代码，修改过的代码将一些粗体显示：

＜@ Page ContentType="text/xml" %＞
＜%@ Import Namespace="System.Xml" %＞
＜%@ Import Namespace="System.Text" %＞
＜script language="C#" runat="server"＞
void Page_Load(object sender, EventArgs e)
{
// Create a new XmlTextWriter instance
XmlTextWriter writer = new
XmlTextWriter(Response.OutputStream, Encoding.UTF8);

// start writing!
...
}


　　注意，尽管你访问的是asp.net Web页面，但是你查看该实例所看到的仅仅是XML文档，这个文档跟先前创建的XML文件是一样的，所不同的是，先前是保存为一个XML文件userInfo.xml。


　　总结

　　本文示范了在.NET Framework中如何使用System.Xml.XmlTextWriter类来创建XML文件，XmlTextWriter对象可以创建一个XML文件，并把它保存到指定位置，也可以直接以指定的流形式显示在浏览器上，在很多编码工作中，使用XmlTextWriter对象构建基于XML的程序会有很多的优势，其中主要有可以使代码更加简洁，更具可读性，同时不用担心输出的XML文件是否符合规范.