沃梦达 / 编程技术 / 编程语言 / C#/.NET开发 / 正文

C#实现对象的序列化和反序列化

C#/.NET开发
2023-06-27

这篇文章介绍了C#实现对象序列化和反序列化的方法，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下

什么是序列化和反序列化：

将对象及其状态保存起来，通常是保存到文件中，叫序列化。
将文件还原为对象，叫反序列化。

序列化和反序列化的接口和帮助类：

  • 接口IFormatter
    • object Deserialize(Stream serializactionStream)
    • void Serialize(Stream serializationStream, object graph)
  • System.Runtime.Serialization.Formatters.Binary下的BinaryFormatter，将对象序列化成二进制
  • System.Runtime.Serialization.Formatters.Soap下的SoapFormatter，将对象序列化成人类可读的文本

什么是SOAP：

Simple Object Access Protocol，简单对象访问协议，基于XML协议。

使用BinaryFormatter序列化对象保存到文件

using System;
using System.Data.SqlClient;
using System.IO;
using System.Runtime.Serialization;
using System.Runtime.Serialization.Formatters.Binary;
 
    class Program
    {
        static void Main(string[] args)
        {
            IFormatter formatter = new BinaryFormatter();
            Product product = new Product(1){Price = 88.5f,Name = "Wind 850"};
            Stream fs = File.OpenWrite(@"F:\product.obj");
            formatter.Serialize(fs, product);
            fs.Dispose();
            Console.WriteLine(product);
            Console.ReadKey();
        }
    }
 
    [Serializable]
    public class Product
    {
        private int id;
 
        [NonSerialized]
        private SqlConnection conn;
 
        public Product(int id)
        {
            this.id = id;
            this.conn = new SqlConnection(@"Data Source=.;Initial Catalog=DB;User ID=sa;Password=1");
        }
 
        public string Name { get; set; }
        public double Price { get; set; }
 
        public override string ToString()
        {
            return String.Format("Id:{0},Name:{1},Price:{2},conn:{3}", this.id, this.Name, this.Price,this.conn==null?"Null":"Object");
        }
    }

注意：

  • 对象序列化需要打上[Serializable]
  • 不可序列化的字段需要打上[NonSerialized]，该属性只能打在字段上

结果：

使用BinaryFormatter将文件反序列化成对象

IFormatter formatter = new BinaryFormatter();
Stream fs = File.OpenRead(@"F:\product.obj");
Product product = (Product) formatter.Deserialize(fs);
Console.WriteLine(product);
Console.ReadKey();

结果：

注意：

  • 私有字段是可以反序列化的，因为反序列化的底层是通过反射来实现的，而反射是可以访问到私有字段的。
  • conn变成了null，这是因为反序列化并不会调用构造函数，而且conn本身设置成了不可以序列化。

IDeserializationCallback用来在反序列化后执行回调函数，实现没有反序列化字段的实例化：

   [Serializable]
    public class Product:IDeserializationCallback
    {
        private int id;
 
        [NonSerialized]
        private SqlConnection conn;
 
        public Product(int id)
        {
            this.id = id;
            this.conn = new SqlConnection(@"Data Source=.;Initial Catalog=DB;User ID=sa;Password=1");
        }
 
        public string Name { get; set; }
        public double Price { get; set; }
 
        public override string ToString()
        {
            return String.Format("Id:{0},Name:{1},Price:{2},conn:{3}", this.id, this.Name, this.Price,this.conn==null?"Null":"Object");
        }
 
        public void OnDeserialization(object sender)
        {
            this.conn = new SqlConnection(@"Data Source=.;Initial Catalog=DB;User ID=sa;Password=1");
        }
    }

再次运行，得到：

使用SoapFormatter序列化对象保存到文件

IFormatter formatter = new SoapFormatter();
Product item = new Product(2){Name = "Hello world",Price = 9.5F};
Stream fs = File.OpenWrite(@"F:\product.soap");
formatter.Serialize(fs, item);
fs.Dispose();

结果：

使用SoapFormatter：

  • 好处：SOAP是开放的协议，可以跨平台的其他程序也可以使用SoapFormatter序列化的文件
  • 缺点：xml文件尺寸比较大

使用序列化和反序列化事件对对象进行简单的加密和解密

主程序：

//序列化
IFormatter formatter = new BinaryFormatter();
Product product = new Product(@"Data Source=.;Initial Catalog=DB;User ID=sa;Password=1");
Stream fs = File.OpenWrite(@"F:\product.obj");
formatter.Serialize(fs, product);
fs.Dispose(); 

//反序列化
Stream fs1 = File.OpenRead(@"F:\product.obj");
Product product1 = (Product)formatter.Deserialize(fs1);

Console.WriteLine(product1);
Console.ReadKey();

