详解.NET Core 3.0 里新的JSON API

为什么需要新的 JSON API ?

JSON.NET  大家都用过,老版本的 ASP.NET Core 也依赖于 JSON.NET 。  

然而这个依赖就会引起一些版本问题:例如 ASP .NET  Core某个版本需要使用 JSON .NET  v10 ,而另一个库需要使用 JSON.NET  v11 ;或者 JSON .NET   出现了一个新版本,而ASP .NET Core 还不能支持这个版本,而您却想使用该版本。  

System.Text.Json  

随着 NET Core  3.0 的出现,出现了 System .Text.Json 命名空间和它下面一些用于处理 JSON 的类。  

特点

这个内置 JSON API 具有与生俱来的高性能、地分配的特点:  

JSON .NET  使用 .NET  里面的字符串作为基本数据类型,其实也就是 UTF16 ,而 .NET Core 中新的 JSON  API 直接使用数据原始的 UTF8 格式。  

新的 JSON API 基于 Span <byte> 这个数据类型来进行操作 JSON 数据,从而具有低分配的特点,这就可以极大的改善吞吐量和内存使用情况。  

但是新的JSON API 的特性还不那么丰富,有一些 JSON .NET 具有的特性都还不支持。  

例子  

随便找了一个 JSON 示例文件:  

Utf8JsonReader  

先使用   Utf8JsonReader  来读取JSON文件。  

Utf8JsonReader   并不会读取文件或者 stream ,它会读取Span数据类型。  

直接上代码:

可以看到 sample.json 文件里面的每个 Token 都被正确的显示了。  

Json Document 类  

Json Document 是基于 Utf8JsonReader  构建的 。 JsonDocument  可分析  JSON  数据并生成只读文档对象模型  (DOM) ,可对模型进行查询,以支持随机访问和枚举。使用  JsonDocument  分析常规  JSON  有效负载并访问其所有成员比使用  Json.NET  快  2-3  倍,且为合理大小(即  < 1 MB )的数据所分配的量非常少。  

JsonDocument 可以处理 Span ,也可以处理 Stream 。  

例子:

然后通过 root 这个 JsonElement 类型的对象的 GetProperty 方法来获得相应的属性,而且这个方法可以连串使用:  

这个方法接受 JsonElement 类型的对象,然后对该元素的属性进行循环。  

如果当前属性是另一个对象,那么就继续递归调用这个方法;

否则就输出原始的文本。

最后调用该方法:

与json文件的内容匹配。

Utf8JsonWriter 类  

下面研究一下如何写入json文件。这里需要使用Utf 8JsonWriter 类。  

直接看代码:

下面单独写一个方法,来生成json数据:

这样的话,实际上我已经拥有了一个合法的json文档。

写属性和值  

可以分开写属性和值:

显示 JSON 数据  

我先写这些内容,然后在Main方法里面调用一下:

运行一下看看效果:

这里对输出进行了缩进,最后把这个options传递给Utf 8JsonWriter 的构造函数即可。  

再次运行:

还是使用之前用到的 json 数据:  

反串行化  

可以使用Json Serializer 类的 Deserialize() 方法对 json 数据反串行化。这个方法支持三种类型的输入参数,分别是:  

  • JSON数据的字符串
  • Utf 8JsonReader  
  • Read OnlySpan<byte> ,它里面包含 JSON 数据  

为了简单一点,我直接把json文件读取成字符串,然后传给 Deserialize 方法:  

建立该类的一个实例,设置 Property NamingPolicy 为 CamelCase ,然后把这个实例传递给 Deserialize 方法的第二个参数。  

运行看结果 :  

这里使用了相同的 options 。  

运行结果:

这次输出结果为:

总结  

总结一下 .NET Core 3.0 新的JSON  API :  

  • Utf 8JsonReader -  读操作,快速,低级  
  • Utf 8JsonWriter -  写操作,快速,低级  
  • JsonDocument -  基于DOM,快速  
  • Json Seriliazer -  串行化 / 反串行化,快速  

另外 JSON .NET  仍然被支持。  

到此这篇关于详解.NET Core 3.0 里新的JSON API的文章就介绍到这了,更多相关.NET Core 3.0 JSON 内容请搜索来客网以前的文章或继续浏览下面的相关文章希望大家以后多多支持来客网!