C#对象XML序列化（一）：序列化方法和常用特性

.Net Framework提供了对应的System.Xml.Seriazliation.XmlSerializer负责把对象序列化到XML，和从XML中反序列化为对象。Serializer的使用比较直观，需要多注意的是XML序列化相关的Attribute，怎么把这些attribute应用到我们的对象，以及对象公共属性上面去，生成满足预期格式的XML。
本文列出了最常用的方法和特性，涵盖日常大部分的转换工作，希望大家在工作中快速上手。为了给大家直观的印象，这里给出具体的使用代码，为了节省篇幅，代码异常处理没有添加，各位同学使用的时候酌情添加。

1. Serializer方法

下面的方法封装了XmlSerializer的调用，这里列出了参数最全的一个版本，具体使用的时候需适当添加重载：

    public static class XmlSerializer{public static void SaveToXml(string filePath, object sourceObj, Type type, string xmlRootName){if (!string.IsNullOrWhiteSpace(filePath) && sourceObj != null){type = type != null ? type : sourceObj.GetType();using (StreamWriter writer = new StreamWriter(filePath)){System.Xml.Serialization.XmlSerializer xmlSerializer = string.IsNullOrWhiteSpace(xmlRootName) ?new System.Xml.Serialization.XmlSerializer(type) :new System.Xml.Serialization.XmlSerializer(type, new XmlRootAttribute(xmlRootName));xmlSerializer.Serialize(writer, sourceObj);}}}public static object LoadFromXml(string filePath, Type type){object result = null;if (File.Exists(filePath)){using (StreamReader reader = new StreamReader(filePath)){System.Xml.Serialization.XmlSerializer xmlSerializer = new System.Xml.Serialization.XmlSerializer(type);result = xmlSerializer.Deserialize(reader);}}return result;}}

2. 序列化常用Attribute讲解说明：

[XmlRootAttribute("MyCity", Namespace="abc.abc", IsNullable=false)] // 当该类为Xml根节点时，以此为根节点名称。
public class City

[XmlAttribute("AreaName")] // 表现为Xml节点属性。<... AreaName="..."/>
public string Name

[XmlElementAttribute("AreaId", IsNullable = false)] // 表现为Xml节点。<AreaId>...</AreaId>
public string Id

[XmlArrayAttribute("Areas")] // 表现为Xml层次结构，根为Areas，其所属的每个该集合节点元素名为类名。<Areas><Area ... /><Area ... /></Areas>
public Area[] Areas

[XmlElementAttribute("Area", IsNullable = false)] // 表现为水平结构的Xml节点。<Area ... /><Area ... />...
public Area[] Areas

[XmlIgnoreAttribute] // 忽略该元素的序列化。

3. 详细举例说明

这里用简单的城市，区域和街区作为例子，具体示范一下上面的规则。

    [XmlRootAttribute("MyCity", Namespace = "abc.abc", IsNullable = false)]public class City{[XmlAttribute("CityName")] public string Name{get;set;}[XmlAttribute("CityId")] public string Id{get;set;}[XmlArrayAttribute("Areas")]public Area[] Areas{get;set;}}[XmlRootAttribute("MyArea")]public class Area{[XmlAttribute("AreaName")] public string Name{get;set;}[XmlElementAttribute("AreaId", IsNullable = false)]public string Id{get;set;}[XmlElementAttribute("Street", IsNullable = false)]public string[] Streets{get;set;}}

根据以上类型，我们mock一些数据，然后用步骤1给出的Util方法输出：

    static void Main(string[] args){Area area1 = new Area();area1.Name = "Pudong";area1.Id = "PD001";area1.Streets = new string [] { "street 001", "street 002" };Area area2 = new Area();area2.Name = "Xuhui";area2.Id = "XH002";area2.Streets = new string [] { "street 003", "street 004" };City city1 = new City();city1.Name = "Shanghai";city1.Id = "SH001";city1.Areas = new Area[] { area1, area2 };XmlSerializer.SaveToXml(@"C:\temp\XML\output003.xml", city1);}

最终输出的XML为：

