物件(List<T>)的序列化和反序列化

石曼迪發表於2013-11-07
物件

本文描述將物件(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查詢等業務。

本文示例程式碼點選下載。

相關文章