为什么需要新的JSON API？
JSON.NET大家都用过，老版本的ASP.NET Core也依赖于JSON.NET。
然而这个依赖就会引起一些版本问题：例如ASP.NETCore某个版本需要使用JSON.NETv10，而另一个库需要使用JSON.NETv11;或者JSON.NET出现了一个新版本，而ASP.NET Core还不能支持这个版本，而您却想使用该版本。
System.Text.Json
随着NET Core3.0的出现，出现了System.Text.Json命名空间和它下面一些用于处理JSON的类。
特点
这个内置JSON API具有与生俱来的高性能、低分配的特点：
JSON.NET使用.NET里面的字符串作为基本数据类型，其实也就是UTF16，而.NET Core中新的JSONAPI直接使用数据原始的UTF8格式。
新的JSON API基于Span
但是新的JSONAPI的特性还不那么丰富，有一些JSON.NET具有的特性都还不支持。
例子
随便找了一个JSON示例文件：
针对这个文件，需要修改一下它的属性：
Utf8JsonReader
先使用Utf8JsonReader来读取JSON文件。
Utf8JsonReader并不会读取文件或者stream，它会读取Span数据类型。
直接上代码：
Main方法里面，我们使用File.ReadAllBytes从sample.json文件读取数格式为byte[]，然后通过AsSpan这个扩展方法将其转化为Span
接下来使用while循环对JSON数据的每个Token进行读取，每次执行Read()方法时，reader就会移动到JSON数据里面的下一个Token那里。
Token分成几种类型，GetTokenInfo方法就是判断一下Token的类型，并返回一些描述性信息，这里面应该是包含了所有的类型。这里面使用到了C#8的switch表达式。
运行程序
结果如下：
可以看到sample.json文件里面的每个Token都被正确的显示了。
JsonDocument类
JsonDocument是基于Utf8JsonReader构建的。JsonDocument可分析JSON数据并生成只读文档对象模型(DOM)，可对模型进行查询，以支持随机访问和枚举。使用JsonDocument分析常规JSON有效负载并访问其所有成员比使用Json.NET快2-3倍，且为合理大小(即< 1 MB)的数据所分配的量非常少。
JsonDocument可以处理Span，也可以处理Stream。
例子：
这里我通过File.OpenRead把json文件转化为stream。然后使用JsonDocument.Parse方法把stream解析成JSON文档对象模型。
注意，这里我使用了C# 8的using var语法，这个以后再说。
下面我们开始从这个JSON文档对象模型的根节点开始遍历，也就是RootElement：
然后通过root这个JsonElement类型的对象的GetProperty方法来获得相应的属性，而且这个方法可以连串使用：
最后一行使用GetString方法来获得该属性的字符串值。
然后我们可以写一个递归调用的方法来遍历整个模型的每个属性：
这个方法接受JsonElement类型的对象，然后对该元素的属性进行循环。
如果当前属性是另一个对象，那么就继续递归调用这个方法;
否则就输出原始的文本。
最后调用该方法：
输出结果为：
与json文件的内容匹配。
Utf8JsonWriter类
下面研究一下如何写入json文件。这里需要使用Utf8JsonWriter类。
直接看代码：
这个类需要传递的参数类型是Stream或者Buffer，也就是向Stream或Buffer里面写入数据。
那么就提供一个buffer：
下面单独写一个方法，来生成json数据：
参数类型是Utf8JsonWriter。通过智能提示可以看到它提供了很多用于写入不同类型数据的方法。
写JSON对象
现在我想写一个json对象，那么就从WriteStartObject()开始，然后以WriteEndObject()结束:
这样的话，实际上我已经拥有了一个合法的json文档。
写属性和值
可以分开写属性和值：
首先需要告诉writer把它的内容flush给buffer，使用这个buffer我们可以获得writer的输出，这样的话就会得到一个byte数组，然后把这个byte数组转化为字符串，这样就可以在控制台显示它了：
运行一下看看效果：
没啥太大的问题，就是格式不好看。
对输出进行格式化
.NET Core提供了一个JsonWriterOptions类，它可以对Writer进行一些设置。
这里对输出进行了缩进，最后把这个options传递给Utf8JsonWriter的构造函数即可。
再次运行：
现在好看多了。
JsonSerializer
前面几节的内容可能稍微有点底层，我们大部分时候可能只需要对C#的类进行串行化或者将JSON数据反串行化成C#类，在.NET Core3.0里面，我们可以使用JsonSerializer这个类来做这些事情。
例子:
还是使用之前用到的json数据：
然后我们需要建建立两个类，对应这个文件：
反串行化
可以使用JsonSerializer类的Deserialize()方法对json数据反串行化。这个方法支持三种类型的输入参数，分别是：
JSON数据的字符串
Utf8JsonReader
ReadOnlySpan
为了简单一点，我直接把json文件读取成字符串，然后传给Deserialize方法：
然后我试图打印出反串行化之后的一些属性数据。但是这不会成功。因为JSON文件里面数据的大小写命名规范使用的是camel casing(简单理解为首字母是小写的)，而默认情况下Deserializer会寻找Pascal casing这种规范(简单理解为每个单词的首字母都是大写的)的属性名。
格式化
为解决这个问题，就需要使用JsonSerializerOptions类：
建立该类的一个实例，设置PropertyNamingPolicy为CamelCase，然后把这个实例传递给Deserialize方法的第二个参数。
运行看结果:
这次就没有问题了。
串行化
JsonSerializer也支持串行化，也就是把C#数据转化为JSON数据：
这里使用了相同的options。
运行结果：
如果想让输出结果更好看一些，可以在JsonSerializerOptions里面进行相应的设置：
这次输出结果为：
总结
总结一下.NET Core 3.0新的JSONAPI：
Utf8JsonReader -读操作，快速，低级
Utf8JsonWriter -写操作，快速，低级
JsonDocument-基于DOM，快速
JsonSeriliazer -串行化/反串行化，快速
另外JSON.NET仍然被支持。
到此这篇关于详解.NET Core 3.0 里新的JSON API的文章就介绍到这了,更多相关.NET Core 3.0 JSON 内容请搜索服务器之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持服务器之家!
原文链接：https://www.cnblogs.com/cgzl/p/11736011.html