雖然我們平時都使用第三方庫來進行序列化和反序列化,用起來也很方便,但至少得明白序列化與反序列化的基本原理。 懂得人就別看了! 註意:從.NET Framework 2.0 開始,序列化格式化器類SoapFormatter已過時。請改用 BinaryFormatter。 序列化:把目標對象轉換為位元組流 ...
雖然我們平時都使用第三方庫來進行序列化和反序列化,用起來也很方便,但至少得明白序列化與反序列化的基本原理。
懂得人就別看了!
註意:從.NET Framework 2.0 開始,序列化格式化器類SoapFormatter已過時。請改用 BinaryFormatter。
- 序列化:把目標對象轉換為位元組流的過程
- 反序列化:把位元組流轉換回對象的過程
序列化與反序列化需要一個序列化器類:即System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
類
實例化一個格式化器BinaryFormatter類:BinaryFormatter binaryFormatter = new BinaryFormatter();
一、序列化:
binaryFormatter.Serialize(Stream stream, Object obj);
- 該方法把一個或多個目標對象序列化為位元組流並保存到目標流對象stream中。需要提供一個目標流對象stream(stream對象可以是基類Stream的派生類:
FileStream、MemoryStream、NetWorkStream
等流對象);
序列化過程:
- 序列化時,首先判斷每個對象的類型定義是否應用了可序列化
[Serializable]
特性,否則拋出異常。 - 其次調用對象中那些被標記了
[OnSerializing]
特性的所有方法。(即:執行序列化前,先調用該方法做一些事情) - 接下來,利用反射機制來取得每個目標對象的類型中所有需要序列化的實例欄位的信息,並讀取對應欄位的值保存到位元組流中。
- 序列化時,還保存了目標類型的全名、定義類型程式集的全名,作為標識信息保存到流中(用於反序列化)。
- 最後,調用所有被標記了
[OnSerialized]
特性的方法。(即:序列化完成後,調用該方法做一些事情)
二、反序列化:
SomeObject obj = (SomeObject)binaryFormatter.Deserialize(Stream stream);
- 該方法把目標流對象stream中的位元組流反序列化為Object對象,可根據需求進行轉型為對應的目標對象
反序列化過程:
- 反序列化時,首先從位元組流中讀取程式集的標識信息,然後調用
System.Reflection.Assembly
類的Load()
方法載入該程式集到當前的AppDomain
中,只有當程式集載入成功後,格式化器才能在程式集中查找是否存在與需要被反序列化的對象的類型信息相同的類型 - 找到類型後,調用對象中那些被標記了
[OnDeserializing]
特性的所有方法 - 接下來利用該類型創建實例
- 然後從位元組流中獲取對應欄位的值對該實例進行初始化。
- 最後,調用所有被標記了
[OnDeserialized]
特性的方法。
此過程中若找不到匹配的類型,則會拋出異常終止反序列化。但是,我在利用第三方類庫反序列化JSON文件時,JSON文件並不存在對象名和程式集名的標識信息,第三方類庫的格式化器應該是根據各個對象的成員名稱、類型,在當前AppDomain
中的所有程式集中進行查找匹配的類型。
註意:
- 最好把序列化或反序列化的過程放進try塊中,用catch (SerializationException e)塊處理需要處理的異常,併在finally塊中釋放資源(關閉流)。
- 可以把流的定義放在using語句的“()”中,把序列化反序列化代碼放在using塊內,來達到自動釋放資源的目的。
三、序列化配置
在執行序列化和反序列化之前,可以對格式化器的Context
屬性進行設置,Context
屬性是一個StreamingContext
結構
binaryFormatter.Context = new StreamingContext(StreamingContextStates.Remoting);
//指定為來源和目的地是遠程的
StreamingContext
結構的屬性有兩個:
State
屬性,是一個枚舉類型StreamingContextStates
的值,用來說明序列化和反序列化的對象的來源和目的地Context
屬性,一個上下文對象的引用,包含了用戶希望得到的任何上下文信息
StreamingContext
結構存在的意義就是通過State
屬性的值描述給定的序列化流的源和目標,並利用Context
屬性提供一個由調用方定義的附加上下文。
(因為同一個被序列化好的對象可能會有不同的目的地,如不同機器,不同進程中等,我們就可以通過State屬性的狀態來標識對象的目的地)
示例:利用序列化和反序列化,定義一個深度克隆一個對象的方法
public object DeepCloneObject(object oldObj)
{
try
{
using (MemoryStream stream = new MemoryStream())
{
BinaryFormatter bf = new BinaryFormatter();
bf.Context = new StreamingContext(StreamingContextStates.Clone);
//把對象序列化到流中
bf.Serialize(stream, oldObj);
//在進行反序列化前,需要先定位到記憶體流的起始位置
stream.Position = 0;
//將記憶體流中的內容反序列化成新的對象
return bf.Deserialize(stream);
}
}
catch(SerializationException e)
{
Console.WriteLine("序列化和反序列化時出錯了,錯誤信息為:" + e.Message);
//不做處理,重新拋出原異常對象
throw;
}
finally
{
//using中的stream對象會被自動釋放,這裡不要對它處理
}
}
四、如果有些類型的成員無法進行序列化或反序列化,則可以為該類型實現介面ISerializationCallbackReceiver
,該介面定義了兩個方法:
比如在Unity3d中,無法序列化枚舉類型的成員,就需要把他標記為[NonSerialized]
不對他處理,然後定義一個該成員的字元串形式的成員,通過該字元串和對應枚舉類型的轉換,就可以達到序列化的目的了。如下代碼:
public enum ItemType
{
left,
right
}
public class ScoreModel:ISerializationCallbackReceiver
{
public int Score { get; set; }
[NonSerialized]
public ItemType itemType;
public string itemTypeString;
//反序列化完成自動後調用
public void OnAfterDeserialize()
{
itemType = (ItemType)Enum.Parse(typeof(ItemType), itemTypeString);
}
//進行序列化之前自動調用
public void OnBeforeSerialize()
{
itemTypeString = itemType.ToString();
}
}
五、關於序列化為派生類類型的情況
即使是第三方類庫,可能也無法處理這種情況,比如:從JSON中反序列化後得到的對象的成員是一個基類類型的,如果直接把該成員強轉為我們實際需要的子類類型,正常情況下是不行的,這時就需要自定義一些方法來實現了,利用協變在序列化過程中返回子類類型的對象給基類類型,這樣得到的基類類型就可以強轉為子類類型了。具體實現代碼,大家可以搜起來!