.Net组件程序设计之序列化

自动序列化

本篇给大家讲解一下在.NET中的序列化,它的用处非常之多,特别是对于某种环境下保存某种状态是很好的方法,接下来就来看一下吧。

Serializable属性

     [Serializable]
     public class SerializableCase
 
     {
 
         public SerializableCase() { }
 
         private string _State;
 
         public string State
 
         {
 
             get { return _State; }
 
             set { _State = value; }
 
         }
 
     }

在上面的示例类型上加上Serializable属性这样将示例类型标记为可序列化类型.

格式化序列化器

二进制格式器

     public class MySerializableCase
     {
         public static void BinaryFormatterSerialize()
         {
             IFormatter formatter = new BinaryFormatter();
             Stream stream = new FileStream("jin.glory", FileMode.Create, FileAccess.ReadWrite);
             using (stream)
             {
                 SerializableCase serCase = new SerializableCase();
                 serCase.State = "Test";
                 formatter.Serialize(stream, serCase);
             }
         }
 
         public static void BinaryFormatterDesSerialize()
         {
             Stream stream = new FileStream("jin.glory", FileMode.Open, FileAccess.Read);
             IFormatter formatter = new BinaryFormatter();
             using (stream)
             {
                 SerializableCase serCase = formatter.Deserialize(stream) as SerializableCase;
                 return serCase.State;
             }
         }
     }

BinaryFormattSerialize()方法里只是实例化SerializableCase类型,然后对State属性赋值,代表一个状态。调用 MySerializableCase.BinaryFormattSerialize()后.NET把序列化好的文件流保存到了jin.glory文件中.

图1

文件的名称和后缀格式都是自己随便定义的。然后再调用反序列化,获取到之前序列化的对象状态。

   string state = MySerializableCase.BinaryFormattDesSerialize();
   Console.WriteLine(state);

图2

SOAP格式器

SoapFormatter是在命名空间System.Runtime.Serialization.Formatters.Soap下的(在System.Runtime.Serialization.Formatters.Soap.dll中)

 public class MySerializableCase
     {
         public static void SoapFormatterSerialize()
         {
             IFormatter formatter = new SoapFormatter();
             Stream stream = new FileStream("Soap.xml", FileMode.Create, FileAccess.ReadWrite);
             using (stream)
             {
                 SerializableCase serCase = new SerializableCase();
                 serCase.State = "Test";
                 formatter.Serialize(stream, serCase);
             }
         }
 
         public static string SoapFormatterDesSerialize()
         {
             Stream stream = new FileStream("Soap.xml", FileMode.Open, FileAccess.Read);
             IFormatter formatter = new SoapFormatter();
             using (stream)
             {
                 SerializableCase serCase = formatter.Deserialize(stream) as SerializableCase;
                 return serCase.State;
             }
         }
     }

和上面的二进制格式化器使用的方式近乎相同,唯一不同的是,使用Soap格式化器生成的序列化文件耗时更长,占用空间也比较大,但是它是遵循着SOAP协议的,这在跨平台操作数据间是很有用的,平台只需要解析重建就能把对象重新的生成出来。

不可序列化成员

     [Serializable]
     public class SerializableCase
     {
         public SerializableCase() { }
 
         private string _State;
 
         public string State
         {
             get { return _State; }
             set { _State = value; }
         }
 
         [NonSerialized]
         private DonotSerializable _DonotSerializable;
 
         public DonotSerializable DonotSerializable
         {
             get { return _DonotSerializable; }
             set { _DonotSerializable = value; }
         }
     }
     public class DonotSerializable
     {
         public DonotSerializable() { }
 
         public string DonotSerializableData
         {
             get;
             set;
         }
     }

修改了一下第一段的示例代码,增加了个属性,并且设置其字段为NonSerialized,这样在.NET序列化这个类的实例的时候,检测到了[NonSerialized]的时候就会跳过它,因为有的对象确实是不适合序列化来进行持久化的,不过这样的做的也会有个问题,就是对象的状态丢失,就是不可序列化的部分会丢失。看一下下面的代码:

     public class MySerializableCase
     {
         public static void BinaryFormatterSerialize()
         {
             IFormatter formatter = new BinaryFormatter();
             Stream stream = new FileStream("jin.glory", FileMode.Create, FileAccess.ReadWrite);
             using (stream)
             {
                 SerializableCase serCase = new SerializableCase();
                 serCase.State = "Test";
                 serCase.DonotSerializable = new DonotSerializable();
                 serCase.DonotSerializable.DonotSerializableData = "DonotSerializableData";
                 formatter.Serialize(stream, serCase);
             }
         }
 
         public static string BinaryFormatterDesSerialize()
         {
             Stream stream = new FileStream("jin.glory", FileMode.Open, FileAccess.Read);
             IFormatter formatter = new BinaryFormatter();
             using (stream)
             {
                 SerializableCase serCase = formatter.Deserialize(stream) as SerializableCase;
                 return serCase.State+"_"+serCase.DonotSerializable.DonotSerializableData;
             }
         }
      }