<?xml version="1.0" encoding="utf-8"?>
<MyCity xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:xsd="http://www.w3.org/2001/XMLSchema"CityName="Shanghai" CityId="SH001" xmlns="abc.abc"><Areas><Area AreaName="Pudong"><AreaId>PD001</AreaId><Street>street 001</Street><Street>street 002</Street></Area><Area AreaName="Xuhui"><AreaId>XH002</AreaId><Street>street 003</Street><Street>street 004</Street></Area></Areas>
</MyCity>

下面我们开始具体分析结果，其中包含一些很有用的结论和注意事项：
1. xml的版本，编码，以及命名空间xmlns:xsi，xmlns:xsd为Framework自动添加。

2. 因为我们用City对象作为根节点，所以根节点名称为我们定义的"MyCity"。
但是，注意！这里指的是用City自身直接做根节点，如果是City集合比如City[]，此时，该名称失效，系统会自动生成名称ArrayOfCity作为根节点名称(ArrayOf+类名)，或者我们手动指定名称，这个就是在给大家的SaveToXml（）方法中，参数xmlRootName的作用。

3. 如果以City为根节点并在XmlRootAttribute特性中给定名称，同时也手动指定了xmlRootName，系统会以手动指定的名称为准。

4. AreaName，AreaId，同为Area类的公共属性，一个被解释成属性，一个被解释成子节点。
Areas集合被解释成了层次结构，Streets集合被解释成了水平结构。
这两组区别最能体现不同序列化Attribute的用法。

4. 结语
这里用例子说明了Xml Serializer的用法，C#类和Xml之间的结构映射，希望足够同学们对付日常工作。更深入的讨论会在后续的文章跟进。

C#对象XML序列化（一）：序列化方法和常用特性相关推荐

Java对象XML序列化框架－Simple2.0
Java对象XML序列化框架-Simple2.0 Simple是一个XML序列化框架,一个Java 版本宽容的序列化框架,能够快速在Java 平台上开发XML.支持通过annotations完全配置化 ...
C# 对象序列化之序列化为Json文件（一）
目录 1.概念 1.1原理 1.2用途 1.3 JSON序列化 1.4 二进制和XML序列化 2. 序列化为JSON 2.1 简单的序列化 2.2 复杂的序列化 3 忽略属性 3.1 忽略单个属性 3 ...
C# 使用XML序列化对象（一）
在System.Xml.Serialization命名空间中提供了XML序列化类XmlSerializer用于将对象序列化为XML. 下面看一个最简单的例子: public class A{publi ...
XmlSerializer 对象的Xml序列化和反序列化，XMLROOT别名设置
这篇随笔对应的.Net命名空间是System.Xml.Serialization:文中的示例代码需要引用这个命名空间. 为什么要做序列化和反序列化? .Net程序执行时,对象都驻留在内存中:内存中的对 ...
Android -- 创建XML文件对象及其序列化， pull解析XML文件
1. 创建XML文件对象及其序列化示例代码:(模拟以xml格式备份短信到SD卡) SmsInfo.java, bean对象 /*** 短信的业务bean* @author Administrator ...
反序列化对象列表发生异常_面试官：你知道Java对象的序列化与反序列化背后的原理吗？...
序列化与反序列化序列化 (Serialization)是将对象的状态信息转换为可以存储或传输的形式的过程.一般将一个对象存储至一个储存媒介,例如档案或是记亿体缓冲等.在网络传输过程中,可以是字节或是 ...
利用.NET的XML序列化解决系统配置问题
作者:未知请作者速与本人联系出自: http://blog.csdn.net/ycl111/ 在Web系统开发中,我们经常需要读取和设置一些系统配置项,常见的例如数据库连接字符串.上传路径等等 ...
XML序列化以及新增节点XMLHelper
介绍利用XMLHelper类实现XML的新建以及反序列化类的操作,XMLHelper见最底部 1.XML新增 document = XmlHelper.CreateXmlDocument(" ...
Java对象的序列化与反序列化
序列化与反序列化序列化 (Serialization)是将对象的状态信息转换为可以存储或传输的形式的过程.一般将一个对象存储至一个储存媒介,例如文件或是内存缓冲区等.在网络传输过程中,可以是字节或是 ...

C#对象XML序列化（一）：序列化方法和常用特性

C#对象XML序列化（一）：序列化方法和常用特性相关推荐

最新文章

热门文章