微軟很清楚序列化(Serialization)的重要性,因此 .NET Framework 內建了 System.Runtime.Serialization 與 System.Xml.Serialization 兩個命名空間,讓開發者不必從零打造序列化機制。本文聚焦後者,說明如何把物件的公開欄位與屬性存成 XML,以及如何反向還原。
序列化是把物件的公開狀態寫成某種可保存、可傳輸的格式;反序列化則是拿這份狀態資訊把物件還原回來。你可以把它想成「把物件狀態存進流或緩衝區」的過程。
目的主要有兩個。一是資料保存:應用關閉時把狀態寫出去,使用者下次回來時再讀回來。二是資料交換:把資料轉成另一個系統認得的格式。有了序列化加上 XML,跨系統交換資料會輕鬆許多。
可被序列化的內容相當廣泛,包含類別、方法、屬性、私有型別與陣列;在 System.Xml.XmlElement 或 System.Xml.XmlAttribute 裡,甚至可以是內嵌的 XML。
這個命名空間裡當然還有 XML 與 SOAP 相關的其他類別,但主角是 XmlSerializer。它負責物件與 XML 之間的雙向轉換,也讓你能控制物件如何映射成 XML。被序列化的型別透過建構子傳入:
XmlSerializer ser = new XmlSerializer(typeof(objectToSerialize));
VB.NET 的等價寫法:
Dim ser As New XmlSerializer(GetType(objectToSerialize))
真正的序列化發生在 Serialize 方法,它接受 TextWriter、Stream 或 XmlWriter,因此輸出目標可以是檔案、記憶體或其他任何寫入端。
先定義三個類別:
using System;
namespace BuilderSerialization {
public class Address {
public Address() {}
public string Address1;
public string Address2;
public string City;
public string State;
public string Zip;
public string Country;
}
}
namespace BuilderSerialization {
public class Author {
public Author() { }
public string FirstName;
public string MiddleName;
public string LastName;
public string Title;
public string Gender;
public Address AddressObject;
}
}
namespace BuilderSerialization {
public class Book {
public Book() { }
public string Title;
public Author AuthorObject;
public string ISBN;
public double RetailPrice;
public string Publisher;
}
}
接著組裝物件並寫檔:
using System;
using System.Xml.Serialization;
using System.IO;
namespace BuilderSerialization {
class TestClass {
static void Main(string[] args) {
Book BookObject = new Book();
XmlSerializer ser = new XmlSerializer(typeof(Book));
TextWriter writer = new StreamWriter("booktest.XML");
BookObject.Title = "Practical LotusScript";
BookObject.ISBN = "1884777767 ";
BookObject.Publisher = "Manning Publications";
BookObject.RetailPrice = 43.95;
BookObject.AuthorObject = new Author();
BookObject.AuthorObject.FirstName = "Tony";
BookObject.AuthorObject.LastName = "Patton";
BookObject.AuthorObject.Gender = "Male";
BookObject.AuthorObject.AddressObject = new Address();
BookObject.AuthorObject.AddressObject.Address1 = "1 Main Street";
BookObject.AuthorObject.AddressObject.City = "Anywhere";
BookObject.AuthorObject.AddressObject.State = "KY";
BookObject.AuthorObject.AddressObject.Zip = "40000";
BookObject.AuthorObject.AddressObject.Country = "USA";
ser.Serialize(writer, BookObject);
writer.Close();
}
}
}
三個物件被合成一份文件,輸出如下:
<?xml version="1.0" encoding="utf-8"?>
<Book xmlns:xsd="https://www.w3.org/2001/XMLSchema"
xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<Title>Practical LotusScript</Title>
<AuthorObject>
<FirstName>Tony</FirstName>
<LastName>Patton</LastName>
<Gender>Male</Gender>
<AddressObject>
<Address1>1 Main Street</Address1>
<City>Anywhere</City>
<State>KY</State>
<Zip>40000</Zip>
<Country>USA</Country>
</AddressObject>
</AuthorObject>
<ISBN>1884777767 </ISBN>
<RetailPrice>43.95</RetailPrice>
<Publisher>Manning Publications</Publisher>
</Book>
注意嵌套的物件結構被完整保留了下來。資料轉成通用格式後,無論是要重新載入還是丟給另一個系統,都方便得多。若接收端事先不知道格式,就該附上一份 XML Schema;.NET Framework 的 XSD.exe 可以直接為序列化的 XML 產生 schema。
VB.NET 版本的核心程式碼:
Public Class Book
Public AuthorObject As Author
Public Title As String
Public ISBN As String
Public RetailPrice As Double
Public Publisher As String
End Class
Imports System.Xml.Serialization
Imports System.IO
Module Module1
Sub Main()
Dim BookObject As New Book
Dim ser As New XmlSerializer(GetType(Book))
Dim writer As New StreamWriter("booktest.XML")
With BookObject
.Title = "Practical LotusScript"
.ISBN = "1884777767 "
.Publisher = "Manning Publications"
.RetailPrice = 43.95
.AuthorObject = New Author
.AuthorObject.FirstName = "Tony"
.AuthorObject.LastName = "Patton"
.AuthorObject.Gender = "Male"
.AuthorObject.AddressObject = New Address
.AuthorObject.AddressObject.Address1 = "1 Main Street"
.AuthorObject.AddressObject.City = "Anywhere"
.AuthorObject.AddressObject.State = "KY"
.AuthorObject.AddressObject.Zip = "40000"
.AuthorObject.AddressObject.Country = "USA"
End With
ser.Serialize(writer, BookObject)
writer.Close()
End Sub
End Module
預設行為是把每個資料成員都變成元素,但可以透過標記(Attribute)改變這件事:讓成員變成 XML 屬性,或直接略過。
Public Class Book Public AuthorObject As Author Public Title As String <System.Xml.Serialization.XmlAttribute()> _ Public ISBN As String <System.Xml.Serialization.XmlIgnoreAttribute()> _ Public RetailPrice As Double Public Publisher As String End Class
這段程式碼要求把 ISBN 輸出成屬性、完全略過 RetailPrice,結果如下:
<Book xmlns:xsd="https://www.w3.org/2001/XMLSchema"
xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
ISBN="1884777767 ">
<AuthorObject>...</AuthorObject>
<Title>Practical LotusScript</Title>
<Publisher>Manning Publications</Publisher>
</Book>
C# 寫法只是在成員前加上對應的方括號標記:
[System.Xml.Serialization.XmlAttribute()] public string ISBN; [System.Xml.Serialization.XmlIgnoreAttribute()] public double RetailPrice;
以上只是兩種最常見的標記,完整清單請查閱 .NET 文件。
還原物件只要呼叫 Deserialize:
Dim BookObject As New Book
Dim ser As New XmlSerializer(GetType(Book))
Dim fs As New System.IO.FileStream("booktest.XML", FileMode.Open)
Dim reader As New System.Xml.XmlTextReader(fs)
BookObject = CType(ser.Deserialize(reader), Book)
等價的 C# 程式碼:
XmlSerializer ser = new XmlSerializer(typeof(Book));
System.IO.FileStream fs = new System.IO.FileStream("booktest.XML", FileMode.Open);
System.Xml.XmlTextReader reader = new System.Xml.XmlTextReader(fs);
Book BookObject = (Book)(ser.Deserialize(reader));
作者:Tony Patton,專業應用程式開發者,持有 Java、VB、Lotus 與 XML 認證。