C# XML序列化方法及常用特性總結(jié)分析
本文實例總結(jié)了C# XML序列化方法及常用特性。分享給大家供大家參考,具體如下:
C#對象XML序列化(一):序列化方法和常用特性
.Net Framework提供了對應(yīng)的System.Xml.Seriazliation.XmlSerializer負(fù)責(zé)把對象序列化到XML,和從XML中反序列化為對象。Serializer的使用比較直觀,需要多注意的是XML序列化相關(guān)的Attribute,怎么把這些attribute應(yīng)用到我們的對象,以及對象公共屬性上面去,生成滿足預(yù)期格式的XML。
這里列出了最常用的方法和特性,涵蓋日常大部分的轉(zhuǎn)換工作,希望大家在工作中快速上手。為了給大家直觀的印象,這里給出具體的使用代碼,為了節(jié)省篇幅,代碼異常處理沒有添加,各位同學(xué)使用的時候酌情添加。
1. Serializer方法
下面的方法封裝了XmlSerializer的調(diào)用,這里列出了參數(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講解說明:
[XmlRootAttribute("MyCity", Namespace="abc.abc", IsNullable=false)] // 當(dāng)該類為Xml根節(jié)點時,以此為根節(jié)點名稱。 public class City [XmlAttribute("AreaName")] // 表現(xiàn)為Xml節(jié)點屬性。<... AreaName="..."/> public string Name [XmlElementAttribute("AreaId", IsNullable = false)] // 表現(xiàn)為Xml節(jié)點。<AreaId>...</AreaId> public string Id [XmlArrayAttribute("Areas")] // 表現(xiàn)為Xml層次結(jié)構(gòu),根為Areas,其所屬的每個該集合節(jié)點元素名為類名。<Areas><Area ... /><Area ... /></Areas> public Area[] Areas [XmlElementAttribute("Area", IsNullable = false)] // 表現(xiàn)為水平結(jié)構(gòu)的Xml節(jié)點。<Area ... /><Area ... />... public Area[] Areas [XmlIgnoreAttribute] // 忽略該元素的序列化。
3. 詳細(xì)舉例說明
這里用簡單的城市,區(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ù)以上類型,我們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>
下面我們開始具體分析結(jié)果,其中包含一些很有用的結(jié)論和注意事項:
1. xml的版本,編碼,以及命名空間xmlns:xsi,xmlns:xsd為Framework自動添加。
2. 因為我們用City對象作為根節(jié)點,所以根節(jié)點名稱為我們定義的"MyCity"。
但是,注意!這里指的是用City自身直接做根節(jié)點,如果是City集合比如City[],此時,該名稱失效,系統(tǒng)會自動生成名稱ArrayOfCity作為根節(jié)點名稱(ArrayOf+類名),或者我們手動指定名稱,這個就是在給大家的SaveToXml()方法中,參數(shù)xmlRootName的作用。
3. 如果以City為根節(jié)點并在XmlRootAttribute特性中給定名稱,同時也手動指定了xmlRootName,系統(tǒng)會以手動指定的名稱為準(zhǔn)。
4. AreaName,AreaId,同為Area類的公共屬性,一個被解釋成屬性,一個被解釋成子節(jié)點。
Areas集合被解釋成了層次結(jié)構(gòu),Streets集合被解釋成了水平結(jié)構(gòu)。
這兩組區(qū)別最能體現(xiàn)不同序列化Attribute的用法。
PS:小編這里再來為大家推薦幾款關(guān)于xml操作的在線工具供大家免費使用。相信在以后開發(fā)中可以用的到:
在線XML格式化/壓縮工具:
http://tools.jb51.net/code/xmlformat
在線XML/JSON互相轉(zhuǎn)換工具:
http://tools.jb51.net/code/xmljson
xml代碼在線格式化美化工具:
http://tools.jb51.net/code/xmlcodeformat
HTML/XML轉(zhuǎn)義字符對照表:
http://tools.jb51.net/table/html_escape
更多關(guān)于C#相關(guān)內(nèi)容感興趣的讀者可查看本站專題:《C#中XML文件操作技巧匯總》、《C#常見控件用法教程》、《WinForm控件用法總結(jié)》、《C#數(shù)據(jù)結(jié)構(gòu)與算法教程》、《C#面向?qū)ο蟪绦蛟O(shè)計入門教程》及《C#程序設(shè)計之線程使用技巧總結(jié)》
希望本文所述對大家C#程序設(shè)計有所幫助。
相關(guān)文章
用C#獲取硬盤序列號,CPU序列號,網(wǎng)卡MAC地址的源碼
用C#獲取硬盤序列號,CPU序列號,網(wǎng)卡MAC地址的源碼...2007-03-03C#多線程之Thread中Thread.Join()函數(shù)用法分析
這篇文章主要介紹了C#多線程之Thread中Thread.Join()函數(shù)用法,實例分析了Thread.Join()方法的原理與使用技巧,非常具有實用價值,需要的朋友可以參考下2015-04-04C#實現(xiàn)將程序鎖定到Win7任務(wù)欄的方法
這篇文章主要介紹了C#實現(xiàn)將程序鎖定到Win7任務(wù)欄的方法,涉及C#調(diào)用Shell類的相關(guān)技巧,具有一定參考借鑒價值,需要的朋友可以參考下2015-08-08