XmlTextWriter创建XML文件-web前端-IT落伍者

引言

随着XML的普及以及在动态WEB应用程序中大量应用如何通过NET创建删除修改XML文件变的也来也重要了一个简单的概念是XML文件跟大的文本文件并没有什么区别同时它是先于NET出现很多ASP的开发者当他需要程序输出XML文件的时候通常都是用ResponseWrite()方法输出为XML文档

使用ResponseWrite()的方式来输出XML文档并不是一种那么好的方法首先我们用这种方法输出字符以组成XML文件的时候我们会很担心输出的这些字符是不是符合XML规范不符合XML规范的XML文档将不能得到真确完整的显示如＜＞&和这些符号当它们在XML文件里的出现的时候我们必须手工查找这些不合规范的字符再次当我们需要输出的是一个包含很多名字空间属性和元素的XML文件的时候使用ResponseWrite()方法所必须的代码将会变得冗长以及可读性差

幸运的是NET FrameWork提供了一个特别为创建XML文件使用的类－SystemXmlXmlTextWriter使用这个类来创建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文件需要在类构造器中指定文件的类型而且编码类型必须是SystemTextEncoding如SystemTextEncodingASCII SystemTextEncodingUnicode及SystemTextEncodingUTF在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＞visitors IP address＜/ip＞

＜rawUrl＞raw URL requested＜/rawUrl＞

＜/visitInfo＞

＜/userInfo＞

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

如下便是创建该XML文件所需的ASPNET代码

＜%@ Import Namespace=SystemXml %＞

＜%@ Import Namespace=SystemText %＞

＜script language=C# runat=server＞

void Page_Load(object sender EventArgs e)

{

// Create a new XmlTextWriter instance

XmlTextWriter writer = new

XmlTextWriter(ServerMapPath(userInfoxml) EncodingUTF);

// start writing!

writerWriteStartDocument();

writerWriteStartElement(userInfo);

// Creating the ＜browserInfo＞ element

writerWriteStartElement(browserInfo);

if (RequestUrlReferrer == null)

writerWriteElementString(urlReferrer none);

else

writerWriteElementString(urlReferrer

RequestUrlReferrerPathAndQuery);

writerWriteElementString(userAgent RequestUserAgent);

writerWriteElementString(userLanguages

StringJoin( RequestUserLanguages));

writerWriteEndElement();

// Creating the ＜visitInfo＞ element

writerWriteStartElement(visitInfo);

writerWriteAttributeString(timeVisited DateTimeNowToString());

writerWriteElementString(ip RequestUserHostAddress);

writerWriteElementString(rawUrl RequestRawUrl);

writerWriteEndElement();

writerWriteEndDocument();

writerClose();

}

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

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

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

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

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

＜@ Page ContentType=text/xml %＞