C#創(chuàng)建XML文件的利器XmlTextWriter

作者：佚名 2009-08-21 10:00:43

XML在動(dòng)態(tài)WEB應(yīng)用程序中大量應(yīng)用，本文將向您介紹如何使用C#創(chuàng)建XML文件,我們將會(huì)看到.NET平臺(tái)的XmlTextWriter類在創(chuàng)建XML文件方面的簡(jiǎn)潔和高效。

XML可擴(kuò)展標(biāo)記語(yǔ)言是當(dāng)前處理結(jié)構(gòu)化文檔信息的有力工具。在.NET平臺(tái)中，我們可以使用XmlTextWriter對(duì)象通過(guò)C#創(chuàng)建XML文件。在這篇文章中，我們將深入的講述如何使用XmlTextWriter類通過(guò)C#創(chuàng)建XML文件。

引言

隨著XML的普及以及在動(dòng)態(tài)WEB應(yīng)用程序中大量應(yīng)用，如何通過(guò).NET創(chuàng)建，刪除，修改XML文件變的也來(lái)也重要了。一個(gè)簡(jiǎn)單的概念是，XML文件跟大的文本文件并沒(méi)有什么區(qū)別，同時(shí)它是先于.NET出現(xiàn)，很多ASP的開(kāi)發(fā)者，當(dāng)他需要程序輸出XML文件的時(shí)候，通常都是用Response.Write()方法輸出為XML文檔。

使用Response.Write()的方式來(lái)輸出XML文檔，并不是一種那么好的方法，首先，我們用這種方法輸出字符以組成XML文件的時(shí)候，我們會(huì)很擔(dān)心輸出的這些字符是不是符合XML規(guī)范，不符合XML規(guī)范的XML文檔將不能得到真確完整的顯示，如：＜,＞,&"",和'這些符號(hào)，當(dāng)它們?cè)赬ML文件里的出現(xiàn)的時(shí)候，我們必須手工查找這些不合規(guī)范的字符；再次，當(dāng)我們需要輸出的是一個(gè)包含很多名字空間，屬性和元素的XML文件的時(shí)候，使用Response.Write()方法所必須的代碼將會(huì)變得冗長(zhǎng)以及可讀性差。

幸運(yùn)的是，.NET FrameWork提供了一個(gè)特別為創(chuàng)建XML文件使用的類－System.Xml.XmlTextWriter,使用這個(gè)類來(lái)創(chuàng)建XML文件，你并不需要擔(dān)心輸出是否符合XML規(guī)范的問(wèn)題，同時(shí)代碼將會(huì)變得非常簡(jiǎn)潔。在這篇文章中，我們將深入的講述如何使用XmlTextWriter類通過(guò)C#創(chuàng)建XML文件。

XmlTextWriter對(duì)象簡(jiǎn)介：

XmlTextWriter對(duì)象包含了很多可用于在創(chuàng)建XML文件時(shí)添加元素和屬性到XML文件里的方法，比較重要的有：

◆WriteStartDocument()－創(chuàng)建XML文件首先就需要用到這個(gè)方法，它是在創(chuàng)建XML文件的***行代碼，用來(lái)指定該文件是XML文件以及設(shè)置它的編碼類型；

◆WriteStartElement(string)－這個(gè)方法的作用是在XML文件中創(chuàng)建新元素，你可以通過(guò)String參數(shù)設(shè)置元素的名稱（當(dāng)然了，你還可以使用optional關(guān)鍵字指定一個(gè)可選的參數(shù)）；

◆WriteElementString(name, text_value)－如果你需要?jiǎng)?chuàng)建一個(gè)除了字符，什么也沒(méi)有的（如不嵌套元素）的元素，你可以使用該方法；

◆WriteEndElement()－對(duì)應(yīng)WriteStartElement(string)方法，作為一個(gè)元素的結(jié)尾；

◆WriteEndDocument()－XML文件創(chuàng)建完成后使用該方法結(jié)束；

◆Close()－關(guān)閉所有的文本流，把創(chuàng)建的XML文件輸出到指定位置。

使用XmlTextWriter對(duì)象創(chuàng)建XML文件，需要在類構(gòu)造器中指定文件的類型，而且編碼類型必須是System.Text.Encoding，如：System.Text.Encoding.ASCII, System.Text.Encoding.Unicode及System.Text.Encoding.UTF8，在XmlTextWriter類構(gòu)造器指定為何種類型，在輸出XML文件將以那種流文件形式輸出。#p#

