开发者应当熟知的 C# 序列化和反序列化

Posted 2021-04-14 CSDN

作者 | 喵叔

责编 | 刘静

出品 | CSDN（ID：CSDNnews）

今天我利用这篇文章给大家讲解一下 C# 中的序列化与反序列化。这两个概念我们在开发中经常用到，但是我们绝大部分只用到了其中的一部分，剩下的部分很多开发人员并不清楚，伸着可以说是不知道。因此我希望通过这篇文章能让各位对序列化和反序列化的知识有更进一步的掌握。废话不多说开始进入正题。

什么是序列化/反序列化

在所有的开发语言中都存在序列化和反序列化这个概念，所谓的序列化就是把一个对象信息转化为一个可以持久存储的数据形式，经过转化后就可以方便的保存和传输了，因此序列化主要用于平台之间的通讯。由序列化我们可以反推出所谓的反序列化就是将持久存储的数据还原为对象。

C# 中的序列化/反序列化

在 C# 中我们经常会对 JSON 和 XML 进行序列化和反序列化 ，但是还有存在一种序列化/反序列化，那就是将对象序列化为二进制文件，将会二进制文件反序列化为对象。下面我将会对这三种序列化和反序列化进行讲解。

1. JSON

JSON 的英文全称是 javascript Object Notation ，是一种轻量级的数据交换格式。完全独立于语言的文本格式 易于人阅读和编写同时也易于机器解析和生成。JSON 是目前互联网中主流的数据交换格式，同时也是很多开发语言配置文件的主流格式。

在 .NET 中存在两个类对 JSON 进行处理，分别是 DataContractJsonSerializer 和 JavaScriptSerializer ，这两个类的功能基本一致。DataContractJsonSerializer 位于命名空间 System.Runtime.Serialization.Json 下，它的特点是必须使用 DataContract 以及 DataMember 属性标记成员。JavaScriptSerializer 位于命名空间 System.Web.Script.Serialization 下，通过名字和它所在的命名空间我们可以得知它主要用在网络通信中，它可以序列化任何类型的对象。同样 .NET 中也存在一个强大的第三方 JSON 序列化/反序列化库 Newtonsoft.Json ，他比前两个类用起来要方便很多。下面我们对这三个序列化/反序列化的方式分别进行讲解。

• DataContractJsonSerializer

首先我们需要在项目中引用 DataContractJsonSerializer 所在的命名空间，这里要注意的时我们不仅要在项目中添加引用 System.Runtime.Serialization 还需要添加引用 System.ServiceModel.Web 。将这两个命名空添加到命名空间后就可以在代码中引入 DataContractJsonSerializer 的命名空间了。

using System.Runtime.Serialization;
using System.Runtime.Serialization.Json;

引入命名空间后我们开始编写序列化类

[DataContract]
class Student
{
    [DataMember]
    public string Name { get; set; }
    [DataMember]
    public int Sex { get; set; }
    [DataMember]
    public int Age { get; set; }
    [DataMember]
    public Address Address { get; set;  }
}
[DataContract]
class Address
{
    [DataMember]
    public string City { get; set; }
    [DataMember]
    public string Road { get; set; }
}

在上述代码中我们看到在类的头部添加了 DataContract 特性，以及在类的属性上也增加了 DataMember 特性 。一旦一个类被声明为 DataContract 时就代表着该类可以被序列化，并且可以在服务端和客户端传输。只有声明为DataContract的类型的对象可以被传送，且只有成员属性会被传递，成员方法不会被传递。默认情况下类中的所有成员属性都不会被序列化传输出去，如果需要将成员数据传输出去就需要在属性头部加入 DataMember 。

下面我们就利用 DataContractJsonSerializer 对对象尽心序列化和反序列化，代码如下

