.NET 中的對象序列化

.Net 中的對象序列化

作者：PIEt Obermeyer　文章來源：microsoft

簡介

　序列化是指將對象實例的狀態存儲到存儲媒體的過程。在此過程中，先將對象的公共字段和私有字段以及類的名稱（包括類所在的程序集）轉換為字節流，然後再把字節流寫入數據流。在隨後對對象進行反序列化時，將創建出與原對象完全相同的副本。

在面向對象的環境中實現序列化機制時，必須在易用性和靈活性之間進行一些權衡。只要您對此過程有足夠的控制能力，就可以使該過程在很大程度上自動進行。例如，簡單的二進制序列化不能滿足需要，或者，由於特定原因需要確定類中那些字段需要序列化。以下各部分將探討 .Net 框架提供的可靠的序列化機制，並著重介紹使您可以根據需要自定義序列化過程的一些重要功能。

持久存儲

　我們經常需要將對象的字段值保存到磁盤中，並在以後檢索此數據。盡管不使用序列化也能完成這項工作，但這種方法通常很繁瑣而且容易出錯，並且在需要跟蹤對象的層次結構時，會變得越來越復雜。可以想象一下編寫包含大量對象的大型業務應用程序的情形，程序員不得不為每一個對象編寫代碼，以便將字段和屬性保存至磁盤以及從磁盤還原這些字段和屬性。序列化提供了輕松實現這個目標的快捷方法。

公共語言運行時 (CLR) 管理對象在內存中的分布，.Net 框架則通過使用反射提供自動的序列化機制。對象序列化後，類的名稱、程序集以及類實例的所有數據成員均被寫入存儲媒體中。對象通常用成員變量來存儲對其他實例的引用。類序列化後，序列化引擎將跟蹤所有已序列化的引用對象，以確保同一對象不被序列化多次。.Net 框架所提供的序列化體系結構可以自動正確處理對象圖表和循環引用。對對象圖表的唯一要求是，由正在進行序列化的對象所引用的所有對象都必須標記為 Serializable（請參閱基本序列化）。否則，當序列化程序試圖序列化未標記的對象時將會出現異常。

當反序列化已序列化的類時，將重新創建該類，並自動還原所有數據成員的值。

按值封送

　對象僅在創建對象的應用程序域中有效。除非對象是從 MarshalByRefObject 派生得到或標記為 Serializable，否則，任何將對象作為參數傳遞或將其作為結果返回的嘗試都將失敗。如果對象標記為 Serializable，則該對象將被自動序列化，並從一個應用程序域傳輸至另一個應用程序域，然後進行反序列化，從而在第二個應用程序域中產生出該對象的一個精確副本。此過程通常稱為按值封送。

如果對象是從 MarshalByRefObject 派生得到，則從一個應用程序域傳遞至另一個應用程序域的是對象引用，而不是對象本身。也可以將從 MarshalByRefObject 派生得到的對象標記為 Serializable。遠程使用此對象時，負責進行序列化並已預先配置為 SurrogateSelector 的格式化程序將控制序列化過程，並用一個代理替換所有從 MarshalByRefObject 派生得到的對象。如果沒有預先配置為 SurrogateSelector，序列化體系結構將遵從下面的標准序列化規則（請參閱序列化過程的步驟）。

基本序列化

　要使一個類可序列化，最簡單的方法是使用 Serializable 屬性對它進行標記，如下所示：

[Serializable]
public class MyObject {
public int n1 = 0;
public int n2 = 0;
public String str = null;
}

以下代碼片段說明了如何將此類的一個實例序列化為一個文件：

MyObject obj = new MyObject();
obj.n1 = 1;
obj.n2 = 24;
obj.str = "一些字符串";
IFormatter formatter = new BinaryFormatter();
Stream stream = new FileStream("MyFile.bin", FileMode.Create,
FileAccess.Write, FileShare.None);
formatter.Serialize(stream, obj);
stream.Close();

本例使用二進制格式化程序進行序列化。您只需創建一個要使用的流和格式化程序的實例，然後調用格式化程序的 Serialize 方法。流和要序列化的對象實例作為參數提供給此調用類中的所有成員變量（甚至標記為 private 的變量）都將被序列化，但這一點在本例中未明確體現出來。在這一點上，二進制序列化不同於只序列化公共字段的 XML 序列化程序。

將對象還原到它以前的狀態也非常容易。首先，創建格式化程序和流以進行讀取，然後讓格式化程序對對象進行反序列化。以下代碼片段說明了如何進行此操作。

IFormatter formatter = new BinaryFormatter();
Stream stream = new FileStream("MyFile.bin", FileMode.Open,
FileAccess.Read, FileShare.Read);
MyObject obj = (MyObject) formatter.Deserialize(fromStream);
stream.Close();
// 下面是證明
Console.WriteLine("n1: {0}", obj.n1);
Console.WriteLine("n2: {0}", obj.n2);
Console.WriteLine("str: {0}", obj.str);

上面所使用的 BinaryFormatter 效率很高，能生成非常緊湊的字節流。所有使用此格式化程序序列化的對象也可使用它進行反序列化，對於序列化將在 .Net 平台上進行反序列化的對象，此格式化程序無疑是一個理想工具。需要注意的是，對對象進行反序列化時並不調用構造函數。對反序列化添加這項約束，是出於性能方面的考慮。但是，這違反了對象編寫者通常采用的一些運行時約定，因此，開發人員在將對象標記為可序列化時，應確保考慮了這一特殊約定。

