詳解c#讀取XML的實(shí)例代碼

2020-01-24 00:53:02

字體：大中小

供稿：網(wǎng)友

XML文件是一種常用的文件格式，例如WinForm里面的app.config以及Web程序中的web.config文件，還有許多重要的場(chǎng)所都有它的身影。Xml是Internet環(huán)境中跨平臺(tái)的，依賴(lài)于內(nèi)容的技術(shù)，是當(dāng)前處理結(jié)構(gòu)化文檔信息的有力工具。XML是一種簡(jiǎn)單的數(shù)據(jù)存儲(chǔ)語(yǔ)言，使用一系列簡(jiǎn)單的標(biāo)記描述數(shù)據(jù)，而這些標(biāo)記可以用方便的方式建立，雖然XML占用的空間比二進(jìn)制數(shù)據(jù)要占用更多的空間，但XML極其簡(jiǎn)單易于掌握和使用。微軟也提供了一系列類(lèi)庫(kù)來(lái)倒幫助我們?cè)趹?yīng)用程序中存儲(chǔ)XML文件。

“在程序中訪問(wèn)進(jìn)而操作XML文件一般有兩種模型，分別是使用DOM（文檔對(duì)象模型）和流模型，使用DOM的好處在于它允許編輯和更新XML文檔，可以隨機(jī)訪問(wèn)文檔中的數(shù)據(jù)，可以使用XPath查詢(xún)，但是，DOM的缺點(diǎn)在于它需要一次性的加載整個(gè)文檔到內(nèi)存中，對(duì)于大型的文檔，這會(huì)造成資源問(wèn)題。流模型很好的解決了這個(gè)問(wèn)題，因?yàn)樗鼘?duì)XML文件的訪問(wèn)采用的是流的概念，也就是說(shuō)，任何時(shí)候在內(nèi)存中只有當(dāng)前節(jié)點(diǎn)，但它也有它的不足，它是只讀的，僅向前的，不能在文檔中執(zhí)行向后導(dǎo)航操作。”

下面我將介紹三種常用的讀取XML文件的方法。分別是

1: 使用 XmlDocument

2: 使用 XmlTextReader

3: 使用 Linq to Xml

這里我先創(chuàng)建一個(gè)XML文件,名為Book.xml下面所有的方法都是基于這個(gè)XML文件的,文件內(nèi)容如下:

 <?xml version="1.0" encoding="utf-8"?>   <bookstore>    <!--記錄書(shū)本的信息-->    <book Type="必修課" ISBN="7-111-19149-2">     <title>數(shù)據(jù)結(jié)構(gòu)</title>     <author>嚴(yán)蔚敏</author>     <price>30.00</price>    </book>    <book Type="必修課" ISBN="7-111-19149-3">    <title>路由型與交換型互聯(lián)網(wǎng)基礎(chǔ)</title>    <author>程慶梅</author>    <price>27.00</price>   </book>   <book Type="必修課" ISBN="7-111-19149-4">    <title>計(jì)算機(jī)硬件技術(shù)基礎(chǔ)</title>    <author>李繼燦</author>    <price>25.00</price>   </book>   <book Type="必修課" ISBN="7-111-19149-5">    <title>軟件質(zhì)量保證與管理</title>    <author>朱少民</author>    <price>39.00</price>   </book>   <book Type="必修課" ISBN="7-111-19149-6">    <title>算法設(shè)計(jì)與分析</title>    <author>王紅梅</author>    <price>23.00</price>   </book>   <book Type="選修課" ISBN="7-111-19149-1">    <title>計(jì)算機(jī)操作系統(tǒng)</title>    <author>7-111-19149-1</author>    <price>28</price>   </book>  </bookstore>