class Program
{
    static void Main(string[] args)
    {
        #region 对象转JSON字符串
        Student student = new Student
        {
            Name = "Tom",
            Age = 20,
            Sex = 1,
            Address = new Address
            {
                City = "NYC",
                Road = "ABC"
            }
        };
        //利用WriteObject方法序列化为 JSON
        DataContractJsonSerializer serializer = new DataContractJsonSerializer(typeof(Student));
        MemoryStream stream = new MemoryStream();
        serializer.WriteObject(stream, student);
        byte[] bytes=new byte[stream.Length];
        stream.Position = 0;
        stream.Read(bytes, 0, (int)stream.Length);
        string jsonStr = Encoding.UTF8.GetString(bytes);
        Console.WriteLine(jsonStr);
        #endregion

        #region JSON字符串转对象
        stream = new MemoryStream(Encoding.Default.GetBytes(jsonStr));
        student = (Student)serializer.ReadObject(stream);
        Console.WriteLine("Name: " +student.Name);
        Console.WriteLine("Sex: " + student.Sex);
        Console.WriteLine("Age: " + student.Age);
        Console.WriteLine("Address: " + student.Address.City+" "+student.Address.Road);
        #endregion
        Console.ReadLine();
    }
}

输出结果如下：

• JavaScriptSerializer
  

我们利用前面定义的类，来看一下 JavaScriptSerializer 的使用方法，我们将前面定义的类中的 DataContract 和 DataMember 都去掉。我们如果要使用 JavaScriptSerializer 只需引入 System.Web.Script.Serialization 命名空间即可。代码如下：

using System.Web.Script.Serialization;

下面我们就利用 JavaScriptSerializer 对象进行序列化和反序列化，代码如下：

class Program
{
    static void Main(string[] args)
    {
        #region 序列化
        Student student = new Student
        {
            Name = "Tom",
            Age = 20,
            Sex = 1,
            Address = new Address
            {
                City = "NYC",
                Road = "ABC"
            }
        };
        //初始化
        JavaScriptSerializer serializer = new JavaScriptSerializer();
        string jsonStr = serializer.Serialize(student);
        Console.WriteLine(jsonStr);
        #endregion

        #region 反序列化
        student = serializer.Deserialize<Student>(jsonStr);
        Console.WriteLine("Name: " +student.Name);
        Console.WriteLine("Sex: " + student.Sex);
        Console.WriteLine("Age: " + student.Age);
        Console.WriteLine("Address: " + student.Address.City+" "+student.Address.Road);
        #endregion
        Console.ReadLine();
    }
}

从上面的代码我们可以看出利用 JavaScriptSerializer 序列化和反序列化要比 DataContractJsonSerializer 类方便。上述代码运行结果如下：

• Newtonsoft.Json

Newtonsoft.Json 功能有很多，除了序列化反序列化之外，还有 Linq To Json、Json Path、 XML support等，我们这篇文章我们只讲解其中的序列化和反序列化。使用 Newtonsoft.Json 前首先我们需要在 nuget 中搜索并安装，安装完成后引入 Newtonsoft.Json，代码如下：

using Newtonsoft.Json;

下面我们来看看 Newtonsoft.Json 的具体使用：

class Program
{
    static void Main(string[] args)
    {
        #region 序列化
        Student student = new Student
        {
            Name = "Tom",
            Age = 20,
            Sex = 1,
            Address = new Address
            {
                City = "NYC",
                Road = "ABC"
            }
        };
        string jsonStr = JsonConvert.SerializeObject(student);
        Console.WriteLine(jsonStr);
        #endregion

        #region 反序列化
        student = JsonConvert.DeserializeObject<Student>(jsonStr);
        Console.WriteLine("Name: " +student.Name);
        Console.WriteLine("Sex: " + student.Sex);
        Console.WriteLine("Age: " + student.Age);
        Console.WriteLine("Address: " + student.Address.City+" "+student.Address.Road);
        #endregion

        Console.ReadLine();
    }
}

上述代码输出结果如下：

从代码中我们看到 Newtonsoft.Json 序列化和反序列化更加简单，简单到只需要一行代码就完成了序列化和反序列化。

2. XML

在 JSON 还没出现之前，XML 是互联网上常用的数据交换格式和规范。.NET 中提供 XmlSerializer 类将对象序列化为 XML 和将 XML 反序列化为对象，使用方法是首先实例化，然后调用序列化/反序列化方法。下面我们依然使用最开始定义的那个类，来看看 XmlSerializer 的使用。使用前我们需要引入 using System.Xml.Serialization 命名空间。