修改了上面的二进制格式器的代码,调用一下测试代码我们一起来看下结果:

 MySerializableCase.BinaryFormatterSerialize();
 string state = MySerializableCase.BinaryFormatterDesSerialize();
 Console.WriteLine(state);

图3

在反序列化的时候,对象SerializableCase的DonotSerializable属性丢失了,所以才会报错。 对于这样的情况,.NET提供了IDeserializationCallback接口,它里面只有一个函数void OnDeserialization(object sender),只要实现了IDeserializationCallback,并且在OnDeserialization函数里实现具体的对不可序列化对象的初始化。

     [Serializable]
     public class SerializableCase:IDeserializationCallback
     {
         public SerializableCase() { }
 
         private string _State;
 
         public string State
         {
             get { return _State; }
             set { _State = value; }
         }
 
         [NonSerialized]
         private DonotSerializable _DonotSerializable;
 
         public DonotSerializable DonotSerializable
         {
             get { return _DonotSerializable; }
             set { _DonotSerializable = value; }
         }
 
         public void OnDeserialization(object sender)
         {
             _DonotSerializable = new DonotSerializable();
             _DonotSerializable.DonotSerializableData = "DonotSerializableData->Test";
         }
     }

按照上面的调用方式,来看一下结果:

图4

这样是在反序列化的时候,如果检测到了实例类型实现了IDeserializationCallback接口,是在反序列化完成的时候会执行实现了IDeserializationCallback的OnDeserialization()方法,这样可以对一些不可序列化的属性状态在这个方法里来实现。

序列化事件

.NET2.0 引进了对序列化事件的支持,当序列化和反序列化的时候,.NET在你的类上调用指定的方法,.NET中定义了四个序列化和反序列化事件。 serializing事件是在序列化发生之前被触发, serialized 事件是在序列化之后被触发, deserializing事件是在反序列化之前被触发, deserialized事件是在反序列化之后被触发。

引用先前的示例代码SerializableCase类的初始代码:

    [Serializable]
    public class SerializableCase //:IDeserializationCallback
    {
        public SerializableCase() { }
        private string _State;
        public string State
        {
            get { return _State; }
            set { _State = value; }
        }
    }

添加了事件后的示例代码是这样的:

     [Serializable]
     public class SerializableCase 
     {
         public SerializableCase() { }
         private string _State;
         public string State
         {
             get { return _State; }
             set { _State = value; }
         }
 
         [OnSerializing]
         private void OnSerializing(StreamingContext context)
         {
             _State = "此时的状态是:序列化之前";
             Console.WriteLine(State);
         }
 
         [OnSerialized]
         private void OnSerialized(StreamingContext context)
         {
             _State = "此时的状态是:序列化之后";
             Console.WriteLine(State);
         }
 
         [OnDeserializing]
         private void OnDeserializing(StreamingContext context)
         {
             _State = "此时的状态是:反序列化之前";
             Console.WriteLine(State);
         }
 
         [OnDeserialized]
         private void OnDeserialized(StreamingContext context)
         {
             _State = "此时的状态是:反序列化之后";
             Console.WriteLine(State);
         }
     }

使用之前定义好的MySerializableCase类型中的静态方法,稍作修改来演示一下,

         public static void SoapFormatterSerialize()
         {
             IFormatter formatter = new SoapFormatter();
             Stream stream = new FileStream("Soap.xml", FileMode.Create, FileAccess.ReadWrite);
             using (stream)
             {
                 SerializableCase serCase = new SerializableCase();
                 formatter.Serialize(stream, serCase);
             }
         }
         public static string SoapFormatterDesSerialize()
         {
             Stream stream = new FileStream("Soap.xml", FileMode.Open, FileAccess.Read);
             IFormatter formatter = new SoapFormatter();
             using (stream)
             {
                 SerializableCase serCase = formatter.Deserialize(stream) as SerializableCase;
                 return serCase.State;
             }
             
         }

测试代码:

 MySerializableCase.SoapFormatterSerialize();
 MySerializableCase.SoapFormatterDesSerialize();
 Console.ReadLine();

图5

从结果中就很明显的显示出来了,这里要说几句题外话,细心的朋友可能发现了,在SerializableCase类型中的四个事件函数签名都是相同的,这是因为在.NET中为这个这个序列化和反序列化事件定义的委托就是这个签名,在这个类型实例序列化和反序列化的时候会检测到.NET会反射实例内部所有的函数 检测是否有附加了序列化事件,如果判断了有则会继续检查这个函数的签名,如果函数签名也匹配了,就会把这个函数挂上委托。

可以这样指定一个函数为事件指定调用函数:

 [OnSerializing]
 [OnSerialized]
 [OnDeserializing]
 [OnDeserialized]
 private void OnGenericSerializEventMethod(StreamingContext context)
 {
     ……
 }

本篇幅序列化内容结束。