為了方便讀取,我還定義一個(gè)書(shū)的實(shí)體類(lèi),名為BookModel,具體內(nèi)容如下:

 using System;   using System.Collections.Generic;   using System.Linq;   using System.Text;      namespace 使用XmlDocument   {     public class BookModel     {      public BookModel()      { }      /// <summary>      /// 所對(duì)應(yīng)的課程類(lèi)型      /// </summary>      private string bookType;         public string BookType      {        get { return bookType; }        set { bookType = value; }      }         /// <summary>      /// 書(shū)所對(duì)應(yīng)的ISBN號(hào)      /// </summary>      private string bookISBN;         public string BookISBN      {        get { return bookISBN; }        set { bookISBN = value; }      }         /// <summary>      /// 書(shū)名      /// </summary>      private string bookName;         public string BookName      {        get { return bookName; }        set { bookName = value; }      }         /// <summary>      /// 作者      /// </summary>      private string bookAuthor;         public string BookAuthor      {        get { return bookAuthor; }        set { bookAuthor = value; }      }         /// <summary>      /// 價(jià)格      /// </summary>      private double bookPrice;         public double BookPrice      {        get { return bookPrice; }        set { bookPrice = value; }      }    }  }

1.使用XmlDocument.

使用XmlDocument是一種基于文檔結(jié)構(gòu)模型的方式來(lái)讀取XML文件.在XML文件中,我們可以把XML看作是由文檔聲明(Declare),元素(Element),屬性(Attribute),文本(Text)等構(gòu)成的一個(gè)樹(shù).最開(kāi)始的一個(gè)結(jié)點(diǎn)叫作根結(jié)點(diǎn),每個(gè)結(jié)點(diǎn)都可以有自己的子結(jié)點(diǎn).得到一個(gè)結(jié)點(diǎn)后,可以通過(guò)一系列屬性或方法得到這個(gè)結(jié)點(diǎn)的值或其它的一些屬性.例如:

  xn 代表一個(gè)結(jié)點(diǎn)   xn.Name;//這個(gè)結(jié)點(diǎn)的名稱(chēng)   xn.Value;//這個(gè)結(jié)點(diǎn)的值   xn.ChildNodes;//這個(gè)結(jié)點(diǎn)的所有子結(jié)點(diǎn)   xn.ParentNode;//這個(gè)結(jié)點(diǎn)的父結(jié)點(diǎn)   .......

1.1 讀取所有的數(shù)據(jù).

使用的時(shí)候,首先聲明一個(gè)XmlDocument對(duì)象,然后調(diào)用Load方法,從指定的路徑加載XML文件.

XmlDocument doc = new XmlDocument();doc.Load(@"../../Book.xml");

然后可以通過(guò)調(diào)用SelectSingleNode得到指定的結(jié)點(diǎn),通過(guò)GetAttribute得到具體的屬性值.參看下面的代碼

  // 得到根節(jié)點(diǎn)bookstore   XmlNode xn = xmlDoc.SelectSingleNode("bookstore");         // 得到根節(jié)點(diǎn)的所有子節(jié)點(diǎn)   XmlNodeList xnl = xn.ChildNodes;      foreach (XmlNode xn1 in xnl)   {    BookModel bookModel = new BookModel();    // 將節(jié)點(diǎn)轉(zhuǎn)換為元素，便于得到節(jié)點(diǎn)的屬性值    XmlElement xe = (XmlElement)xn1;    // 得到Type和ISBN兩個(gè)屬性的屬性值    bookModel.BookISBN = xe.GetAttribute("ISBN").ToString();    bookModel.BookType = xe.GetAttribute("Type").ToString();    // 得到Book節(jié)點(diǎn)的所有子節(jié)點(diǎn)    XmlNodeList xnl0 = xe.ChildNodes;    bookModel.BookName=xnl0.Item(0).InnerText;    bookModel.BookAuthor=xnl0.Item(1).InnerText;    bookModel.BookPrice=Convert.ToDouble(xnl0.Item(2).InnerText);    bookModeList.Add(bookModel);  }  dgvBookInfo.DataSource = bookModeList;

在正常情況下,上面的代碼好像沒(méi)有什么問(wèn)題,但是對(duì)于讀取上面的XML文件,則會(huì)出錯(cuò),原因就是因?yàn)槲疑厦娴腦ML文件里面有注釋,大家可以參看Book.xml文件中的第三行,我隨便加的一句注釋.注釋也是一種結(jié)點(diǎn)類(lèi)型,在沒(méi)有特別說(shuō)明的情況下,會(huì)默認(rèn)它也是一個(gè)結(jié)點(diǎn)(Node).所以在把結(jié)點(diǎn)轉(zhuǎn)換成元素的時(shí)候就會(huì)報(bào)錯(cuò)."無(wú)法將類(lèi)型為“System.Xml.XmlComment”的對(duì)象強(qiáng)制轉(zhuǎn)換為類(lèi)型“System.Xml.XmlElement”。"

幸虧它里面自帶了解決辦法,那就是在讀取的時(shí)候,告訴編譯器讓它忽略掉里面的注釋信息.修改如下:

XmlDocument xmlDoc = new XmlDocument();XmlReaderSettings settings = new XmlReaderSettings();settings.IgnoreComments = true;//忽略文檔里面的注釋XmlReader reader = XmlReader.Create(@"../../Book.xml", settings);xmlDoc.Load(reader);

最后讀取完畢后,記得要關(guān)掉reader.

 reader.Close();

這樣它就不會(huì)出現(xiàn)錯(cuò)誤.

最后運(yùn)行結(jié)果如下:

1.2 增加一本書(shū)的信息.

向文件中添加新的數(shù)據(jù)的時(shí)候,首先也是通過(guò)XmlDocument加載整個(gè)文檔,然后通過(guò)調(diào)用SelectSingleNode方法獲得根結(jié)點(diǎn),通過(guò)CreateElement方法創(chuàng)建元素,用CreateAttribute創(chuàng)建屬性,用AppendChild把當(dāng)前結(jié)點(diǎn)掛接在其它結(jié)點(diǎn)上,用SetAttributeNode設(shè)置結(jié)點(diǎn)的屬性.具體代碼如下:

加載文件并選出要結(jié)點(diǎn):

XmlDocument doc = new XmlDocument();doc.Load(@"../../Book.xml");XmlNode root = doc.SelectSingleNode("bookstore");

創(chuàng)建一個(gè)結(jié)點(diǎn),并設(shè)置結(jié)點(diǎn)的屬性:

  XmlElement xelKey = doc.CreateElement("book");   XmlAttribute xelType = doc.CreateAttribute("Type");   xelType.InnerText = "adfdsf";   xelKey.SetAttributeNode(xelType);

創(chuàng)建子結(jié)點(diǎn):

  XmlElement xelAuthor = doc.CreateElement("author");   xelAuthor.InnerText = "dfdsa";   xelKey.AppendChild(xelAuthor);

最后把book結(jié)點(diǎn)掛接在要結(jié)點(diǎn)上,并保存整個(gè)文件:

root.AppendChild(xelKey);doc.Save(@"../../Book.xml");

用上面的方法,是向已有的文件上追加數(shù)據(jù),如果想覆蓋原有的所有數(shù)據(jù),可以更改一下,使用LoadXml方法:

  XmlDocument doc = new XmlDocument();   doc.LoadXml("<bookstore></bookstore>");//用這句話,會(huì)把以前的數(shù)據(jù)全部覆蓋掉,只有你增加的數(shù)據(jù)

直接把根結(jié)點(diǎn)選擇出來(lái)了,后面不用SelectSingleNode方法選擇根結(jié)點(diǎn),直接創(chuàng)建結(jié)點(diǎn)即可,代碼同上.

1.3 刪除某一個(gè)數(shù)據(jù)

想要?jiǎng)h除某一個(gè)結(jié)點(diǎn),直接找到其父結(jié)點(diǎn),然后調(diào)用RemoveChild方法即可,現(xiàn)在關(guān)鍵的問(wèn)題是如何找到這個(gè)結(jié)點(diǎn),上面的SelectSingleNode可以傳入一個(gè)Xpath表,我們通過(guò)書(shū)的ISBN號(hào)來(lái)找到這本書(shū)所在的結(jié)點(diǎn).如下:

 XmlElement xe = xmlDoc.DocumentElement; // DocumentElement 獲取xml文檔對(duì)象的根XmlElement.   string strPath = string.Format("/bookstore/book[@ISBN=/"{0}/"]", dgvBookInfo.CurrentRow.Cells[1].Value.ToString());   XmlElement selectXe = (XmlElement)xe.SelectSingleNode(strPath); //selectSingleNode 根據(jù)XPath表達(dá)式,獲得符合條件的第一個(gè)節(jié)點(diǎn).   selectXe.ParentNode.RemoveChild(selectXe);

"/bookstore/book[@ISBN=/"{0}/"]"是一個(gè)Xpath表達(dá)式,找到ISBN號(hào)為所選那一行ISBN號(hào)的那本書(shū),有關(guān)Xpath的知識(shí)請(qǐng)參考:XPath 語(yǔ)法

1.4 修改某要條數(shù)據(jù)

修改某條數(shù)據(jù)的話,首先也是用Xpath表達(dá)式找到所需要修改的那一個(gè)結(jié)點(diǎn),然后如果是元素的話,就直接對(duì)這個(gè)元素賦值,如果是屬性的話,就用SetAttribute方法設(shè)置即可.如下:

  XmlElement xe = xmlDoc.DocumentElement; // DocumentElement 獲取xml文檔對(duì)象的根XmlElement.   string strPath = string.Format("/bookstore/book[@ISBN=/"{0}/"]", dgvBookInfo.CurrentRow.Cells[1].Value.ToString());   XmlElement selectXe = (XmlElement)xe.SelectSingleNode(strPath); //selectSingleNode 根據(jù)XPath表達(dá)式,獲得符合條件的第一個(gè)節(jié)點(diǎn).   selectXe.SetAttribute("Type", dgvBookInfo.CurrentRow.Cells[0].Value.ToString());//也可以通過(guò)SetAttribute來(lái)增加一個(gè)屬性   selectXe.GetElementsByTagName("title").Item(0).InnerText = dgvBookInfo.CurrentRow.Cells[2].Value.ToString();   selectXe.GetElementsByTagName("author").Item(0).InnerText = dgvBookInfo.CurrentRow.Cells[3].Value.ToString();   selectXe.GetElementsByTagName("price").Item(0).InnerText = dgvBookInfo.CurrentRow.Cells[4].Value.ToString();   xmlDoc.Save(@"../../Book.xml");

2.使用XmlTextReader和XmlTextWriter

XmlTextReader和XmlTextWriter是以流的形式來(lái)讀寫(xiě)XML文件.

2.1XmlTextReader

使用XmlTextReader讀取數(shù)據(jù)的時(shí)候,首先創(chuàng)建一個(gè)流,然后用read()方法來(lái)不斷的向下讀,根據(jù)讀取的結(jié)點(diǎn)的類(lèi)型來(lái)進(jìn)行相應(yīng)的操作.如下:

 XmlTextReader reader = new XmlTextReader(@"../../Book.xml");        List<BookModel> modelList = new List<BookModel>();        BookModel model = new BookModel();        while (reader.Read())        {                    if (reader.NodeType == XmlNodeType.Element)          {            if (reader.Name == "book")            {              model.BookType = reader.GetAttribute(0);              model.BookISBN = reader.GetAttribute(1);            }            if (reader.Name == "title")            {              model.BookName=reader.ReadElementString().Trim();            }            if (reader.Name == "author")            {              model.BookAuthor = reader.ReadElementString().Trim();            }            if (reader.Name == "price")            {              model.BookPrice = Convert.ToDouble(reader.ReadElementString().Trim());            }          }             if (reader.NodeType == XmlNodeType.EndElement)          {            modelList.Add(model);            model = new BookModel();          }                     }        modelList.RemoveAt(modelList.Count-1);        this.dgvBookInfo.DataSource = modelList;

關(guān)鍵是讀取屬性的時(shí)候,你要先知道哪一個(gè)結(jié)點(diǎn)具有幾個(gè)屬性,然后通過(guò)GetAttribute方法來(lái)讀取.讀取屬性還可以用另外一種方法,就是用MoveToAttribute方法.可參見(jiàn)下面的代碼:

  if (reader.Name == "book")     {       for (int i = 0; i < reader.AttributeCount; i++)       {         reader.MoveToAttribute(i);         string str = "屬性：" + reader.Name + "=" + reader.Value;       }       model.BookType = reader.GetAttribute(0);       model.BookISBN = reader.GetAttribute(1);    }

效果如下:

2.2XmlTextWriter

XmlTextWriter寫(xiě)文件的時(shí)候,默認(rèn)是覆蓋以前的文件,如果此文件名不存在,它將創(chuàng)建此文件.首先設(shè)置一下,你要?jiǎng)?chuàng)建的XML文件格式,

 XmlTextWriter myXmlTextWriter = new XmlTextWriter(@"../../Book1.xml", null);   //使用 Formatting 屬性指定希望將 XML 設(shè)定為何種格式。 這樣，子元素就可以通過(guò)使用 Indentation 和 IndentChar 屬性來(lái)縮進(jìn)。   myXmlTextWriter.Formatting = Formatting.Indented;

然后可以通過(guò)WriteStartElement和WriteElementString方法來(lái)創(chuàng)建元素,這兩者的區(qū)別就是如果有子結(jié)點(diǎn)的元素,那么創(chuàng)建的時(shí)候就用WriteStartElement,然后去創(chuàng)建子元素,創(chuàng)建完畢后,要調(diào)用相應(yīng)的WriteEndElement來(lái)告訴編譯器,創(chuàng)建完畢,用WriteElementString來(lái)創(chuàng)建單個(gè)的元素,用WriteAttributeString來(lái)創(chuàng)建屬性.如下:

  XmlTextWriter myXmlTextWriter = new XmlTextWriter(@"../../Book1.xml", null);        //使用 Formatting 屬性指定希望將 XML 設(shè)定為何種格式。 這樣，子元素就可以通過(guò)使用 Indentation 和 IndentChar 屬性來(lái)縮進(jìn)。        myXmlTextWriter.Formatting = Formatting.Indented;           myXmlTextWriter.WriteStartDocument(false);        myXmlTextWriter.WriteStartElement("bookstore");           myXmlTextWriter.WriteComment("記錄書(shū)本的信息");        myXmlTextWriter.WriteStartElement("book");           myXmlTextWriter.WriteAttributeString("Type", "選修課");        myXmlTextWriter.WriteAttributeString("ISBN", "111111111");           myXmlTextWriter.WriteElementString("author","張三");        myXmlTextWriter.WriteElementString("title", "職業(yè)生涯規(guī)劃");        myXmlTextWriter.WriteElementString("price", "16.00");           myXmlTextWriter.WriteEndElement();        myXmlTextWriter.WriteEndElement();           myXmlTextWriter.Flush();        myXmlTextWriter.Close();

3.使用Linq to XML.

Linq是C#3.0中出現(xiàn)的一個(gè)新特性,使用它可以方便的操作許多數(shù)據(jù)源,也包括XML文件.使用Linq操作XML文件非常的方便,而且也比較簡(jiǎn)單.下面直接看代碼,

先定義一個(gè)方法顯示查詢(xún)出來(lái)的數(shù)據(jù)

  private void showInfoByElements(IEnumerable<XElement> elements)      {        List<BookModel> modelList = new List<BookModel>();        foreach (var ele in elements)        {          BookModel model = new BookModel();          model.BookAuthor = ele.Element("author").Value;          model.BookName = ele.Element("title").Value;          model.BookPrice = Convert.ToDouble(ele.Element("price").Value);          model.BookISBN=ele.Attribute("ISBN").Value;          model.BookType=ele.Attribute("Type").Value;                    modelList.Add(model);        }        dgvBookInfo.DataSource = modelList;      }

3.1讀取所有的數(shù)據(jù)

直接找到元素為book的這個(gè)結(jié)點(diǎn),然后遍歷讀取所有的結(jié)果.

  private void btnReadAll_Click(object sender, EventArgs e)      {        XElement xe = XElement.Load(@"../../Book.xml");        IEnumerable<XElement> elements = from ele in xe.Elements("book")                         select ele;        showInfoByElements(elements);      }

3.2插入一條數(shù)據(jù)

插入結(jié)點(diǎn)和屬性都采用new的方法,如下:

  private void btnInsert_Click(object sender, EventArgs e)       {         XElement xe = XElement.Load(@"../../Book.xml");         XElement record = new XElement(         new XElement("book",         new XAttribute("Type", "選修課"),         new XAttribute("ISBN","7-111-19149-1"),         new XElement("title", "計(jì)算機(jī)操作系統(tǒng)"),         new XElement("author", "7-111-19149-1"),        new XElement("price", 28.00)));        xe.Add(record);        xe.Save(@"../../Book.xml");        MessageBox.Show("插入成功！");        btnReadAll_Click(sender, e);      }

3.3 刪除選中的數(shù)據(jù)

首先得到選中的那一行,通過(guò)ISBN號(hào)來(lái)找到這個(gè)元素，然后用Remove方法直接刪除，如下：

  private void btnDelete_Click(object sender, EventArgs e)      {        if (dgvBookInfo.CurrentRow != null)        {          //dgvBookInfo.CurrentRow.Cells[1]對(duì)應(yīng)著ISBN號(hào)          string id = dgvBookInfo.CurrentRow.Cells[1].Value.ToString();          XElement xe = XElement.Load(@"../../Book.xml");          IEnumerable<XElement> elements = from ele in xe.Elements("book")                           where (string)ele.Attribute("ISBN") == id                          select ele;         {          if (elements.Count() > 0)            elements.First().Remove();          }          xe.Save(@"../../Book.xml");          MessageBox.Show("刪除成功！");          btnReadAll_Click(sender, e);           }      }

3.4 刪除所有的數(shù)據(jù)

與上面的類(lèi)似，選出所有的數(shù)據(jù)，然后用Remove方法，如下：

  private void btnDeleteAll_Click(object sender, EventArgs e)      {        XElement xe = XElement.Load(@"../../Book.xml");        IEnumerable<XElement> elements = from ele in xe.Elements("book")                         select ele;        if (elements.Count() > 0)        {          elements.Remove();        }        xe.Save(@"../../Book.xml");        MessageBox.Show("刪除成功！");        btnReadAll_Click(sender, e);      }

3.5 修改某一記錄

首先得到所要修改的某一個(gè)結(jié)點(diǎn)，然后用SetAttributeValue來(lái)修改屬性，用ReplaceNodes來(lái)修改結(jié)點(diǎn)元素。如下：

  private void btnSave_Click(object sender, EventArgs e)   {     XElement xe = XElement.Load(@"../../Book.xml");     if (dgvBookInfo.CurrentRow != null)     {       //dgvBookInfo.CurrentRow.Cells[1]對(duì)應(yīng)著ISBN號(hào)       string id = dgvBookInfo.CurrentRow.Cells[1].Value.ToString();       IEnumerable<XElement> element = from ele in xe.Elements("book")                       where ele.Attribute("ISBN").Value == id                      select ele;      if (element.Count() > 0)      {        XElement first = element.First();        ///設(shè)置新的屬性        first.SetAttributeValue("Type", dgvBookInfo.CurrentRow.Cells[0].Value.ToString());        ///替換新的節(jié)點(diǎn)        first.ReplaceNodes(             new XElement("title", dgvBookInfo.CurrentRow.Cells[2].Value.ToString()),              new XElement("author", dgvBookInfo.CurrentRow.Cells[3].Value.ToString()),             new XElement("price", (double)dgvBookInfo.CurrentRow.Cells[4].Value)              );      }      xe.Save(@"../../Book.xml");         MessageBox.Show("修改成功！");      btnReadAll_Click(sender, e);    }  }

最終效果如下：