c#学习笔记之序列化与反序列化-1

最近在搞一个类似于QQ的即时通讯的一个东西，正好数据通讯用到序列化，就把与序列化相关的知识点整理下。

需要将C#中某一个结构很复杂的类的对象存储起来，或者通过网络传输到远程的客户端程序中去，这时候用文件方式或者数据库方式存储或者传送就比较麻烦，此时最好使用序列化和反序列化（串行和解串）。

序列化又称串行化，是.NET运行时（CLR）环境用来支持用户定义类型的流化的机制。其目的是以某种存储形式使自定义对象持久化，或者将这种对象从一个地方传输到另一个地方。

.NET框架提供了三种串行化的方式：

1、是使用BinaryFormatter（详细语法及使用见链接）进行串行化；

2、使用SoapFormatter进行串行化；

3、使用XmlSerializer进行串行化。

第一种方式提供了一个简单的二进制数据流以及某些附加的类型信息，而第二种将数据流格式化为XML存储；第三种其实和第二种差不多，也是XML的格式存储，只不过比第二种的XML格式要简化很多(去掉了SOAP特有的额外信息)。

可以使用[Serializable]属性将类标志为可序列化的。如果某个类的元素不想被序列化，1、2可以使用[NonSerialized]属性来标志，2、可以使用[XmlIgnore]来标志。

1、使用BinaryFormatter进行串行化

下面是一个可串行化的类：

1. using System;  

2. using System.Data;  

3. using System.Configuration;  

4. using System.Web;  

5. using System.Web.Security;  

6. using System.Web.UI;  

7. using System.Web.UI.WebControls;  

8. using System.Web.UI.WebControls.WebParts;  

9. using System.Web.UI.HtmlControls;  

10. using System.IO;  

11. using System.Runtime.Serialization.Formatters.Binary;    //****