using System.Xml.Serialization;

具体序列化/反序列化方法如下：

class Program
{
    static void Main(string[] args)
    {
        #region 序列化
        Student student = new Student
        {
            Name = "Tom",
            Age = 20,
            Sex = 1,
            Address = new Address
            {
                City = "NYC",
                Road = "ABC"
            }
        };
        XmlSerializer xmlSerializer = new XmlSerializer(typeof(Student));
        using (FileStream stream = new FileStream(@"d:123.xml", FileMode.OpenOrCreate))
        {
            xmlSerializer.Serialize(stream, student);
        }
        #endregion

        #region 反序列化
        using (FileStream stream = new FileStream(@"d:123.xml", FileMode.OpenOrCreate))
        {
            XmlReader xmlReader = new XmlTextReader(stream);
            student = xmlSerializer.Deserialize(xmlReader) as Student;
        }
        Console.WriteLine("Name: " + student.Name);
        Console.WriteLine("Sex: " + student.Sex);
        Console.WriteLine("Age: " + student.Age);
        Console.WriteLine("Address: " + student.Address.City + " " + student.Address.Road);
        #endregion

        Console.ReadLine();
    }
}

这里有一点需要注意，如果对象类的访问修饰符不是 public 将会报错。上述代码运行结果如下：

3. 二进制

序列化为二进制，在实际开发中真的很少用到，但是我觉得还是有必要讲一讲，它的使用方法和 XmlSerializer 序列化/反序列化类似，首先实例化，然后调用序列化/反序列化方法。在进行序列化/反序列化前首先引入命名空间 System.Runtime.Serialization.Formatters.Binary ，同时修改对象类如下：

[Serializable]
public class Student
{
   public string Name { get; set; }
   public int Sex { get; set; }
   public int Age { get; set; }
   public Address Address { get; set; }
}
[Serializable]
public class Address
{
   public string City { get; set; }
   public string Road { get; set; }
}

上述代码中我们在类的头部加入了  Serializable 特性，这代表着整个类对象都需要序列化，如果我们不需要序列化其中某个属性的话只需在该属性上加上 NonSerialized 特性即可。下面我们来看一下序列化和反序列化的代码：

class Program
{
    static void Main(string[] args)
    {
        #region 序列化
        Student student = new Student
        {
            Name = "Tom",
            Age = 20,
            Sex = 1,
            Address = new Address
            {
                City = "NYC",
                Road = "ABC"
            }
        };
        BinaryFormatter binFormat = new BinaryFormatter();
        string fileName = Path.Combine(@"D:", @"321.txt");
        using (Stream fStream = new FileStream(fileName, FileMode.Create, FileAccess.ReadWrite))
        {
            binFormat.Serialize(fStream, student);
        }
        #endregion

        #region 反序列化
        using (Stream fStream = new FileStream(fileName, FileMode.Open, FileAccess.ReadWrite))
        {
            fStream.Position = 0;
            student = (Student)binFormat.Deserialize(fStream);
        }
        Console.WriteLine("Name: " + student.Name);
        Console.WriteLine("Sex: " + student.Sex);
        Console.WriteLine("Age: " + student.Age);
        Console.WriteLine("Address: " + student.Address.City + " " + student.Address.Road);
        #endregion

        Console.ReadLine();
    }
}

上述代码最终输出结果如下：

总结

这篇文章详细讲解了.NET中序列化和反序列化相关知识的使用，序列化和反序列化相关的只是还有很多，这里所讲解的都是开发中经常用到的，也是面试过程中会提及的，因此大家需要牢记。

作者简介：朱钢，笔名喵叔，CSDN博客专家，.NET高级开发工程师，7年一线开发经验，参与过电子政务系统和AI客服系统的开发，以及互联网招聘网站的架构设计，目前就职于北京恒创融慧科技发展有限公司，从事企业级安全监控系统的开发。

声明：本文系作者独立观点，不代表CSDN立场。

【END】

 热 文 推 荐 

☞

☞

☞

点击阅读原文参与开发者大调查，好礼送不停！

你点的每个“在看”，我都认真当成了喜欢