C#創建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文件是否符合規范


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM