C#来创建和读取XML文档

时间:2021-11-22 05:44:32
 摘自互联网

       扩展标记语言XML(eXtensible Markup Language),是由W3C组织制定的。做为用于替代HTML语言的一种新型的标记语言,XML内部有着很多基本标准,XML就是通过与这些相关标准地结合,应用于科学计算、电子出版、多媒*作和电子商务的。C#作为一种新型的程序语言,是.Net框架的一个重要组成部分,他和XML的关系颇深。本文就从一个方面来探讨一下这二者的关系。即:看用C#如何来创建和读取XML文档。

C#创建XML文档

       在本文中我们来介绍一下用C#创建XML文档的二种方法,这二种方法各有千

秋,第一种创建起来更灵活,第二种创建起来更方便。

(一)C#创建XML文档的第一种方法

这一种方法是按照按照XML的结构一步一步的构建XML文档。C#构建XML文档通过.Net FrameWork SDK中的命名空间“System.Xml”中封装的各种类来实现的。下面就按照一个XML典型文档结构来介绍一下。

(1)首先要创建一个空的XML文档

在命名空间“System.Xml”中有一个类“XmlDocument”,C#通过这个类来描述XML文档。下面是用C#创建一个XML文档。  

System.Xml.XmlDocument xmldoc = new System.Xml.XmlDocument();

(2)在XML的文档的最头部加入XML的声明段落

利用“XmlDocument”类中的“CreateNode”方法可以创建一个指定类型的XML节点,“CreateNode”方法的调用方法总共有三种,在本文中使用的是其一般的方法,具体语法如下:

XmlDocument.CreateNode Method ( XmlNodeType , String , String )

然后在利用“XmlDocument”类中的“AppendChild”方法在XML文档中加入此节点,用C#在XML文档中加入声明段落实现的语句如下:

System.Xml.XmlElement xmlelem = xmldoc.CreateElement("", "root", "");
System.Xml.XmlText xmlelemtext = xmldoc.CreateTextNode("aaaa");

注释:其中“xmlelem”是创建的“XmlElement”对象,“xmltext”是“XmlText”对象有了创建一个XML元素的例子,就可以根据XML文档中数据的不同的结构来创建其他的数据了。

(二)C#创建XML文档的第一种方法的源程序代码

        System.Xml.XmlDocument xmldoc = new System.Xml.XmlDocument();//
        System.Xml.XmlNode xmlnode = xmldoc.CreateNode(System.Xml.XmlNodeType.XmlDeclaration, "a", "b");
        xmldoc.AppendChild(xmlnode);
        System.Xml.XmlElement xmlelem = xmldoc.CreateElement("", "root", "");
        System.Xml.XmlText xmlelemtext = xmldoc.CreateTextNode("aaaa");
        xmlelem.AppendChild(xmlelemtext);
        xmldoc.AppendChild(xmlelem);
        xmldoc.Save(Server.MapPath("js/cc.xml"));

 

C#创建XML文档的第二种方法

在介绍完第一种方法以后,我想每一个读者都感觉到用C#创建XML文档是一项比较烦杂的工作了,因为不仅要了解创建的知识,还要了解文档的结构,这样创建的过程就是一步一步的了。下面就来介绍一种比较容易的创建方法,这种创建方法是直接定义XML文档,然后把他保存到文件中就可以了。

(1)创建一个XML文档

这一点和第一种方法一样,在这里就不介绍了。

(2)通过“XmlDocument”类中的“LoadXml”方法,直接在文档中加入想要加入的XML数据。当然你加入的XML应该符合XML的语法,不然产生的文件也没有什么意义了。下面是加入XML的具体代码:

        System.Xml.XmlDocument xmldoc = new System.Xml.XmlDocument();
        xmldoc.AppendChild(xmlnode);
        xmldoc.LoadXml("<Employees> " + "<NO1>" + "<Name>Ma Jin Hu</Name>" + "<ZIP> 239000 </ZIP>" + "<Address>Feng Huang Street</Address>" + "<City>Chu Zhou City</City>" + "<State> ANHUI </State>" + "</NO1>" + "<NO2>" + "<Name>Wang Tian</Name>" + "<ZIP> 239000 </ZIP>" + "<Address>Lang Ya Street</Address>" + "<City>He Fei City</City>" + "<State> ANHUI </State>" + "</NO2>" + "<NO3>" + "<Name>Zou Wen Biao</Name>" + "<ZIP> 100000 </ZIP>" + "<Address>Sai Di Street</Address>" + "<City>Bei Jin City</City>" + "<State>Bei Jin</State>" + "</NO3>" + "</Employees>");
        xmldoc.Save(Server.MapPath("js/dd.xml"));

用C#创建XML文档的方法其实有很多,在这里只是选取了二种比较典型的方法加以介绍。但无论那一种方法,C#在创建XML的时候都需要用到.Net FrameWork SDK。所以了解并掌握这个类库中的内容对于C#编程是十分必要的,在下面我们将来介绍一下用C#读取XML中的数据,通过这你会发现,C#又是利用这个类库实现这个功能的。

 

C#读取XML文件

本节将用C#来读取本文中用第二种方法创建的XML文件,编译NO2.cs后,执行将产生“data.xml”文件,其中“data.xml”文件的数据结构如下: <Employees>
<NO1>
<Name>Ma Jin Hu</Name>
<ZIP> 239000 </ZIP>
<Address>Feng Huang Street</Address>
<City>Chu Zhou City</City>
<State> ANHUI </State>
</NO1>
<NO2>
<Name>Wang Tian</Name>
<ZIP> 239000 </ZIP>
<Address>Lang Ya Street</Address>
<City>He Fei City</City>
<State> ANHUI </State>
</NO2>
<NO3>
<Name>Zou Wen Biao</Name>
<ZIP> 100000 </ZIP>
<Address>Sai Di Street</Address>
<City>Bei Jin City</City>
<State>Bei Jin</State>
</NO3>
</Employees> 

在下面的内容中,我们利用C#读取此文件,并用ListView组件按照数据结构给显示出来。

要正确读取XML数据,首先要了解XML的结构。根据上面的XML文件,可以知道此XML包含三个数据,下面就来看如何读取这三条数据:

(1)装入XML文件,形成数据流

通过创建一个“XmlDocument”对象,然后利用“load”方法,可以把XML文件装入,具体如下:

       System.Xml.XmlDocument xmldoc = new System.Xml.XmlDocument();
        xmldoc.Load(Server.MapPath("js/cc.xml"));

读取XML是通过创建“XmlNodeReader”对象来实现的,“XmlNodeReader”对象主要是用来可以读取XML的节点数据。在本文的程序中使用到了一些“XmlNodeReader”的属性,譬如“NodeType”属性,用来判断读取得节点是什么类型。“Value”是节点的值。下面是读取XML文件并显示在ListView中的实现代码,其中listview1是已经创建ListView组件:

 System.Xml.XmlDocument xmldoc = new System.Xml.XmlDocument();
        xmldoc.Load(Server.MapPath("js/dd.xml"));
        System.Xml.XmlNodeReader xmlnoderd=new System.Xml.XmlNodeReader(xmldoc);
        string s = "";
        while (xmlnoderd.Read())
        {
            switch (xmlnoderd.NodeType)
            {
                case System.Xml.XmlNodeType.Element:
                    s = System.Xml.XmlNodeType.Text.ToString(); break;
                case System.Xml.XmlNodeType.Text:
                    if (s.Equals("Name"))
                    {
                        TreeNode node = new TreeNode(xmlnoderd.Value, xmlnoderd.Value);
                        TreeView1.Nodes.Add(node);
                    }
                    else
                    {
                        TreeNode node = new TreeNode(xmlnoderd.Value, xmlnoderd.Value);
                        TreeView1.Nodes.Add(node);
                    }
                    break;
            }
        }

C#和XML的渊源是很深的,本文只是从一个侧面反映了二者关系的密切程度。在.Net FrameWork SDK中存在许多可以直接操作XML的类库,掌握这些类库的使用方法,对用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.UnicodeSystem.Text.Encoding.UTF8,在XmlTextWriter类构造器指定为何种类型,在输出XML文件将以那种流文件形式输出。

  使用XmlTextWriter对象创建一个简单的XML文件

  接下来,我们示范一下如何使用XmlTextWriter对象来创建一个简单的XML文档,并把它保存到指定的位置,这个XML文件将包含访问该文件的用户的相关信息,它的输出格式如下:

  


userInfo
browserInfo
urlReferrerURL referrer info/urlReferrer
userAgentUser agent referrer info/userAgent
userLanguageslanguages info/userLanguages
/browserInfo
visitInfo timeVisited="date/time the page was visited"
ipvisitor's IP address/ip
rawUrlraw 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文件和它的编码类型为UTF8a 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文件是否符合规范