.NET的8种JSON序列化反序列化工具供你选择

Posted 2023-06-09 .NET100

在.NET开发中，.NET的JSON序列化反序列化工具除了Newtonsoft.Json和System.Text.Json其实还有很多优秀的开源的序列化和反序列化工具，这些工具有的性能更加优秀，更加轻量等特征。本文将汇总介绍这些.NET中常用的JSON序列化和反序列化工具，供大家选择参考使用。

1、Newtonsoft.Json (Json.NET)

Newtonsoft.Json是.NET生态系统中最流行和广泛使用的JSON序列化和反序列化工具。它具有丰富的功能和灵活的API，支持自定义序列化和反序列化过程。它的性能表现良好，具有广泛的社区支持。是老牌序列化工具， 支持.NET Framework 3.5以上版本。

优点：流行、成熟的库，具有丰富的功能和灵活的API；支持自定义序列化和反序列化过程；具有良好的性能和广泛的社区支持。

缺点：相对较大的依赖包；在某些场景下，性能可能低于一些最新的库。

文档地址：newtonsoft.com/json/help/html/

推荐指数：★★★★★

2、System.Text.Json

System.Text.Json是.NET Core3.1之后官方提供的JSON序列化和反序列化库。它与.NET Core集成紧密，具有较低的内存占用和较好的性能。它支持异步操作，并且是.NET Core开发的首选选择之一。

优点：官方提供的库，与.NET Core集成紧密；具有较低的内存占用和较好的性能；支持异步操作。

缺点：相对于Newtonsoft.Json，功能相对较少；某些高级功能需要更多手动配置。

文档地址：

docs.microsoft.com/zh-cn/dotnet/standard/serialization/system-text-json-overview

推荐指数：★★★★

3、MessagePack

MessagePack是一种高效的二进制序列化格式，可以将对象序列化为紧凑的字节流，也可以将字节流反序列化为对象。它具有比JSON更小的序列化尺寸和更快的序列化速度。MessagePack支持多种编程语言，并且可以在跨语言的应用程序中使用。

优点：它生成的序列化数据尺寸小、序列化和反序列化速度快，同时具有跨语言支持，使得在不同平台和技术堆栈中的应用程序可以进行高效的数据交换和通信。

缺点：由于序列化数据是二进制的，可读性较差，不易读懂和调试。此外，相对于一些JSON序列化工具，MessagePack的配置选项和扩展性较少，灵活性稍弱。

文档地址：msgpack.org

推荐指数：★★★★★

4、Utf8Json

Utf8Json是一个高性能的JSON序列化和反序列化库，它使用Span和UTF-8编码进行快速的操作。它注重性能和效率，并具有较小的内存占用。

优点：高性能、低内存占用的库；使用Span和UTF-8编码进行快速的序列化和反序列化操作。

缺点：它的文档和社区支持不够多；相对于其他库，功能较为有限。

文档地址：github.com/neuecc/Utf8Json

推荐指数：★★★★

5、Jil

Jil是一个快速的JSON序列化和反序列化库，它注重性能和速度。它易于使用，并具有较低的内存占用。

优点：快速的JSON序列化和反序列化库；简单易用，具有较低的内存占用。

缺点：相对较少的高级功能；可能不如其他库灵活和可定制。

文档地址：github.com/kevin-montrose/Jil

推荐指数：★★★★

6、ServiceStack.Text

ServiceStack.Text是一个功能丰富的JSON序列化和反序列化库，支持多种序列化和反序列化方式。它具有良好的性能和灵活性，并支持自定义转换器。

优点：快速、功能丰富的库；支持多种序列化和反序列化方式；支持自定义转换器。

缺点：依赖包较大；可能与某些应用程序不兼容。

文档地址：docs.servicestack.net/text/

推荐指数：★★★

7、fastJSON

fastJSON是一个快速、简单的JSON序列化和反序列化库，适用于高性能需求。它具有较少的依赖和较小的内存占用。

优点：快速、简单的JSON序列化和反序列化库；支持多种数据类型；适用于高性能需求。

缺点：它的文档和社区支持相对较少；可能不如其他库灵活。

文档地址：github.com/mgholam/fastJSON/wiki

推荐指数：★★★

8、System.Runtime.Serialization.Json

System.Runtime.Serialization.Json是.NET Framework内置的库，用于序列化和反序列化JSON数据。它支持DataContract属性和WCF协定，但在性能方面可能不如其他库。比较老的项目可以使用它。

优点：.NET Framework内置的库，无需额外的引用；支持DataContract属性和WCF协定。

缺点：性能相对较差；不支持一些高级功能，如自定义转换器。

文档地址：

docs.microsoft.com/zh-cn/dotnet/api/system.runtime.serialization.json.datacontractjsonserialize

推荐指数：★★

结语

本文介绍了几种.NET的8种JSON序列化反序列化工具，它们各有千秋，开发人员应该根据项目规模和复杂度、等因素选择合适的组件；大家感兴趣可以测试一下它们的性能，小编曾测试过Utf8Json，确实比官方的序列化功能性能强太多。并根据组件的使用说明选择合适自己项目的组件。希望本文对你有所收获，你用过哪些.NET的JSON序列化反序列化工具，欢迎留言讨论。

