[Serializable]在C#中的作用-NET 中的對象序列化

簡介
序列化是指將對象執行個體的狀態儲存到儲存媒體的過程。在此過程中，先將對象的公用欄位和私人欄位以及類的名稱（包括類所在的程式集）轉換為位元組流，然後再把位元組流寫入資料流。在隨後對對象進行還原序列化時，將建立出與原對象完全相同的副本。

在物件導向的環境中實現序列化機制時，必須在易用性和靈活性之間進行一些權衡。只要您對此過程有足夠的控制能力，就可以使該過程在很大程度上自動進行。例如，簡單的二進位序列化不能滿足需要，或者，由於特定原因需要確定類中那些欄位需要序列化。以下各部分將探討 .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;
}
使用序列化屬性非常方便，但是它存在上述的一些限制。有關何時標記類以進行序列化（因為類編譯後就無法再序列化），請參考有關說明（請參閱下面的序列化規則）。

選擇性序列化
類通常包含不應被序列化的欄位。例如，假設某個類用一個成員變數來儲存線程 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() : base()
   {
   }

   protected ObjectTwo(SerializationInfo si, StreamingContext context) :
base(si,context)
   {
     num = si.GetInt32("num");
   }

   public override void GetObjectData(SerializationInfo si,
StreamingContext context)
   {
     base.GetObjectData(si,context);
     si.AddValue("num", num);
   }
}
切記要在還原序列化建構函式中調用基類，否則，將永遠不會調用基類上的建構函式，並且在還原序列化後也無法構建完整的對象。

對象被徹底重新構建，但是在反系列化過程中調用方法可能會帶來不良的副作用,因為被調用的方法可能引用了在調用時尚未還原序列化的對象引用。如果進行中還原序列化的類實現了 IDeserializationCallback，則還原序列化整個對象圖表後，將自動調用 OnSerialization 方法。此時，引用的所有子物件均已完全還原。有些類不使用上述事件接聽程式，很難對它們進行還原序列化，散列表便是一個典型的例子。在還原序列化過程中檢索關鍵字/值對非常容易，但是，由於無法保證從散列表派生出的類已還原序列化，所以把這些對象添加回散列表時會出現一些問題。因此，建議目前不要在散列表上調用方法。

序列化過程的步驟
在格式化程式上調用 Serialize 方法時，對象序列化按照以下規則進行：

檢查格式化程式是否有代理選取器。如果有，檢查代理選取器是否處理指定類型的對象。如果選取器處理此物件類型，將在代理選取器上調用 ISerializable.GetObjectData。
如果沒有代理選取器或有卻不處理此類型，將檢查是否使用 Serializable 屬性對對象進行標記。如果未標記，將會引發 SerializationException。
如果對象已被正確標記，將檢查對象是否實現了 ISerializable。如果已實現，將在對象上調用 GetObjectData。
如果對象未實現 Serializable，將使用預設的序列化策略，對所有未標記為 NonSerialized 的欄位都進行序列化。
版本控制
.NET 架構支援版本控制和並排執行，並且，如果類的介面保持一致，所有類均可跨版本工作。由於序列化涉及的是成員變數而非介面，所以，在向要跨版本序列化的類中新增成員變數，或從中刪除變數時，應謹慎行事。特別是對於未實現 ISerializable 的類更應如此。若目前的版本的狀態發生了任何變化（例如新增成員變數、更改變數類型或更改變數名稱），都意味著如果同一類型的現有對象是使用早期版本進行序列化的，則無法成功對它們進行還原序列化。

如果對象的狀態需要在不同版本間發生改變，類的作者可以有兩種選擇：

實現 ISerializable。這使您可以精確地控制序列化和還原序列化過程，在還原序列化過程中正確地添加和解釋未來狀態。
使用 NonSerialized 屬性標記不重要的成員變數。僅當預計類在不同版本間的變化較小時，才可使用這個選項。例如，把一個新變數添加至類的較高版本後，可以將該變數標記為 NonSerialized，以確保該類與早期版本保持相容。
序列化規則
由於類編譯後便無法序列化，所以在設計新類時應考慮序列化。需要考慮的問題有：是否必須跨應用程式定義域來發送此類？是否要遠程使用此類？使用者將如何使用此類？也許他們會從我的類中派生出一個需要序列化的新類。只要有這種可能性，就應將類標記為可序列化。除下列情況以外，最好將所有類都標記為可序列化：

所有的類都永遠也不會跨越應用程式定義域。如果某個類不要求序列化但需要跨越應用程式定義域，請從 MarshalByRefObject 派生此類。
類儲存僅適用於其當前執行個體的特殊指標。例如，如果某個類包含非受控的記憶體或檔案控制代碼，請確保將這些欄位標記為 NonSerialized 或根本不序列化此類。
某些資料成員包含敏感資訊。在這種情況下，建議實現 ISerializable 並僅序列化所要求的欄位。