序列化的attribute,是為了利用序列化的技術
准備用於序列化的對象必須設置 [System.Serializable] 標簽,該標簽指示一個類能夠序列化。
便於在網絡中傳輸和保存
這個標簽是類能夠被序列化的特性,表示這個類能夠被序列化。
什么叫序列化?
我們都知道對象是臨時保存在內存中的,不能用U盤考走了,有時為了使用介質轉移對象,而且把對象的狀態保持下來,就須要把對象保存下來,這個過程就叫做序列化,通俗點,就是把人的魂(對象)收伏成一個石子(可傳輸的介質)
什么叫反序列化?
就是再把介質中的東西還原成對象,把石子還原成人的過程。
在進行這些操作的時候都須要這個能夠被序列化,要能被序列化,就得給類頭加[Serializable]特性。
通常網絡程序為了傳輸安全才這么做。
簡單介紹
序列化是指將對象實例的狀態存儲到存儲媒體的過程。在此過程中,先將對象的公共字段和私有字段以及類的名稱(包含類所在的程序集)轉換為字節流,然后再把字節流寫入數據流。在隨后對對象進行反序列化時,將創建出與原對象全然同樣的副本。
在面向對象的環境中實現序列化機制時,必須在易用性和靈活性之間進行一些權衡。僅僅要您對此過程有足夠的控制能力,就能夠使該過程在非常大程度上自己主動進行。比如,簡單的二進制序列化不能滿足須要,或者,因為特定原因須要確定類中那些字段須要序列化。下面各部分將探討 .NET 框架提供的可靠的序列化機制,並着重介紹使您能夠依據須要自己定義序列化過程的一些重要功能。
持久存儲
我們常常須要將對象的字段值保存到磁盤中,並在以后檢索此數據。雖然不使用序列化也能完畢這項工作,但這樣的方法通常非常繁瑣並且easy出錯,並且在須要跟蹤對象的層次結構時,會變得越來越復雜。能夠想象一下編寫包括大量對象的大型業務應用程序的情形,程序猿不得不為每個對象編寫代碼,以便將字段和屬性保存至磁盤以及從磁盤還原這些字段和屬性。序列化提供了輕松實現這個目標的快捷方法。
公共語言執行時 (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 序列化程序。
將對象還原到它曾經的狀態也很easy。首先,創建格式化程序和流以進行讀取,然后讓格式化程序對對象進行反序列化。下面代碼片段說明了怎樣進行此操作。
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 方法。此時,引用的全部子對象均已全然還原。有些類不使用上述事件偵聽器,非常難對它們進行反序列化,散列表便是一個典型的樣例。在反序列化過程中檢索keyword/值對非常easy,可是,由於無法保證從散列表派生出的類已反序列化,所以把這些對象加入回散列表時會出現一些問題。因此,建議眼下不要在散列表上調用方法。
序列化過程的步驟
在格式化程序上調用 Serialize 方法時,對象序列化依照下面規則進行:
檢查格式化程序是否有代理選取器。假設有,檢查代理選取器是否處理指定類型的對象。假設選取器處理此對象類型,將在代理選取器上調用 ISerializable.GetObjectData。
假設沒有代理選取器或有卻不處理此類型,將檢查是否使用 Serializable 屬性對對象進行標記。假設未標記,將會引發 SerializationException。
假設對象已被正確標記,將檢查對象是否實現了 ISerializable。假設已實現,將在對象上調用 GetObjectData。
假設對象未實現 Serializable,將使用默認的序列化策略,對全部未標記為 NonSerialized 的字段都進行序列化。
版本號控制
.NET 框架支持版本號控制和並排運行,而且,假設類的接口保持一致,全部類均可跨版本號工作。因為序列化涉及的是成員變量而非接口,所以,在向要跨版本號序列化的類中加入成員變量,或從中刪除變量時,應慎重行事。特別是對於未實現 ISerializable 的類更應如此。若當前版本號的狀態發生了不論什么變化(比如加入成員變量、更改變量類型或更改變量名稱),都意味着假設同一類型的現有對象是使用早期版本號進行序列化的,則無法成功對它們進行反序列化。
假設對象的狀態須要在不同版本號間發生改變,類的作者能夠有兩種選擇:
實現 ISerializable。這使您能夠精確地控制序列化和反序列化過程,在反序列化過程中正確地加入和解釋未來狀態。
使用 NonSerialized 屬性標記不重要的成員變量。僅當估計類在不同版本號間的變化較小時,才可使用這個選項。比如,把一個新變量加入至類的較高版本號后,能夠將該變量標記為 NonSerialized,以確保該類與早期版本號保持兼容。
序列化規則
因為類編譯后便無法序列化,所以在設計新類時應考慮序列化。須要考慮的問題有:是否必須跨應用程序域來發送此類?是否要遠程使用此類?用戶將怎樣使用此類?或許他們會從我的類中派生出一個須要序列化的新類。僅僅要有這樣的可能性,就應將類標記為可序列化。除下列情況以外,最好將全部類都標記為可序列化:
全部的類都永遠也不會跨越應用程序域。假設某個類不要求序列化但須要跨越應用程序域,請從 MarshalByRefObject 派生此類。
類存儲僅適用於其當前實例的特殊指針。比如,假設某個類包括非受控的內存或文件句柄,請確保將這些字段標記為 NonSerialized 或根本不序列化此類。
某些數據成員包括敏感信息。在這樣的情況下,建議實現 ISerializable 並僅序列化所要求的字段。