標籤:
建議54:為無用欄位標註不可序列化
序列化是指這樣一種技術:把對象轉變成流。相反過程,我們稱為還原序列化。在很多場合都需要用到這項技術。
- 把對象儲存到本地,在下次運行程式的時候,恢複這個對象。
- 把對象傳到網路中的另外一台終端上,然後在此終端還原這個對象。
- 其他場合,如:把對象賦值到系統的粘貼板中,然後用快速鍵Ctrl+V恢複這個對象。
一下幾個原因,決定了要為無用欄位標註不可序列化:
- 節約了空間。類型在序列化後往往會儲存到某個地方,如資料庫、硬碟或記憶體中,如果一個欄位在還原序列化後不需要保持狀態,那它就不應該被序列化,這會佔用寶貴的空間資源。
- 還原序列化後欄位資訊已經沒有意義了。如Windows核心控制代碼,在還原序列化後往往已經失去了意義,所以它就不應該被序列化。
- 欄位因業務上的原因不允許被序列化。比如,純文字密碼不應該被序列化後一同儲存在檔案中。
- 如果欄位本身所對應的類型在代碼中未被設定成可序列化,那它就該被標註不可序列化,否則運行時會拋出SerializationException異常。
類型被添加Serializable特性後,預設所有的欄位全部都能被序列化。如果部分欄位不需要序列化,可以在該欄位上應用NonSerialized特性。屬性事實上是方法,所以是不能序列化的,自動屬性也是如此。另外,要標識事件為不可序列化,需要用field: NonSerialized文法。
下面是一個序列化工具類:
public class BinarySerializer { //將類型序列化為字串 public static string Serialize<T>(T t) { using (MemoryStream stream = new MemoryStream()) { BinaryFormatter formatter = new BinaryFormatter(); formatter.Serialize(stream, t); return System.Text.Encoding.UTF8.GetString(stream.ToArray()); } } //將類型序列化為檔案 public static void SerializeToFile<T>(T t, string path, string fullName) { if (!Directory.Exists(path)) { Directory.CreateDirectory(path); } string fullPath = Path.Combine(path, fullName); using (FileStream stream = new FileStream(fullPath, FileMode.OpenOrCreate)) { BinaryFormatter formatter = new BinaryFormatter(); formatter.Serialize(stream, t); stream.Flush(); } } //將字串還原序列化為類型 public static TResult Deserialize<TResult>(string s) where TResult : class { byte[] bs = System.Text.Encoding.UTF8.GetBytes(s); using (MemoryStream stream = new MemoryStream(bs)) { BinaryFormatter formatter = new BinaryFormatter(); return formatter.Deserialize(stream) as TResult; } } //將檔案還原序列化為類型 public static TResult DeserializeFromFile<TResult>(string path) where TResult : class { using (FileStream stream = new FileStream(path, FileMode.Open)) { BinaryFormatter formatter = new BinaryFormatter(); return formatter.Deserialize(stream) as TResult; } } }
執行個體代碼:
class Program { static void Main() { Person mike = new Person() { Age = 21, Name = "Mike" }; mike.NameChanged += new EventHandler(mike_NameChanged); BinarySerializer.SerializeToFile(mike, @"c:\", "person.txt"); Person p = BinarySerializer.DeserializeFromFile<Person>(@"c:\person.txt"); p.Name = "Rose"; Console.WriteLine(p.Name); Console.WriteLine(p.Age.ToString()); } static void mike_NameChanged(object sender, EventArgs e) { Console.WriteLine("Name Changed"); } } [Serializable] class Person { private string name; public string Name { get { return name; } set { if (NameChanged != null) { NameChanged(this, null); } name = value; } } public int Age { get; set; } [NonSerialized] private Department department; public Department Department { get { return department; } set { department = value; } } [field: NonSerialized] public event EventHandler NameChanged; }
輸出:
Rose
21
轉自:《編寫高品質代碼改善C#程式的157個建議》陸敏技
編寫高品質代碼改善C#程式的157個建議——建議54:為無用欄位標註不可序列化