利用XMLSerializer将对象串行化到XML

XmlSerializer 类(System.Xml.Serialization)

微软已经意识到串行化数据的重要性，因此在.NET框架中包含了命名空间System.Runtime.Serialization和System.Xml.Serialization以提供串行化功能，为用户自己编写串行化方法提供了一个框架。System.Xml.Serialization命名空间提供了将一个对象串行化为XML格式的基本方法。下面我们来看看如何使用这种方法。

XML的魅力

串行化XML是指为了方便存储或传输，把一个对象的公共的域和属性保存为一种串行格式（这里是XML格式）的过程。非串行化则是使用串行的状态信息将对象从串行XML状态还原成原始状态的过程。因此，可以把串行化看作是将对象的状态保存到流或缓冲区中的一种方法。

串行化的目的是数据存储和数据转换。数据存储指的是在用户会话时保存数据。当应用程序关闭时，数据被保存（串行化），而当用户回来时，数据又被重新加载（非串行化）。数据转换指将数据变换成能被另一个系统识别的格式。使用串行化和XML，可以很方便的进行数据转换。

对象中的数据可以是类、方法、属性、私有类型、数组，在System.Xml.XmlElement或System.Xml.XmlAttribute对象中，它甚至可以是内嵌的XML。

System.Xml.Serialization命名空间中的关键类是XmlSerializer。当然在该命名空间中还包括有关XML其他方面以及SOAP相关的其他类，不过我们的重点是XmlSerializer类。

XmlSerializer

XmlSerializer类提供了把对象串行化为XML文件及把XML文档非串行化为对象的方法。它还能让用户指定对象如何转化为XML。可以把将被串行化的对象的类型作为类构造函数的参数。下面的C# 代码说明了构造函数的用法。

XmlSerializer ser = new XmlSerializer(typeof(objectToSerialize));

控制输出

串行化过程生成标准的XML文件，数据成员转换为XML元素。不过，并非所有的数据成员都变成元素，可以通过在类代码中添加一些标记来控制输出的XML文件。这样，数据成员可以变换为XML属性而非元素，也可以简单的被忽略掉。下面的例子是一段经过修改后的book类VB.NET代码。

Public Class Book
Public AuthorObject As Author
Public Title As String
<System.Xml.Serialization.XmlAttribute()> _
Public ISBN As String
<System.Xml.Serialization.XmlIgnoreAttribute()> _
Public RetailPrice As Double
Public Publisher As String
End Class

这段代码告诉系统在生成XML文件时把类成员ISBN作为XML属性，同时忽略掉RetailPrice成员。这种变化可以在生成的XML文件中可以看出：

<?xml version="1.0" encoding="utf-8"?>
<Book xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ISBN="1884777767 ">
<AuthorObject>
<FirstName>Tony</FirstName>
<LastName>Patton</LastName>
<Gender>Male</Gender>
<AddressObject>
<Address1>1 Main Street</Address1>
<City>Anywhere</City>
<State>KY</State>
<Zip>40000</Zip>
<Country>USA</Country>
</AddressObject>
</AuthorObject>
<Title>Practical LotusScript</Title>
<Publisher>Manning Publications</Publisher>
</Book>

以下是相应的C# 代码：

public class Book {
public Book() { }
public string Title;
public Author AuthorObject;
[System.Xml.Serialization.XmlAttribute()]
public string ISBN;
[System.Xml.Serialization.XmlIgnoreAttribute()]
public double RetailPrice;
public string Publisher;
}

上面仅是稍微提了两种标记符号。请查阅.NET文档以获得完整的标记符号。

非串行化

非串行化数据通过调用XmlSerializer类的Deserialize方法可以方便地实现。以下的VB.NET程序片断完成上文中XML文档的非串行化：

Dim BookObject As New Book
Dim ser As New XmlSerializer(GetType(Book))
Dim fs As New System.IO.FileStream("booktest.xml", FileMode.Open)
Dim reader As New System.XML.XmlTextReader(fs)
BookObject = CType(ser.Deserialize(reader), Book)

该程序把结果数据放入内存备用。

下面是等价的C# 代码：

XmlSerializer ser = new XmlSerializer(typeof(Book));
System.IO.FileStreamfs = new System.IO.FileStream("booktest.xml",
FileMode.Open);
System.Xml.XmlTextReader reader = new System.Xml.XmlTextReader(fs);
Book BookObject = (Book)(ser.Deserialize(reader));