DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> XML學習教程 >> XML詳解
用 .NET 的 XmlTextWriter 類別打造 XML 檔案
編輯:XML詳解     

隨著 XML 普及並大量應用於動態 Web 開發,如何在 .NET 環境中建立、刪除與修改 XML 檔案變得越來越重要。從某個角度看,XML 檔案與大型純文字檔並無本質差異,而且它出現得比 .NET 更早。過去許多 ASP 開發者在需要輸出 XML 時,往往直接動用 Response.Write() 拼字串。

但這種做法並不理想。首先,你會時時擔心輸出的字元是否符合 XML 規範,像 <、>、&、雙引號與單引號這些符號一旦出現,就必須手動查找處理,否則文件無法正確完整顯示。其次,當你要輸出一份包含大量命名空間、屬性與元素的 XML 時,用 Response.Write() 寫出來的程式碼既冗長又難讀。

幸好,.NET Framework 提供了專為建立 XML 而生的類別——System.Xml.XmlTextWriter。用它來產生 XML,你不必再操心格式是否合規,程式碼也會變得清爽許多。

XmlTextWriter 常用方法

  • WriteStartDocument():建立 XML 的第一行程式,用來宣告文件類型與編碼。
  • WriteStartElement(string):建立新元素,透過參數指定名稱。
  • WriteElementString(name, text_value):建立只含文字、不嵌套其他元素的簡單元素。
  • WriteEndElement():對應 WriteStartElement,作為元素結尾。
  • WriteEndDocument():文件建立完成後呼叫以收尾。
  • Close():關閉所有資料流,把 XML 輸出到指定位置。

使用 XmlTextWriter 時,需在建構子中指定編碼型別,必須是 System.Text.Encoding,例如 ASCII、Unicode 或 UTF8;指定哪一種,輸出的 XML 就會以那種編碼形式呈現。

建立一個簡單的 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>

對應的 ASP.NET (C#) 程式碼如下:

<%@ Import Namespace="System.Xml" %>
<%@ Import Namespace="System.Text" %>
<script language="C#" runat="server">
void Page_Load(object sender, EventArgs e)
{
    // 建立 XmlTextWriter 實例,指定輸出路徑與 UTF8 編碼
    XmlTextWriter writer =
        new XmlTextWriter(Server.MapPath("userInfo.XML"), Encoding.UTF8);

    writer.WriteStartDocument();
    writer.WriteStartElement("userInfo");

    // 建立 browserInfo 元素
    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();

    // 建立 visitInfo 元素
    writer.WriteStartElement("visitInfo");
    writer.WriteAttributeString("timeVisited", DateTime.Now.ToString());
    writer.WriteElementString("ip", Request.UserHostAddress);
    writer.WriteElementString("rawUrl", Request.RawUrl);
    writer.WriteEndElement();

    writer.WriteEndElement();   // 結束 userInfo
    writer.WriteEndDocument();
    writer.Close();
}
</script>

執行前先確認已匯入 System.Xml 與 System.Text 命名空間。程式先建立 XmlTextWriter 實例並指定輸出路徑與 UTF8 編碼,接著用 WriteStartElement 建立可嵌套其他元素的父元素、以 WriteEndElement 收尾,並用 WriteElementString 建立最底層的簡單元素。

直接在瀏覽器輸出 XML

有時我們希望把 XML 直接顯示在瀏覽器而非存檔。做法很簡單:只要把建構子中的檔案路徑換成 Response.OutputStream,讓程式把 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)
{
    XmlTextWriter writer =
        new XmlTextWriter(Response.OutputStream, Encoding.UTF8);
    // start writing!
    ...
}
</script>

雖然你訪問的是 ASP.NET 網頁,畫面上看到的卻是純 XML 文件。之所以不建議只靠設定 MIME 型別為 text/XML,是因為有些瀏覽器並不認得該格式,會把它當成 HTML 解釋,導致 XML 元素被隱藏、空白被刪除。

總結

本文示範了如何在 .NET Framework 中用 System.Xml.XmlTextWriter 建立 XML 檔案:既可存檔到指定位置,也能以指定串流直接輸出到瀏覽器。相較於手動拼字串,它能讓程式碼更簡潔、更具可讀性,也不必再擔心輸出內容是否符合 XML 規範。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved