XML 序列化描述的是這樣一個過程:取一個物件,把它轉換成 XML 文件,然後存檔保存,或送到網路上其他地方使用。在 .NET 中,這個機制會檢查類別的屬性是否為可讀寫,只要具備這個條件,該屬性的值就會被取出並寫進 XML 文件。反序列化(De-serialization)則是完全相反的流程。
.NET 用 XML 做事非常順手。使用 XML 序列化時,你要做的就是:把物件轉成一塊 XML,然後當作「串流」(stream)送出去。
隨著對 .NET 的認識加深,你會發現「串流」這個比喻特別貼切。要寫檔案到磁碟,就開一個檔案串流;要送位元組到另一台機器,就開一個網路串流。串流方法的妙處在於一致性——一旦你掌握了一種串流的使用方式,其他場合幾乎都能觸類旁通。
第一次看到 XML 序列化時,你可能會覺得有點複雜。要把物件轉成 XML 區塊,需要建立一個 XmlSerializer 物件,並把要轉換的物件交給它;要把 XML 轉回物件,用的同樣是 XmlSerializer,只是這次傳入的是 XML 而非物件。
多數情況下,你不需要對待序列化的物件做任何修改。XmlSerializer 會檢查物件的屬性,並假設所有可讀寫的屬性都應該被納入序列化。接著它就像一個典型的用戶端程式那樣呼叫這些屬性。
具體來說,若你的物件實作了一個名為 Name 的可讀寫屬性,XmlSerializer 會呼叫它,把回傳值插入 XML 區塊;反過來,當它要從 XML 建構物件時,會取出 XML 中的值並設定為物件的屬性值。這個過程是透過反射(Reflection)完成的。
對沒接觸過的人來說,反射是個相當強大的功能:它能檢查 .NET 中的任何物件,並決定它的屬性、方法與事件。
所有 .NET 物件都派生自 Object 類別,而 Object 提供了一個名為 GetType 的方法,回傳一個 System.Type 物件。這個型別物件上有 GetProperties、GetMethods 等方法,能取得更多關於該物件的資訊。
XmlSerializer 正是簡單地呼叫 GetProperties,取得一個 PropertyInfo 陣列,陣列中每個值描述物件的一個屬性;若該屬性是可讀寫的,就可以被納入序列化。
反射中最令人頭疼的功能是 Reflection.Emit——它讓你在執行期動態產生一個類別,然後像使用一般類別那樣使用它。
我們用 VB.NET / ASP.NET 做一個小範例:一個類別用來轉成 XML,而且能再轉回來。
新增一個 Visual Basic Web Application 專案,在表單上放一個 textarea 與一個送出按鈕:
<%@ Page Language="vb" AutoEventWireup="false"
Codebehind="WebForm1.vb" Inherits="Serialization.WebForm1"%>
<html><head>
<meta name="GENERATOR" content="Microsoft Visual Studio .Net 7.0">
<meta name="CODE_LANGUAGE" content="Visual Basic 7.0">
</head>
<body>
<form id="WebForm1" method="post" runat="server">
<textarea runat="server" id="XMLarea" cols="60" rows="15"></textarea>
<br>
<input runat="server" type="submit" value="Turn XML into an object!">
</form>
</body></html>
注意 textarea 的 id 設為 XMLarea,這樣才能在程式碼中操作它。我們用它的 Value 屬性讀寫文字內容。
這裡有個 Visual Studio 環境的已知問題:即使 textarea 已經加入頁面,對 XMLarea 的參照偶爾不會自動寫進 WebForm1 類別定義。若缺少這行,就無法使用該欄位。請檢查 WebForm1.vb,確認有:
Public Class WebForm1
Inherits System.Web.UI.Page
Protected WithEvents XMLarea As System.Web.UI.HtmlControls.HtmlTextArea
沒有的話自行補上。
Imports System
Imports System.Collections
Public Class Book
Private m_Name As String
Private m_ISBN As String
Public Property Name() As String
Get
Return m_Name
End Get
Set(ByVal Value As String)
m_Name = Value
End Set
End Property
Public Property ISBN() As String
Get
Return m_ISBN
End Get
Set(ByVal Value As String)
m_ISBN = Value
End Set
End Property
End Class
在 Solution Explorer 中右擊 References,選擇 Add Reference,找到 System.Xml.dll 並加入。接著在 WebForm1.vb 頂端補上:
Imports System.IO Imports System.Xml.Serialization
在輸出表單之前,我們要確保 XMLarea 裡已經有 XML。因此建立一個 Book 實例、設定屬性,再呼叫 XmlSerializer:
Public Sub WebForm1_PreRender(ByVal sender As Object, _
ByVal e As System.EventArgs) Handles WebForm1.PreRender
' 如果還沒有值,就建立一個預設的書
If XMLarea.Value = "" Then
' 建立 Book 實例並設定屬性
Dim MyBook As New Book()
MyBook.Name = "Beginning E-commerce"
MyBook.ISBN = "1861003986"
' StringWriter 代表一個記憶體中的字串緩衝區
Dim writer As New StringWriter()
' 建立序列化器,需要物件的型別
Dim serializer As New XmlSerializer(MyBook.GetType)
serializer.Serialize(writer, MyBook)
' 把結果放進表單
XMLarea.Value = writer.ToString
End If
End Sub
執行後,表單上會出現 Book 物件所對應的 XML:
<?xml version="1.0" encoding="utf-16"?> <Book> <Name>Beginning E-commerce</Name> <ISBN>1861003986</ISBN> </Book>
反序列化的寫法幾乎是鏡像的——把 StringReader 交給同一個 XmlSerializer:
Dim serializer As New XmlSerializer(GetType(Book)) Dim reader As New StringReader(XMLarea.Value) Dim MyBook As Book = CType(serializer.Deserialize(reader), Book) Label1.Text = "書名:" & MyBook.Name & ",ISBN:" & MyBook.ISBN
你可以先在 textarea 中把書名從 Beginning E-commerce 改成 VB .Net Programming,再按送出,就會看到新物件帶著改過的值回來。
作為開發者,第一次看到 XML 序列化時你可能不太自在,因為它感覺像個「雜牌」機制:你無法指定要寫入哪些資訊,一切由 XmlSerializer 依屬性自行決定。
事實上,如果你確實需要精細控制,System.Runtime.Serialization 中的 ISerializable 介面正是為此而設——實作它並不麻煩,只是比起直接用 XmlSerializer 繁瑣得多。
我的結論是:對大多數場景而言,不必擔心缺少控制。XmlSerializer 提供了一條極短的路徑,把物件壓成串流、再從串流還原。若你只需要微調輸出格式,用屬性上的 <XmlElement>、<XmlAttribute>、<XmlIgnore> 等控制項,就能決定某個成員要變成元素、屬性,還是完全略過。
第一,只有公開的可讀寫屬性會被序列化,欄位與唯讀屬性不會。若某個值必須保存但不想暴露成可寫屬性,就得改用其他機制。
第二,被序列化的型別必須有無參數建構子,否則反序列化會失敗。
第三,集合型別需要特別處理。XmlSerializer 對 List(Of T) 與陣列支援良好,但 Dictionary 天生不適合 XML 序列化(XML 沒有對應的鍵值概念),實務上通常得包一層自訂型別。
第四,注意編碼宣告。範例中 StringWriter 產生的 XML 宣告寫著 utf-16,但字串本身在記憶體中已是 UTF-16;若你要把它寫進標示 UTF-8 的檔案或 HTTP 回應,宣告與實際編碼不一致會讓下游解析器出錯。這時應改用自訂的 StringWriter 覆寫 Encoding 屬性,或直接用 XmlWriter 指定編碼輸出。