一.前言:
xml是微软.net战略的一个重要组成部分,而且它可谓是xml web服务的基石,所以掌握.net框架下的xml技术自然显得非常重要了。本文将指导大家如何运用c#语言完成.net框架下的xml文档的读写操作。首先,我会向大家介绍.net框架中与xml相关的命名空间和其中的重要类。其次,我还会给出有关的实例以使读者更进一步的了解xml文档的读写操作的具体方法。
二.xml命名空间和相关类简介:
在深入进行.net框架下的xml文档的操作之前,我想很有必要向大家介绍.net框架中与xml技术有关的命名空间和其中一些重要的类。.net框架为我们提供了以下一些命名空间:system.xml、system.xml.schema、system.xml.serialization、system.xml.xpath以及 system.xml.xsl来包容和xml操作相关的类。
system.xml命名空间包含了一些最重要的xml类,其中最主要的类是和xml文档的读写操作相关的类。这些类中包括4个与读相关的类以及2个与写相关的类。它们分别是:xmlreader、xmltextreader、xmlvalidatingreader、xmlnodereader、xmlwriter以及 xmltextwriter。本文将重点介绍这些类,因为它们是最基本也是最重要的类。
xmlreader类是一个虚基类,它包含了读xml文档的方法和属性。该类中的read方法是一个基本的读xml文档的方法,它以流形式读取xml文档中的节点(node)。另外,该类还提供了readstring、readinnerxml、readouterxml和readstartelement等更高级的读方法。除了提供读xml文档的方法外,xmlreader类还为程序员提供了movetoattribute、movetofirstattribute、movetocontent、movetofirstcontent、movetoelement以及 movetonextattribute等具有导航功能的方法。在本文后面介绍的实例中,我们将运用到这些方法。
xmltextreader、xmlnodereader以及xmlvalidatingreader等类是从xmlreader类继承过来的子类。根据它们的名称,我们可以知道其作用分别是读取文本内容、读取节点和读取xml模式(schemas)。
xmlwriter类为程序员提供了许多写xml文档的方法,它是xmltextwriter类的基类,我在后面的实例中会给出相关的运用方法。
xmlnode类是一个非常重要的类,它代表了xml文档中的某个节点。该节点可以是xml文档的根节点,这样它就代表整个xml文档了。它是许多很有用的类的基类,这些类包括插入节点的类、删除节点的类、替换节点的类以及在xml文档中完成导航功能的类。同时,xmlnode类还为程序员提供了获取双亲节点、子节点、最后一个子节点、节点名称以及节点类型等的属性。它的三个最主要的子类包括:xmldocument、xmldatadocument以及xmldocumentfragment。xmldocument类代表了一个xml文档,它提供了载入和保存xml文档的方法和属性。这些方法包括了load、loadxml和save等。同时,它还提供了添加特性(attributes)、说明(comments)、空间(spaces)、元素(elements)和新节点(new nodes)等xml项的功能。xmldocumentfragment类代表了一部分xml文档,它能被用来添加到其他的xml文档中。xmldatadocument类可以让程序员更好地完成和ado.net中的数据集对象之间的互操作。
除了上面介绍的system.xml命名空间中的类外,该命名空间还包括了xmlconvert、xmllinkednode以及xmlnodelist等类,不过这些类不是本文介绍的重点,有兴趣的读者不妨去参考相关文档资料。
system.xml.schema命名空间中包含了和xml模式相关的类,这些类包括xmlschema、xmlschemaall、xmlschemaxpath以及xmlschematype等类。
system.xml.serialization命名空间中包含了和xml文档的序列化和反序列化操作相关的类,xml文档的序列化操作能将xml格式的数据转化为流格式的数据并能在网络中传输,而反序列化则完成相反的操作,即将流格式的数据还原成xml格式的数据。
system.xml.xpath命名空间包含了xpathdocument、xpathexression、xpathnavigator以及xpathnodeiterator等类,这些类能完成xml文档的导航功能。在xpathdocument类的协助下,xpathnavigator类能完成快速的xml文档导航功能,该类为程序员提供了许多move方法以完成导航功能。
system.xml.xsl命名空间中的类完成了xslt的转换功能。
三.读xml文档的方法:
在介绍完.net框架中和xml有关的命名空间和相关类后,我接着向大家介绍和xml相关的一些操作。首先,我向大家介绍的读取xml文档的方法。在下面的实例程序中,我将运用vs.net开发工具附带的"books.xml"文件来作为示例。你可以在你的机器上搜索到该文件(或请参考附录),或者你也可以运用其他的xml文件。
首先,我们用xmltextreader类的对象来读取该xml文档。方法很简单,就是在创建新对象的构造函数中指明xml文件的位置即可。
xmltextreader textreader = new xmltextreader("c://books.xml");
一旦新对象创建完毕,你就可以调用其read方法来读取xml文档了。调用read方法之后,信息被存储起来,你可以通过读取该对象的name、baseuri、depth、linenumber等属性来获取这些信息。下面我给出一个完整的实例,该实例通过简单的读取"books.xml"文件,然后将其中的信息显示在控制台中。
using system;
using system.xml;
namespace readxml
{
class class1
{
static void main( string[] args )
{
// 创建一个xmltextreader类的对象并调用read方法来读取文件
xmltextreader textreader = new xmltextreader("c://books.xml");
textreader.read();
// 节点非空则执行循环体
while ( textreader.read() )
{
// 读取第一个元素
textreader.movetoelement();
console.writeline("xmltextreader properties test");
console.writeline("===================");
// 读取该元素的属性并显示在控制台中
console.writeline("name:" + textreader.name);
console.writeline("base uri:" + textreader.baseuri);
console.writeline("local name:" + textreader.localname);
console.writeline("attribute count:" + textreader.attributecount.tostring());
console.writeline("depth:" + textreader.depth.tostring());
console.writeline("line number:" + textreader.linenumber.tostring());
console.writeline("node type:" + textreader.nodetype.tostring());
console.writeline("attribute count:" + textreader.value.tostring());
}
}
}
}
xmltextreader类中有一个很重要的属性-nodetype,通过该属性,我们可以知道其节点的节点类型。而枚举类型xmlnodetype中包含了诸如attribute、cdata、element、comment、document、documenttype、entity、processinstruction以及whitespace等的xml项的类型。通过与xmlnodetype中的元素的比较,我们可以获取相应节点的节点类型并对其完成相关的操作。下面我就给出一个实例,该实例读取每个节点的nodetype,并根据其节点类型显示其中的内容,同时程序还记录了xml文件中每种节点类型的数目。
using system;
using system.xml;
namespace readxml
{
class class2
{
static void main( string[] args )
{
int ws = 0;
int pi = 0;
int dc = 0;
int cc = 0;
int ac = 0;
int et = 0;
int el = 0;
int xd = 0;
xmltextreader textreader = new xmltextreader("c://books.xml");
while (textreader.read())
{
xmlnodetype ntype = textreader.nodetype;
// 节点类型为xmldeclaration
if (ntype == xmlnodetype.xmldeclaration)
{
console.writeline("declaration:" + textreader.name.tostring());
xd = xd + 1;
}
// 节点类型为comment
if( ntype == xmlnodetype.comment)
{
console.writeline("comment:" + textreader.name.tostring());
cc = cc + 1;
}
// 节点类型为attribute
if( ntype == xmlnodetype.attribute)
{
console.writeline("attribute:" + textreader.name.tostring());
ac = ac + 1;
}
// 节点类型为element
if ( ntype == xmlnodetype.element)
{
console.writeline("element:" + textreader.name.tostring());
el = el + 1;
}
// 节点类型为entity
if ( ntype == xmlnodetype.entity )
{
console.writeline("entity:" + textreader.name.tostring());
et = et + 1;
}
// 节点类型为process instruction
if( ntype == xmlnodetype. processinstruction )
{
console.writeline("process instruction:" + textreader.name.tostring());
pi = pi + 1;
}
// 节点类型为documenttype
if( ntype == xmlnodetype.documenttype)
{
console.writeline("documenttype:" + textreader.name.tostring());
dc = dc + 1;
}
// 节点类型为whitespace
if ( ntype == xmlnodetype.whitespace )
{
console.writeline("whitespace:" + textreader.name.tostring());
ws = ws + 1;
}
}
// 在控制台中显示每种类型的数目
console.writeline("total comments:" + cc.tostring());
console.writeline("total attributes:" + ac.tostring());
console.writeline("total elements:" + el.tostring());
console.writeline("total entity:" + et.tostring());
console.writeline("total process instructions:" + pi.tostring());
console.writeline("total declaration:" + xd.tostring());
console.writeline("total documenttype:" + dc.tostring());
console.writeline("total whitespaces:" + ws.tostring());
}
}
}
以上,我向大家介绍了如何运用xmltextreader类的对象来读取xml文档,并根据节点的nodetype属性来取得其节点类型信息。同时xmlreader这个基类还有xmlnodereader和xmlvalidatingreader等派生类,它们分别是用来读取xml文档的节点和模式的。限于篇幅,这里就不介绍了,读者可以参考有关资料。
四.写xml文档的方法:
xmlwriter类包含了写xml文档所需的方法和属性,它是xmltextwriter类和xmlnodewriter类的基类。该类包含了writenode、writestring、writeattributes、writestartelement以及writeendelement等一系列写xml文档的方法,其中有些方法是成对出现的。比如你要写入一个元素,你首先得调用writestartelement方法,接着写入实际内容,最后是调用writeendelement方法以表示结束。该类还包含了writestate、xmllang和xmlspace等属性,其中writestate属性表明了写的状态。因为xmlwriter类包含了很多写xml文档的方法,所以这里只是介绍最主要的几种。下面我们通过其子类xmltextwriter类来说明如何写xml文档。
首先,我们要创建一个xmltextwriter类的实例对象。该类的构造函数xmltextwriter有三种重载形式,其参数分别为一个字符串、一个流对象和一个textwriter对象。这里我们运用字符串的参数形式,该字符串就指明了所要创建的xml文件的位置,方法如下:
xmltextwriter textwriter = new xmltextwriter("c://myxmfile.xml", null);
在创建完对象后,我们调用writerstartdocument方法开始写xml文档,在完成写工作后,就调用writeenddocument结束写过程并调用close方法将它关闭。在写的过程中,我们可以调用writecomment方法来添加说明,通过调用writestring方法来添加一个字符串,通过调用writestartelement和writeendelement方法对来添加一个元素,通过调用writestartattribute和writeendattribute方法对来添加一个属性。我们还可以通过调用writenode方法来添加整一个节点,其它的写的方法还包括writeprocessinginstruction和writedoctype等等。下面的实例就是介绍如何具体运用这些方法来完成xml文档的写工作的。
using system;
using system.xml;
namespace writexml
{
class class1
{
static void main( string[] args )
{
// 创建xmltextwriter类的实例对象
xmltextwriter textwriter = new xmltextwriter("c://myxmfile.xml", null);
// 开始写过程,调用writestartdocument方法
textwriter.writestartdocument();
// 写入说明
textwriter.writecomment("first comment xmltextwriter sample example");
textwriter.writecomment("myxmlfile.xml in root dir");
// 写入一个元素
textwriter.writestartelement("name", "");
textwriter.writestring("student");
textwriter.writeendelement();
// 再写入一个元素
textwriter.writestartelement("address", "");
textwriter.writestring("colony");
textwriter.writeendelement();
// 写入字符
char [] ch = new char[3];
ch[0] = 'a';
ch[1] = 'r';
ch[2] = 'c';
textwriter.writestartelement("char");
textwriter.writechars(ch, 0, ch.length);
textwriter.writeendelement();
// 写文档结束,调用writeenddocument方法
textwriter.writeenddocument();
// 关闭textwriter
textwriter.close();
}
}
}
五.运用xmldocument类:
xmldocument类的对象代表了一个xml文档,它也是一个非常重要的xml类。该类包含了load、loadxml以及save等重要的方法。其中load方法可以从一个字符串指定的xml文件或是一个流对象、一个textreader对象、一个xmlreader对象导入xml数据。loadxml方法则完成从一个特定的xml文件导入xml数据的功能。它的save方法则将xml数据保存到一个xml文件中或是一个流对象、一个textwriter对象、一个xmlwriter对象中。
下面的程序中我们用到了xmldocument类对象的loadxml方法,它从一个xml文档段中读取xml数据并调用其save方法将数据保存在一个文件中。
// 创建一个xmldocument类的对象
xmldocument doc = new xmldocument();
doc.loadxml(("<student type='regular' section='b'><name>tommy lex</name></student>"));
// 保存到文件中
doc.save("c://student.xml");
这里,我们还可以通过改变save方法中参数,将xml数据显示在控制台中,方法如下:
doc.save(console.out);
而在下面的程序中,我们用到了一个xmltextreader对象,通过它我们读取"books.xml"文件中的xml数据。然后创建一个xmldocument对象并载入xmltextreader对象,这样xml数据就被读到xmldocument对象中了。最后,通过该对象的save方法将xml数据显示在控制台中。
xmldocument doc = new xmldocument();
// 创建一个xmltextreader对象,读取xml数据
xmltextreader reader = new xmltextreader("c://books.xml");
reader.read();
// 载入xmltextreader类的对象
doc.load(reader);
// 将xml数据显示在控制台中
doc.save(console.out);
六.总结:
xml技术作为.net的基石,其重要性自然不言而喻。.net框架包含了五个命名空间和大量的类来支持与xml技术有关的操作。其中system.xml是最重要的一个命名空间,其中的xmlreader类和xmlwriter类以及它们的派生类完成了xml文档的读写操作,是最基本也是最重要的类。xmldocument类代表了xml文档,它能完成与整个xml文档相关的各类操作,同时和其相关的xmldatadocument类也是非常重要的,值得读者的深入研究。
附录
"books.xml"文件如下:
<?xml version='1.0'?>
<!-- this file represents a fragment of a book store inventory database -->
<bookstore>
<book genre="autobiography" publicationdate="1981" isbn="1-861003-11-0">
<title>the autobiography of benjamin franklin</title>
<author>
<first-name>benjamin</first-name>
<last-name>franklin</last-name>
</author>
<price>8.99</price>
</book>
<book genre="novel" publicationdate="1967" isbn="0-201-63361-2">
<title>the confidence man</title>
<author>
<first-name>herman</first-name>
<last-name>melville</last-name>
</author>
<price>11.99</price>
</book>
<book genre="philosophy" publicationdate="1991" isbn="1-861001-57-6">
<title>the gorgias</title>
<author>
<first-name>sidas</first-name>
<last-name>plato</last-name>
</author>
<price>9.99</price>
</book>
</bookstore>