C#中Serializable序列化實例

  • 2019 年 12 月 2 日
  • 筆記

版權聲明:本文為部落客原創文章,遵循 CC 4.0 BY-SA 版權協議,轉載請附上原文出處鏈接和本聲明。

本文鏈接:https://blog.csdn.net/CJB_King/article/details/78772064

序列化就是是將對象轉換為容易傳輸的格式的過程,一般情況下轉化打流文件,放入記憶體或者IO文件 中。例如,可以序列化一個對象,然後使用 HTTP 通過 Internet 在客戶端和伺服器之間傳輸該對象,或者和其它應用程式共享使用。反之,反序列化根據流重新構造對象。

一、幾種序列化技術

1)二進位序列化保持類型保真度,這對於在應用程式的不同調用之間保留對象的狀態很有用。例如,通過將對象序列化到剪貼板,可在不同的應用程式之間共享對象。您可以將對象序列化到流、磁碟、記憶體和網路等等。遠程處理使用序列化「通過值」在電腦或應用程式域之間傳遞對象。

2)XML 序列化僅序列化公共屬性和欄位,且不保持類型保真度。當您要提供或使用數據而不限制使用該數據的應用程式時,這一點是很有用的。由於 XML 是一個開放式標準,因此,對於通過 Web 共享數據而言,這是一個很好的選擇。SOAP 同樣是一個開放式標準,這使它也成為一個頗具吸引力的選擇。

3)使用提供的數據協定,將類型實例序列化和反序列化為 XML 流或文檔(或者JSON格式)。常應用於WCF通訊。

二、序列化分類

1、基本序列化

要使一個類可序列化,最簡單的方法是使用 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();

上面實例的反序列化

程式碼如下:

IFormatter formatter = new BinaryFormatter();  Stream stream = new FileStream("MyFile。bin", FileMode.Open,  FileAccess.Read, FileShare.Read);  MyObject obj = (MyObject) formatter.Deserialize(fromStream);  stream.Close();

如果要求具有可移植性,請使用 SoapFormatter。所要做的更改只是將以上程式碼中的格式化程式換成 SoapFormatter,而 Serialize 和 Deserialize 調用不變。

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

2、選擇性序列化

類通常包含不應被序列化的欄位。例如,假設某個類用一個成員變數來存儲執行緒 ID。當此類被反序列化時,序列化此類時所存儲的 ID 對應的執行緒可能不再運行,所以對這個值進行序列化沒有意義。可以通過使用 NonSerialized 屬性標記成員變數來防止它們被序列化,如下所示:

程式碼如下:

[Serializable]  public class MyObject  {     public int n1;     [NonSerialized]     public int n2;     public String str;  }

3、自定義序列化

可以通過在對象上實現 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);     }  }

切記要在反序列化構造函數中調用基類,否則,將永遠不會調用基類上的構造函數,並且在反序列化後也無法構建完整的對象。 在反序列化過程中檢索關鍵字/值對非常容易,但是,由於無法保證從散列表派生出的類已反序列化,所以把這些對象添加回散列表時會出現一些問題。因此,建議目前不要在散列表上調用方法。

三、如果對象的狀態需要在不同版本間發生改變的方法

1、實現 ISerializable。這使您可以精確地控制序列化和反序列化過程,在反序列化過程中正確地添加和解釋未來狀態。

2、使用 NonSerialized 屬性標記不重要的成員變數。僅當預計類在不同版本間的變化較小時,才可使用這個選項。例如,把一個新變數添加至類的較高版本後,可以將該變數標記為 NonSerialized,以確保該類與早期版本保持兼容。