如果要求具有可移植性，請使用 SoapFormatter。所要做的更改只是將以上代碼中的格式化程序換成 SoapFormatter，而 Serialize 和 Deserialize 調用不變。對於上面使用的示例，該格式化程序將生成以下結果。

<SOAP-ENV:Envelope
xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:SOAP- ENC=http://schemas.XMLsoap.org/soap/encoding/
xmlns:SOAP- ENV=http://schemas.XMLsoap.org/soap/envelope/
SOAP-ENV:encodingStyle=
"http://schemas.microsoft.com/soap/encoding/clr/1.0
http://schemas.XMLsoap.org/soap/encoding/"
XMLns:a1="http://schemas.microsoft.com/clr/assem/ToFile">

<SOAP-ENV:Body>
<a1:MyObject id="ref-1">
<n1>1</n1>
<n2>24</n2>
<str id="ref-3">一些字符串</str>
</a1:MyObject>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

需要注意的是，無法繼承 Serializable 屬性。如果從 MyObject 派生出一個新的類，則這個新的類也必須使用該屬性進行標記，否則將無法序列化。例如，如果試圖序列化以下類實例，將會顯示一個 SerializationException，說明 MyStuff 類型未標記為可序列化。

public class MyStuff : MyObject
{
public int n3;
}

public class MyStuff : MyObject
{
public int n3;
}

使用序列化屬性非常方便，但是它存在上述的一些限制。有關何時標記類以進行序列化（因為類編譯後就無法再序列化），請參考有關說明（請參閱下面的序列化規則）。

選擇性序列化
類通常包含不應被序列化的字段。例如，假設某個類用一個成員變量來存儲線程 ID。當此類被反序列化時，序列化此類時所存儲的 ID 對應的線程可能不再運行，所以對這個值進行序列化沒有意義。可以通過使用 NonSerialized 屬性標記成員變量來防止它們被序列化，如下所示：[Serializable]
public class MyObject
{
public int n1;
[NonSerialized] public int n2;
public String str;
}

自定義序列化
　可以通過在對象上實現 ISerializable 接口來自定義序列化過程。這一功能在反序列化後成員變量的值失效時尤其有用，但是需要為變量提供值以重建對象的完整狀態。要實現 ISerializable，需要實現 GetObjectData 方法以及一個特殊的構造函數，在反序列化對象時要用到此構造函數。以下代碼示例說明了如何在前一部分中提到的 MyObject 類上實現 ISerializable。

[Serializable]
public class MyObject : ISerializable
{
public int n1;
public int n2;
public String str;

public MyObject()
{
}

protected MyObject(SerializationInfo info, StreamingContext context)
{
n1 = info.GetInt32("i");
n2 = info.GetInt32("j");
str = info.GetString("k");
}

public virtual void GetObjectData(SerializationInfo info,
StreamingContext context)
{
info.AddValue("i", n1);
info.AddValue("j", n2);
info.AddValue("k", str);
}
}

在序列化過程中調用 GetObjectData 時，需要填充方法調用中提供的 SerializationInfo 對象。只需按名稱/值對的形式添加將要序列化的變量。其名稱可以是任何文本。只要已序列化的數據足以在反序列化過程中還原對象，便可以自由選擇添加至 SerializationInfo 的成員變量。如果基對象實現了 ISerializable，則派生類應調用其基對象的 GetObjectData 方法。

需要強調的是，將 ISerializable 添加至某個類時，需要同時實現 GetObjectData 以及特殊的構造函數。如果缺少 GetObjectData，編譯器將發出警告。但是，由於無法強制實現構造函數，所以，缺少構造函數時不會發出警告。如果在沒有構造函數的情況下嘗試反序列化某個類，將會出現異常。在消除潛在安全性和版本控制問題等方面，當前設計優於 SetObjectData 方法。例如，如果將 SetObjectData 方法定義為某個接口的一部分，則此方法必須是公共方法，這使得用戶不得不編寫代碼來防止多次調用 SetObjectData 方法。可以想象，如果某個對象正在執行某些操作，而某個惡意應用程序卻調用此對象的 SetObjectData 方法，將會引起一些潛在的麻煩。

在反序列化過程中，使用出於此目的而提供的構造函數將 SerializationInfo 傳遞給類。對象反序列化時，對構造函數的任何可見性約束都將被忽略，因此，可以將類標記為 public、protected、internal 或 private。一個不錯的辦法是，在類未封裝的情況下，將構造函數標記為 protect。如果類已封裝，則應標記為 private。要還原對象的狀態，只需使用序列化時采用的名稱，從 SerializationInfo 中檢索變量的值。如果基類實現了 ISerializable，則應調用基類的構造函數，以使基礎對象可以還原其變量。

如果從實現了 ISerializable 的類派生出一個新的類，則只要新的類中含有任何需要序列化的變量，就必須同時實現構造函數以及 GetObjectData 方法。以下代碼片段顯示了如何使用上文所示的 MyObject 類來完成此操作。

[Serializable]
public class ObjectTwo : MyObject
{
public int num;

public ObjectTwo(