轉自:http://erikfeng.cnblogs.com/archive/2005/12/26/304537.aspx
引言
隨著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檔案是否符合規範。