可序列化类：

    [Serializable]
    public class Product
    {
        private string connString;
        [NonSerialized]
        public SqlConnection conn;
 
        public Product(string connString)
        {
            this.connString = connString;
        }
 
        [OnSerializing]
        void OnSerializing(StreamingContext context)
        {
            Console.WriteLine("序列化前：对私有字段connString进行简单加密");
            this.connString = this.connString.Replace("a", "*");
        }
 
        [OnSerialized]
        void OnSerialized(StreamingContext context)
        {
            Console.WriteLine("序列化后：对私有字段connString进行简单解密");
            this.connString = this.connString.Replace("*", "a");
        }
 
        [OnDeserializing]
        void OnDeserializing(StreamingContext context)
        {
            Console.WriteLine("反序列化前：do nothing~~");
        }
 
        [OnDeserialized]
        void OnDeserialized(StreamingContext context)
        {
            Console.WriteLine("反序列化后：对私有字段connString进行简单解密，并重新初始化非序列化字段");
            this.connString = this.connString.Replace("*", "a");
            this.conn = new SqlConnection(connString);
        }
 
        public override string ToString()
        {
            return this.connString;
        }
    }

结果：

通过实现ISerializable接口自定义序列化过程

主要借助帮助类SerializationInfo，以键值对形式把需要序列化的字段或属性保存在SerializationInfo中。另外，还需要一个反序列化时用于还原属性值的构造函数。

    [Serializable]
    public class Product : ISerializable
    {
        private string connString;
 
        [NonSerialized]
        public SqlConnection conn;
 
        public Product(string connString)
        {
            this.connString = connString;
        }
 
        //反序列化时用于还原属性值的构造函数
        protected Product(SerializationInfo info, StreamingContext context)
        {
            string encrypted = info.GetString("encrypted");
            this.connString = encrypted.Replace("*", "a");
        }
 
        //对私有字段简单加密以键值对形式保存到SerializationInfo
        public void GetObjectData(SerializationInfo info, StreamingContext context)
        {
            string encrypted = this.connString.Replace("a", "*");
            info.AddValue("encrypted",encrypted);
        }
 
        public override string ToString()
        {
            return this.connString;
        }
    }

结果：

通过实现ISerializable接口让没有实现序列化的基类可被序列化

有这样一个基类，不可以序列化。

    public class ObjectBase
    {
        public string Name;
    }

创建一个子类继承不可以序列化的ObjectBase，并实现ISerializable接口。

    [Serializable]
    public class Product : ObjectBase,ISerializable
    {
        private string connString;
 
        [NonSerialized]
        public SqlConnection conn;
 
        public Product(string connString)
        {
            this.connString = connString;
        }
 
        //反序列化时用于还原属性值的构造函数
        protected Product(SerializationInfo info, StreamingContext context)
        {
            string encrypted = info.GetString("encrypted");
            this.connString = encrypted.Replace("*", "a");
            base.Name = info.GetString("name");
        }
 
        //对私有字段简单加密以键值对形式保存到SerializationInfo
        public void GetObjectData(SerializationInfo info, StreamingContext context)
        {
            string encrypted = this.connString.Replace("a", "*");
            info.AddValue("encrypted",encrypted);
            info.AddValue("name",base.Name);
        }
 
        public override string ToString()
        {
            return String.Format("Name:{0},Conn:{1}", base.Name, this.connString);
        }
    }

主程序：

            //序列化
            IFormatter formatter = new BinaryFormatter();
            Product product = new Product(@"Data Source=.;Initial Catalog=DB;User ID=sa;Password=1"){Name = "我来自基类"};
            Stream fs = File.OpenWrite(@"F:\product.obj");
            formatter.Serialize(fs, product);
            fs.Dispose(); 
 
            //反序列化
            Stream fs1 = File.OpenRead(@"F:\product.obj");
            Product product1 = (Product)formatter.Deserialize(fs1);
 
            Console.WriteLine(product1);
            Console.ReadKey();

结果：

总结

  • 使用BinaryFormatter：以二进制形式序列化和反序列化的时候用到。
  • 使用SoapFormatter：以xml形式，或跨平台调序列化和反序列化的时候用到。
  • [NonSerialized][OnSerializing][OnSerialized][OnDeserializing]这4个事件可以对序列化和反序列化过程进行细粒度控制。
  • ISerializable接口：可以把序列化字段或属性以键值对形式保存在SerializationInfo中，甚至让一个没有序列化特性的基类实现序列化。

到此这篇关于C#序列化和反序列化对象的文章就介绍到这了。希望对大家的学习有所帮助，也希望大家多多支持得得之家。

本文标题为：C#实现对象的序列化和反序列化

上一篇： C#中流的使用和分类
下一篇： C#自定义集合初始化器

基础教程推荐

学习HTML
学习jQuery
学习Laravel
学习CSS3
学习Vue.js
学习Bootstrap5
学习ThinkPHP
学习AJAX
猜你喜欢
最新文章
热门文章
编程基础
热门标签
网站首页 HTML/CSS 菜单 Layui Yii2