.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之間的結構映射，希望足夠同學們對付日常工作。更深入的討論會在后續的文章跟進。