来源公众号：DotNet开发跳槽❀ 

.NET中JSON的序列化和反序列化的几种方式

一、什么是JSON

    JSON(JavaScript Object Notation, JS 对象简谱) 是一种轻量级的数据交换格式。它基于ECMAScript(欧洲计算机协会制定的js规范)的一个子集，采用完全独立于编程语言的文本格式来存储和表示数据。简洁和清晰的层次结构使得JSON 成为理想的数据交换语言。 易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网络传输效率。
    是JavaScript用来处理数据的一种格式，大部分是用来处理JavaScript和web服务器端之间的数据交换，把后台web服务器的数据传递到前台，然后使用JavaScript进行处理，例如ajax等，是独立于语言和平台的轻量级的数据交换格式。

二、JSON语法

  1、JSON语法规则

    JS 语言中，一切都是对象。因此，任何支持的类型都可以通过 JSON 来表示，例如字符串、数字、对象、数组等。但是对象和数组是比较特殊且常用的两种类型：

      ● 对象表示为键值对

      ● 数据由逗号分隔

      ● 花括号保存对象

      ● 方括号保存数组

    对象：对象在JS中是使用花括号包裹{}起来的内容，数据结构为{key1：value1, key2：value2, ...}的键值对结构。在面向对象的语言中，key为对象的属性，value为对应的值。键名可以使用整数和字符串来表示。值的类型可以是任意类型。

{"firstName": "Brett", "lastName": "McLaughlin"}

    数组：数组在JS中是方括号[]包裹起来的内容，数据结构为[".NET", "Javascript", "Python", ...]的索引结构。在JS中，数组是一种比较特殊的数据类型，它也可以像对象那样使用键值对，但还是索引使用得多。同样，值的类型可以是任意类型。

{
    "people": [{
            "firstName": "zhang",
            "lastName": "san"
        },
        {
            "firstName": "li",
            "lastName": "si"
        }
    ]
}

  2、JSON 键/值对

    JSON键值对是用来保存JS对象的一种方式，和JS对象的写法也大同小异，键/值对组合中的键名写在前面并用双引号""包裹，使用冒号:分隔，然后紧接着值： {"firstName": "Json"} ，这很容易理解，等价于这条 JavaScript 语句： {firstName : "Json"} 。

  3、JSON 与 JS 对象的关系

    JS对象的关系，可以这么理解：JSON 是 JS 对象的字符串表示法，它使用文本表示一个 JS 对象的信息，本质是一个字符串。如：

