本文描述将对象(List)序列化到 XML 文档中和从 XML 文档中反序列化为对象(List)。
命名空间: System.Xml.Serialization
程序集: System.Xml.Serialization(在 System.Xml.Serialization.dll 中)
通用的序列化类(包含序列化和反序列化方法)如下:
///
///序列化
///
///
///
///
public static string XmlSerializer(T serialObject) where T : class
{
var emptyNamepsaces = new XmlSerializerNamespaces(new[] { XmlQualifiedName.Empty });
var serializer = new XmlSerializer(serialObject.GetType());
var settings = new XmlWriterSettings();
settings.OmitXmlDeclaration = true;
settings.Encoding = Encoding.UTF8;
using (var stream = new StringWriter())
using (var writer = XmlWriter.Create(stream, settings))
{
serializer.Serialize(writer, serialObject, emptyNamepsaces);
return stream.ToString();
}
}
///
///反序列化
///
///
///
///
public static T DeserializeObject(string xml) where T : class
{
using (var str = new StringReader(xml))
{
var xmlSerializer = new XmlSerializer(typeof(T));
var result = (T)xmlSerializer.Deserialize(str);
return result;
}
}
XmlSerializerNamespaces 包含的 XML 命名空间必须符合称为的 www.w3.org 规范,XML 命名空间,而XmlQualifiedName.Empty表示无XML限定名。
XmlSerializer(Type):初始化 XmlSerializer 类的新实例,该类可以将指定类型的对象序列化为 XML 文档,也可以将 XML 文档反序列化为指定类型的对象。(应用程序通常定义若干类,XmlSerializer 将这些类转换为单个 XML 实例文档。 但是,XmlSerializer 只需知道一种类型,即表示 XML 根元素的类的类型。 XmlSerializer 自动序列化所有从属类的实例。 同样,反序列化仅需要 XML 根元素的类型)。
XmlWriterSettings:使用XmlWriterSettings实例对象进行生成的XML的设置。如是否缩进文本、缩进量、每个节点一行等配置(另:XmlReaderSettings代替XmlValidatingReader可用于XML验证)。
性能建议:
为了提高性能,XML 序列化基础结构动态生成程序集,以便对指定类型进行序列化和反序列化。 该基础结构将找到并重新使用这些程序集。 仅当使用以下构造函数时,才会发生此行为:
• XmlSerializer(Type)
• XmlSerializer.XmlSerializer(Type, String)
如果使用任何其他构造函数,则将生成同一个程序集的多个版本,这些版本始终不予卸载,从而导致内存泄漏和性能低下。 最简单的解决方案是使用前面提到的两个构造函数中的一个。
举例说明:
新建一个订单类一个订单明细类,如图:
实例化并添加属性值:
List orderDetail = new List {
new OrderDetail{ ID=100, ItemNum=3, ItemPrice=199,OrderDetailID="L001001", OrderDetailItem="电视机", OrderDetailMark="挂账", OrderID="L001" },
new OrderDetail{ ID=101, ItemNum=1, ItemPrice=1,OrderDetailID="L001002", OrderDetailItem="肥皂", OrderDetailMark="挂账", OrderID="L001" },
new OrderDetail{ ID=102, ItemNum=2, ItemPrice=0.05M,OrderDetailID="L001003", OrderDetailItem="方便袋", OrderDetailMark="挂账", OrderID="L001" }
};
Order order = new Order { ID = 1, OrderDate = DateTime.Now, OrderID = "L001", OrderTax = true, OrderTotal = 200.05M, orderDetails = orderDetail };
然后调用序列化方法如下:
//序列化
string xml = XMLSerializer.XmlSerializer(order);
Console.WriteLine("-------------------------------------------");
Console.WriteLine(xml);
Console.WriteLine("-------------------------------------------");
结果如图:
继续进行反序列化,代码如:
//反序列化
Order dOrder = XMLSerializer.DeserializeObject(xml);
Console.WriteLine("订单有明细:"+dOrder.orderDetails.Count+"项,共计:"+dOrder.OrderTotal+"元");
Console.WriteLine("编号\t名称\t单价");
foreach (var item in dOrder.orderDetails)
{
Console.WriteLine(item.OrderDetailID + "\t" + item.OrderDetailItem + "\t" + item.ItemPrice);
}
运行结果如:
不过请注意,XmlSerializer 无法序列化或反序列化以下数组:
•ArrayList 的数组
•List 的数组
•业务需要不用序列化的属性,只需给该属性加上XmlIgnore
特性即可,再次执行序列化操作如图,大家会发现已经少了一个子节点。
序列化后的字符串可参与传输,复杂类型存储,SQL查询等业务。
本文示例代码点击下载。