本文描述將對象(List<T>)序列化到 XML 文檔中和從 XML 文檔中反序列化為對象(List<T>)。
命名空間: System.Xml.Serialization
程序集: System.Xml.Serialization(在 System.Xml.Serialization.dll 中)
通用的序列化類(包含序列化和反序列化方法)如下:
/// <summary> ///序列化 /// </summary> /// <typeparam name="T"></typeparam> /// <param name="serialObject"></param> /// <returns></returns> public static string XmlSerializer<T>(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(); } } /// <summary> ///反序列化 /// </summary> /// <typeparam name="T"></typeparam> /// <param name="xml"></param> /// <returns></returns> public static T DeserializeObject<T>(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> orderDetail = new List<OrderDetail> { 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>(order); Console.WriteLine("-------------------------------------------"); Console.WriteLine(xml); Console.WriteLine("-------------------------------------------");
結果如圖:
繼續進行反序列化,代碼如:
//反序列化 Order dOrder = XMLSerializer.DeserializeObject<Order>(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<T> 的數組
•業務需要不用序列化的屬性,只需給該屬性加上XmlIgnore
特性即可,再次執行序列化操作如圖,大家會發現已經少了一個子節點。
序列化后的字符串可參與傳輸,復雜類型存儲,SQL查詢等業務。
本文示例代碼點擊下載。
原文鏈接:對象(List<T>)的序列化和反序列化
其它鏈接:C#實現復雜XML的序列化與反序列化