本文實(shí)例總結(jié)了C# XML序列化方法及常用特性。分享給大家供大家參考，具體如下：
C#對(duì)象XML序列化（一）：序列化方法和常用特性
.Net Framework提供了對(duì)應(yīng)的System.Xml.Seriazliation.XmlSerializer負(fù)責(zé)把對(duì)象序列化到XML，和從XML中反序列化為對(duì)象。Serializer的使用比較直觀，需要多注意的是XML序列化相關(guān)的Attribute，怎么把這些attribute應(yīng)用到我們的對(duì)象，以及對(duì)象公共屬性上面去，生成滿(mǎn)足預(yù)期格式的XML。
這里列出了最常用的方法和特性，涵蓋日常大部分的轉(zhuǎn)換工作，希望大家在工作中快速上手。為了給大家直觀的印象，這里給出具體的使用代碼，為了節(jié)省篇幅，代碼異常處理沒(méi)有添加，各位同學(xué)使用的時(shí)候酌情添加。
1. Serializer方法
下面的方法封裝了XmlSerializer的調(diào)用，這里列出了參數(shù)最全的一個(gè)版本，具體使用的時(shí)候需適當(dāng)添加重載：
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講解說(shuō)明：
[XmlRootAttribute("MyCity", Namespace="abc.abc", IsNullable=false)] // 當(dāng)該類(lèi)為Xml根節(jié)點(diǎn)時(shí)，以此為根節(jié)點(diǎn)名稱(chēng)。public class City[XmlAttribute("AreaName")] // 表現(xiàn)為Xml節(jié)點(diǎn)屬性。<... AreaName="..."/>public string Name[XmlElementAttribute("AreaId", IsNullable = false)] // 表現(xiàn)為Xml節(jié)點(diǎn)。<AreaId>...</AreaId>public string Id[XmlArrayAttribute("Areas")] // 表現(xiàn)為Xml層次結(jié)構(gòu)，根為Areas，其所屬的每個(gè)該集合節(jié)點(diǎn)元素名為類(lèi)名。<Areas><Area ... /><Area ... /></Areas>public Area[] Areas[XmlElementAttribute("Area", IsNullable = false)] // 表現(xiàn)為水平結(jié)構(gòu)的Xml節(jié)點(diǎn)。<Area ... /><Area ... />...public Area[] Areas[XmlIgnoreAttribute] // 忽略該元素的序列化。3. 詳細(xì)舉例說(shuō)明
這里用簡(jiǎn)單的城市，區(qū)域和街區(qū)作為例子，具體示范一下上面的規(guī)則。
[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; }}根據(jù)以上類(lèi)型，我們mock一些數(shù)據(jù)，然后用步驟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>
下面我們開(kāi)始具體分析結(jié)果，其中包含一些很有用的結(jié)論和注意事項(xiàng)：
1. xml的版本，編碼，以及命名空間xmlns:xsi，xmlns:xsd為Framework自動(dòng)添加。
2. 因?yàn)槲覀冇肅ity對(duì)象作為根節(jié)點(diǎn)，所以根節(jié)點(diǎn)名稱(chēng)為我們定義的"MyCity"。
但是，注意！這里指的是用City自身直接做根節(jié)點(diǎn)，如果是City集合比如City[]，此時(shí)，該名稱(chēng)失效，系統(tǒng)會(huì)自動(dòng)生成名稱(chēng)ArrayOfCity作為根節(jié)點(diǎn)名稱(chēng)(ArrayOf+類(lèi)名)，或者我們手動(dòng)指定名稱(chēng)，這個(gè)就是在給大家的SaveToXml（）方法中，參數(shù)xmlRootName的作用。
3. 如果以City為根節(jié)點(diǎn)并在XmlRootAttribute特性中給定名稱(chēng)，同時(shí)也手動(dòng)指定了xmlRootName，系統(tǒng)會(huì)以手動(dòng)指定的名稱(chēng)為準(zhǔn)。
4. AreaName，AreaId，同為Area類(lèi)的公共屬性，一個(gè)被解釋成屬性，一個(gè)被解釋成子節(jié)點(diǎn)。
Areas集合被解釋成了層次結(jié)構(gòu)，Streets集合被解釋成了水平結(jié)構(gòu)。
這兩組區(qū)別最能體現(xiàn)不同序列化Attribute的用法。
新聞熱點(diǎn)
疑難解答
圖片精選
網(wǎng)友關(guān)注