var obj = {a: \'Hello\', b: \'World\'};        //这是一个对象，注意键名也是可以使用引号包裹的
var json = \'{"a": "Hello", "b": "World"}\'; //这是一个 JSON 字符串，本质是一个字符串

  4、JSON 和 JS 对象互转

    要实现从对象转换为 JSON 字符串，使用 JSON.stringify() 方法：

var json = JSON.stringify({a: \'Hello\', b: \'World\'}); //结果是 \'{"a": "Hello", "b": "World"}\'

    要实现从 JSON 转换为对象，使用 JSON.parse() 方法：

var obj = JSON.parse(\'{"a": "Hello", "b": "World"}\'); //结果是 {a: \'Hello\', b: \'World\'}

三、Json序列化方式

  1、JavaScriptSerializer

    使用JavaScriptSerializer方式需要引入的命名空间，这个在程序集System.Web.Extensions.dll.中。

    using System.Web.Script.Serialization;

  PS：可用[ScriptIgnore] 标记不序列化的属性

  Code:

public ActionResult GetJsonDemo()
{
    //对象
    DataModel model = new DataModel();
    model.ID = 1;
    model.Name = "ZhangSan";
    model.Sex = "女";
    model.Age = 18;

    //对象序列化Json
    string strJson= JsonHelper.ObjectToJson(model);

    //Json反序列化对象
    model= JsonHelper.JsonToObject<DataModel>(strJson);

    string strContent = "对象序列化：" + strJson + "\\n"+
                        "反序列化值：" + model.Name + " " + model.Sex + " " + model.Age;
    return Content(strContent);
}

  JsonHelper:

public class JsonHelper
{
    #region 第一种 JavaScriptSerializer  
    //使用JavaScriptSerializer方式需要引入的命名空间，这个在程序集System.Web.Extensions.dll.中 
    //using System.Web.Script.Serialization;
    //注：可用[ScriptIgnore] 标记不序列化的属性
    /// <summary>
    /// 序列化
    /// </summary>
    /// <param name="obj"></param>
    /// <returns></returns>
    public static string ObjectToJson(object obj)
    {
        JavaScriptSerializer jsonSerialize = new JavaScriptSerializer();
        return jsonSerialize.Serialize(obj);
    }

    /// <summary>
    /// 反序列化
    /// </summary>
    /// <typeparam name="T"></typeparam>
    /// <param name="strJson"></param>
    /// <returns></returns>
    public static T JsonToObject<T>(string strJson)
    {
        JavaScriptSerializer jsonSerialize = new JavaScriptSerializer();
        //jsonSerialize.Deserialize<dynamic>(strJson);  //取值model["Name"]; 要使用索引取值，不能使用对象.属性
        return jsonSerialize.Deserialize<T>(strJson);
    }
    #endregion
}

  Result：

  2、JSON.NET

    使用Json.NET类库需要引入的命名空间 using Newtonsoft.Json;

  PS：可用[JsonIgnore]标记不序列化的属性

  Code:

public ActionResult GetJsonDemo()
{
    //对象
    DataModel model = new DataModel();
    model.ID = 2;
    model.Name = "LiSi";
    model.Sex = "男";
    model.Age = 20;

    //对象序列化Json
    string strJson = JsonHelper.ObjectToJson(model);

    //Json反序列化对象
    model = JsonHelper.JsonToObject<DataModel>(strJson);

    string strContent = "对象序列化：" + strJson + "\\n" +
                        "反序列化值：" + model.Name + " " + model.Sex + " " + model.Age;
    return Content(strContent);
}

  JsonHelper:

/// <summary>
/// Json 帮助类
/// </summary>
public class JsonHelper
{
    #region 第二种 JSON.NET 
    //使用Json.NET类库需要引入的命名空间 using Newtonsoft.Json;
    //注：可用[JsonIgnore]标记不序列化的属性

    /// <summary>
    /// 序列化
    /// </summary>
    /// <param name="obj"></param>
    /// <returns></returns>
    public static string ObjectToJson(object obj)
    {
        return JsonConvert.SerializeObject(obj);
    }

    /// <summary>
    /// 反序列化
    /// </summary>
    /// <typeparam name="T"></typeparam>
    /// <param name="strJson"></param>
    /// <returns></returns>
    public static T JsonToObject<T>(string strJson)
    {
        return JsonConvert.DeserializeObject<T>(strJson);
    }
    #endregion
}

  Result:

  3、DataContractJsonSerializer

    使用DataContractJsonSerializer方式需要引入的命名空间，在System.Runtime.Serialization.dll.中。

    using System.Runtime.Serialization.Json;

    实体中的契约[DataMember]，[DataContract]，是使用DataContractJsonSerializer序列化和反序列化必须要加的，对于其他两种方式可加可不加。

  PS：可用[IgnoreDataMember] 标记不序列化的属性

  Code:

public ActionResult GetJsonDemo()
{
    //对象
    DataModel model = new DataModel();
    model.ID = 3;
    model.Name = "Wangwu";
    model.Sex = "女";
    model.Age = 22;

    //对象序列化Json
    string strJson = JsonHelper.ObjectToJson(model);

    //Json反序列化对象
    model = JsonHelper.JsonToObject<DataModel>(strJson);

    string strContent = "对象序列化：" + strJson + "\\n" +
                        "反序列化值：" + model.Name + " " + model.Sex + " " + model.Age;
    return Content(strContent);
}

  JsonHelper:

/// <summary>
/// Json 帮助类
/// </summary>
public class JsonHelper
{
  #region 第三种 DataContractJsonSerializer
  //使用DataContractJsonSerializer方式需要引入的命名空间，在System.Runtime.Serialization.dll.中
  //using System.Runtime.Serialization.Json;
  //注：可用[IgnoreDataMember] 标记不序列化的属性
  //实体中的契约[DataMember]，[DataContract]，是使用DataContractJsonSerializer序列化和反序列化必须要加的
  //对于其他两种方式不必加，也可以的。
  
  /// <summary>
  /// 序列化
  /// </summary>
  /// <param name="obj"></param>
  /// <returns></returns>
  public static string ObjectToJson(object obj)
  {
      using (MemoryStream stream = new MemoryStream())
      {
          DataContractJsonSerializer jsonSerialize = new DataContractJsonSerializer(obj.GetType());
          jsonSerialize.WriteObject(stream, obj);
          return Encoding.UTF8.GetString(stream.ToArray());
      }
  }
  
  /// <summary>
  /// 反序列化
  /// </summary>
  /// <typeparam name="T"></typeparam>
  /// <param name="strJson"></param>
  /// <returns></returns>
  public static T JsonToObject<T>(string strJson)
  {
      using (MemoryStream stream = new MemoryStream(Encoding.UTF8.GetBytes(strJson)))
      {
          DataContractJsonSerializer jsonSerialize = new DataContractJsonSerializer(typeof(T));
          return (T)jsonSerialize.ReadObject(stream);
      }
  }
  
  #endregion
}

  Result:

  PS: DataModel

[DataContract]
public class DataModel
{
    [DataMember]
    public int ID { get; set; }

    [DataMember]
    public string Name { get; set; }

    [DataMember]
    public string Sex { get; set; }

    [DataMember]
    public int Age { get; set; }
}

四、总结

  1、JSON序列化有三种方式

    JavaScriptSerializer类

    JSON.NET类库

    DataContractJsonSerializer类

  2、尽量使用JSON.NET（开源）来序列化和反序列化，性能好。

优秀是一种习惯，欢迎大家关注学习