.NET 提供了將自訂物件序列化(Serialize)與反序列化(Deserialize)為 XML 的能力。這類序列化機制可以處理的內容包括:
這裡有一個重要的設計前提:被序列化的類別必須提供無參數的建構子,否則執行時會丟出例外。
開發過程中經常需要在物件與 XML 之間互相轉換,因此我封裝了一個支援泛型的通用工具類,如下所示:
/// <summary>
/// 序列化幫助類
/// </summary>
public class SHelper
{
/// <summary>
/// 物件轉為 XML(泛型)
/// </summary>
public static string SaveXmlFromObj<T>(T obj)
{
if (obj == null) return null;
XmlSerializer serializer = new XmlSerializer(typeof(T));
MemoryStream stream = new MemoryStream();
XmlTextWriter xtw = new XmlTextWriter(stream, Encoding.UTF8);
xtw.Formatting = Formatting.Indented;
try
{
serializer.Serialize(stream, obj);
}
catch { return null; }
stream.Position = 0;
string returnStr = string.Empty;
using (StreamReader sr = new StreamReader(stream, Encoding.UTF8))
{
string line = "";
while ((line = sr.ReadLine()) != null)
{
returnStr += line;
}
}
return returnStr;
}
/// <summary>
/// XML 反序列化為物件(泛型)
/// </summary>
public static T LoadObjFromXml<T>(string data)
{
using (MemoryStream stream = new MemoryStream())
{
using (StreamWriter sw = new StreamWriter(stream, Encoding.UTF8))
{
sw.Write(data);
sw.Flush();
stream.Seek(0, SeekOrigin.Begin);
XmlSerializer serializer = new XmlSerializer(typeof(T));
try
{
return (T)serializer.Deserialize(stream);
}
catch { return default(T); }
}
}
}
}
這個類別提供兩個方法:一個把物件轉成 XML 字串,另一個把 XML 字串還原成物件。接著我們看看實際用法。
首先建立 User 與 Users 兩個類別,分別用來測試單一實體與 List 集合的序列化。注意兩者都標上了 [Serializable] 特性,並提供了無參數建構子。
[Serializable]
public class User
{
public int ID { get; set; }
public string Name { get; set; }
public string Add { get; set; }
public int Age { get; set; }
public User()
{
this.ID = default(int);
this.Name = default(string);
this.Add = default(string);
this.Age = default(int);
}
}
[Serializable]
public class Users
{
public List<User> Datas { get; set; }
public Users()
{
this.Datas = new List<User>();
}
}
接著建立一個 Default.aspx 頁面,用來測試序列化。頁面上放了兩個按鈕與兩個 TextBox,分別顯示單一物件與 List 集合的序列化結果。
<form id="form1" runat="server">
<div>
<asp:Button ID="Button1" runat="server" Text="一個物件序列化" onclick="Button1_Click" /><br />
<asp:TextBox ID="TextBox1" runat="server" Width="100%" Height="200"></asp:TextBox><br />
<asp:Button ID="Button2" runat="server" Text="多個物件序列化" onclick="Button2_Click" /><br />
<asp:TextBox ID="TextBox2" runat="server" Width="100%" Height="200"></asp:TextBox><br />
</div>
</form>
後台程式碼的實作:
/// 單一物件序列化
protected void Button1_Click(object sender, EventArgs e)
{
User user = new User() { ID = 1001, Name = "小王", Add = "北京", Age = 21 };
var str = SHelper.SaveXmlFromObj<User>(user);
this.TextBox1.Text = str;
}
/// 多個物件序列化
protected void Button2_Click(object sender, EventArgs e)
{
Users users = new Users();
User user = new User() { ID = 1001, Name = "小王", Add = "北京", Age = 21 };
users.Datas.Add(user);
users.Datas.Add(user);
users.Datas.Add(user);
var str = SHelper.SaveXmlFromObj<Users>(users);
this.TextBox2.Text = str;
}
序列化後的結果如下。
單一物件:
<?xml version="1.0"?>
<User xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<ID>1001</ID>
<Name>小王</Name>
<Add>北京</Add>
<Age>21</Age>
</User>
List 集合:
<?xml version="1.0"?>
<Users xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<Datas>
<User><ID>1001</ID><Name>小王</Name><Add>北京</Add><Age>21</Age></User>
<User><ID>1001</ID><Name>小王</Name><Add>北京</Add><Age>21</Age></User>
<User><ID>1001</ID><Name>小王</Name><Add>北京</Add><Age>21</Age></User>
</Datas>
</Users>
最後測試反序列化。建立一個 Web Service,撰寫兩個測試方法:
[WebMethod]
public string GetObjFromXml(string data)
{
var obj = SHelper.LoadObjFromXml<User>(data);
if (obj != null)
return obj.Name;
else
return "傳入資料出錯";
}
[WebMethod]
public string GetObjsFromXml(string data)
{
var obj = SHelper.LoadObjFromXml<Users>(data);
if (obj != null)
{
string returnstr = "";
foreach (User user in obj.Datas)
{
returnstr += user.Name + "\n";
}
return returnstr;
}
else
{
return "傳入資料出錯";
}
}
編譯並執行後,只要把先前序列化出來的字串貼到參數位址,就能測試反序列化方法。有興趣的朋友不妨動手把範例跑一遍,會更有體會。