使用XmlTextWriter對(duì)象通過(guò)C#創(chuàng)建XML文件

接下來(lái)，我們示范一下如何使用XmlTextWriter對(duì)象來(lái)創(chuàng)建一個(gè)簡(jiǎn)單的XML文檔，并把它保存到指定的位置，這個(gè)XML文件將包含訪問(wèn)該文件的用戶的相關(guān)信息，它的輸出格式如下：

＜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＞

選用這個(gè)有這種結(jié)構(gòu)的XML文件為輸出對(duì)象，是為了可以在這里使用所有先前講過(guò)的方法，方便闡述。

如下便是創(chuàng)建該XML文件所需的ASP.NET代碼：

XmlTextWriter writer= new XmlTextWriter(Server.MapPath("phone4.xml"),null);  
　writer.Formatting = Formatting.Indented; //縮進(jìn)格式  
　writer.Indentation =4;

首先我們要注意是否有導(dǎo)入System.Xml and System.Text命名空間，然后我們?cè)赑age_Load事件中創(chuàng)建一個(gè)XmlTextWriter對(duì)象實(shí)例，并且指定創(chuàng)建的XML文件保存為userInfo.xml文件和它的編碼類型為UTF8（a translation of 16-bit unicode encoding into 8-bits），然后使用WriteStartElement(elementName)方法來(lái)創(chuàng)建嵌套了其他元素的元素，并以WriteEndElement()作為結(jié)束，此外，我們使用WriteElementString(elementName, textValue)方法來(lái)創(chuàng)建***層即沒(méi)有嵌套其他元素的元素。

在瀏覽器窗口中輸出XML文件

先前的例子示范了如何使用XmlTextWriter對(duì)象通過(guò)C#創(chuàng)建XML文件以及把它保存為一個(gè)文件，這個(gè)文件可能是你所需要的，但是有時(shí)候，我們需要把創(chuàng)建的XML文件在瀏覽器上顯示出來(lái)，這個(gè)時(shí)候，我們可以使用上例代碼創(chuàng)建userInfo.xml文件，然后打開(kāi)它，再使用Response.Write()把它輸出，但是這種方法并不是很好。

一個(gè)好的方法是立即把XmlTextWriter對(duì)象的結(jié)果顯示在瀏覽器上，要實(shí)現(xiàn)這個(gè)功能非常地容易，只需要在上例的代碼基礎(chǔ)上修改一行代碼就可以了，在XmlTextWriter的類構(gòu)造器中，我們不指定為一個(gè)文件路徑，而是指定為Response.OutputStream，以使ASP.NET程序直接輸出XML流到瀏覽器中，而不是保存為一個(gè)文件，當(dāng)然了，你還可以設(shè)定＜@ Page ... ＞指令中的MIME類型為text/xml來(lái)實(shí)現(xiàn)同樣的功能，但是我建議你不要用這種方法來(lái)實(shí)現(xiàn)，因?yàn)橛行g覽器不認(rèn)得該格式而把它當(dāng)做html來(lái)解釋（它將蘊(yùn)藏所有的xml元素，并刪除所有的空格）。

下面列出了上例修改后的部分代碼，修改過(guò)的代碼將一些粗體顯示：

＜@ 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!  
...  
}

注意，盡管你訪問(wèn)的是asp.net Web頁(yè)面，但是你查看該實(shí)例所看到的僅僅是XML文檔，這個(gè)文檔跟先前創(chuàng)建的XML文件是一樣的，所不同的是，先前是保存為一個(gè)XML文件userInfo.xml。

總結(jié)

XmlTextWriter對(duì)象可以創(chuàng)建一個(gè)XML文件，并把它保存到指定位置，也可以直接以指定的流形式顯示在瀏覽器上，在很多編碼工作中，使用XmlTextWriter對(duì)象構(gòu)建基于XML的程序會(huì)有很多的優(yōu)勢(shì)，其中主要有可以使代碼更加簡(jiǎn)潔，更具可讀性，方面C#創(chuàng)建XML文件，同時(shí)又不用擔(dān)心輸出的XML文件是否符合規(guī)范。

【編輯推薦】