12. /** <summary>  

13. /// ClassToSerialize 的摘要说明  

14. /// </summary>  

15. [Serializable]       //*****

16. public class ClassToSerialize 

17. {  

1. public int id = 100;  

2. public string name = "Name";  

3. [NonSerialized]   //*****

4. public string Sex = "男";  

18. } 

下面是串行化和反串行化的方法：

1. public void SerializeNow()  

2. {  

1. ClassToSerialize c = new ClassToSerialize();  

2. FileStream fileStream = new FileStream("c:\\temp.dat", FileMode.Create);  

3. BinaryFormatter b = new BinaryFormatter();  

4. b.Serialize(fileStream, c);  

5. fileStream.Close();  

3. }  

4. public void DeSerializeNow()  

5. {  

1. ClassToSerialize c = new ClassToSerialize();  

2. c.Sex = "kkkk";  

3. FileStream fileStream = new FileStream("c:\\temp.dat", FileMode.Open, FileAccess.Read, FileShare.Read);  

4. BinaryFormatter b = new BinaryFormatter(); 

5. c = b.Deserialize(fileStream) as ClassToSerialize; 

6. Response.Write(c.name);  

7. Response.Write(c.Sex);  

8. fileStream.Close();  

6. } 

调用上述两个方法就可以看到串行化的结果：Sex属性因为被标志为[NonSerialized],故其值总是为null。

2、使用SoapFormatter进行串行化

和BinaryFormatter类似，我们只需要做一下简单修改即可：

a.将using语句中的.Formatter.Binary改为.Formatter.Soap;

b.将所有的BinaryFormatter替换为SoapFormatter.

c.确保报存文件的扩展名为.xml

经过上面简单改动，即可实现SoapFormatter的串行化，这时候产生的文件就是一个xml格式的文件。

3、使用XmlSerializer进行串行化

关于格式化器还有一个问题，假设我们需要XML，但是不想要SOAP特有的额外信息，那么我们应该怎么办呢？有两种方案：要么编写一个实现IFormatter接口的类，采用的方式类似于SoapFormatter类,但是没有你不需要的信息；要么使用库类XmlSerializer，这个类不使用Serializable属性，但是它提供了类似的功能。

如果我们不想使用主流的串行化机制，而想使用XmlSeralizer进行串行化我们需要做一下修改：

a.添加System.Xml.Serialization命名空间。

b.Serializable和NoSerialized属性将被忽略,而是使用XmlIgnore属性，它的行为与NoSerialized类似。

c.XmlSeralizer要求类有个默认的构造器，这个条件可能已经满足了。

下面看示例：

要序列化的类：

1. using System;  

2. using System.Data;  

3. using System.Configuration;  

4. using System.Web;  

5. using System.Web.Security;  

6. using System.Web.UI;  

7. using System.Web.UI.WebControls;  

8. using System.Web.UI.WebControls.WebParts;  

9. using System.Web.UI.HtmlControls;  

10. using System.Xml.Serialization;  

11. 

12. [Serializable]  

13. public class Person

14. {

1. private string name;  

2. public string Name

3. {  

1. get{  return name; }  

2. set{  name = value; }

4. }  

5. public string Sex;  

6. public int Age = 31;  

7. public Course[] Courses;  

8. public Person() {}  

9. public Person(string Name)

10. {  

1. name = Name;  

2. Sex = "男";  

11. }  

15. }  

16. 

17. [Serializable]  

18. public class Course

19. {  

1. public string Name;  

2. [XmlIgnore]  

3. public string Description;  

4. public Course(){}  

5. public Course(string name, string description)

6. {  

1. Name = name;  

2. Description = description;  

7. }  

20. }  

序列化和反序列化方法：

1. public void XMLSerialize()  

2. {  

1. Person c = new Person("cyj");  

2. c.Courses = new Course[2];  

3. c.Courses[0] = new Course("英语", "交流工具");  

4. c.Courses[1] = new Course("数学","自然科学");  

5. XmlSerializer xs = new XmlSerializer(typeof(Person));  

6. Stream stream = new FileStream("c:\\cyj.XML",FileMode.Create,FileAccess.Write,FileShare.Read);  

7. xs.Serialize(stream,c);  

8. stream.Close();  

3. }  

4. public void XMLDeserialize()  

5. {  

1. XmlSerializer xs = new XmlSerializer(typeof(Person));  

2. Stream stream = new FileStream("C:\\cyj.XML",FileMode.Open,FileAccess.Read,FileShare.Read);  

3. Person p = xs.Deserialize(stream) as Person;  

4. Response.Write(p.Name);  

5. Response.Write(p.Age.ToString());  

6. Response.Write(p.Courses[0].Name);  

7. Response.Write(p.Courses[0].Description);  

8. Response.Write(p.Courses[1].Name);  

9. Response.Write(p.Courses[1].Description);  

10. stream.Close();  

6. } 

这里Course类的Description属性值将始终为null，生成的xml文档中也没有该节点，如下：

1. <?xml version="1.0"?> 

2. <Person xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> 

3. <Sex>男</Sex> 

4. <Age>31</Age> 

5. <Courses> 

6. <Course> 

7. <Name>英语</Name> 

8. <Description>交流工具</Description> 

9. </Course> 

10. <Course> 

11. <Name>数学</Name> 

12. <Description>自然科学</Description> 

13. </Course> 

14. </Courses> 

15. <Name>cyj</Name> 

16. </Person> 

4、自定义序列化
如果你希望让用户对类进行串行化，但是对数据流的组织方式不完全满意，那么可以通过在自定义类中实现接口来自定义串行化行为。这个接口只有一个方法，GetObjectData. 这个方法用于将对类对象进行串行化所需要的数据填进SerializationInfo对象。你使用的格式化器将构造SerializationInfo对象，然后在串行化时调用GetObjectData. 如果类的父类也实现了ISerializable，那么应该调用GetObjectData的父类实现。

如果你实现了ISerializable，那么还必须提供一个具有特定原型的构造器，这个构造器的参数列表必须与GetObjectData相同。这个构造器应该被声明为私有的或受保护的，以防止粗心的开发人员直接使用它。

示例如下：

实现ISerializable的类：

1. using System;  

2. using System.Data;  

3. using System.Configuration;  

4. using System.Web;  

5. using System.Web.Security;  

6. using System.Web.UI;  

7. using System.Web.UI.WebControls;  

8. using System.Web.UI.WebControls.WebParts;  

9. using System.Web.UI.HtmlControls;  

10. using System.Runtime.Serialization;  

11. using System.Runtime.Serialization.Formatters.Binary;  

12. /** <summary>  

13. /// Employee 的摘要说明  

14. /// </summary>  

15. [Serializable]  

16. public class Employee:ISerializable  

17. {  

18. public int EmpId=100;  

19. public string EmpName="刘德华";  

20. [NonSerialized]  

21. public string NoSerialString = "NoSerialString-Test";  

22. public Employee()  

23. {  

24. //  

25. // TODO: 在此处添加构造函数逻辑  

26. //  

27. }  

28. private Employee(SerializationInfo info, StreamingContext ctxt)  

29. {  

1. EmpId = (int)info.GetValue("EmployeeId", typeof(int));  

2. EmpName = (String)info.GetValue("EmployeeName",typeof(string));  

3. //NoSerialString = (String)info.GetValue("EmployeeString",typeof(string));  

30. }  

31. public void GetObjectData(SerializationInfo info, StreamingContext ctxt)  

32. {  

1. info.AddValue("EmployeeId", EmpId);  

2. info.AddValue("EmployeeName", EmpName);  

3. //info.AddValue("EmployeeString", NoSerialString);  

33. }  

34. } 

序列化和反序列化方法：

1. public void OtherEmployeeClassTest()  

2. {  

3. Employee mp = new Employee();  

4. mp.EmpId = 10;  

5. mp.EmpName = "邱枫";  

6. mp.NoSerialString = "你好呀";  

7. Stream steam = File.Open("c:\\temp3.dat", FileMode.Create);  

8. BinaryFormatter bf = new BinaryFormatter();  

9. Response.Write("Writing Employee Info:");  

10. bf.Serialize(steam,mp);  

11. steam.Close();  

12. mp = null;  

13. //反序列化  

14. Stream steam2 = File.Open("c:\\temp3.dat", FileMode.Open);  

15. BinaryFormatter bf2 = new BinaryFormatter();  

16. Response.Write("Reading Employee Info:");  

17. Employee mp2 = (Employee)bf2.Deserialize(steam2);  

18. steam2.Close();  

19. Response.Write(mp2.EmpId);  

20. Response.Write(mp2.EmpName);  

21. Response.Write(mp2.NoSerialString);  

22. } 

更详细的理论请看C#学习笔记之序列化与反序列化-2