.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示例文件: 

"post Title": "Programming" , 
"language": 
"author": 
"firstName": "Nick", 
"lastName": "Carter" 
"publishedAt 
"wordCount " : 
13435, 
"isoriginal"• 
true, 
"tags" • 
• "C#", "JSON API", ".NET Core" ]

 

针对这个文件,需要修改一下它的属性: 

sample.json File P 「 operties 
Advanced 
Custom T00 一 Namespace 
Custom T00- 
Copy to Output 「 to 
Build Action 
〔 を

 

Utf8JsonReader 

先使用 Utf8JsonReader 来读取JSON文件。 

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

 

直接上代码: 

static void Elgin(stringC] 
gx•gs 
File . ReadAllBytes( path: "sample.json" ); 
var dataBytes 
dataBytes .AsSpan( ) ; 
var jsonSpan 
new Utf8JsonReader(jsonSpan); 
var jsonReader = 
while (jsonReader.Read()) 
Console . jsonReader)); 
I reference 
private static string GetTokenInfo(Utf8JsonReader jsonReader) 
jsonReader . TokenType switch 
JsonTokenType.StartObject 
"START OBJECT" , 
JsonTokenType 
. EndObject "END OBJECT" , 
JsonTokenType.StartArray 
"START ARRAY" , 
JsonTokenType. EndArray "End ARRAY" , 
JsonTokenType. PropertyName $ " PROPERTY: {jsonReader.GetString()}" , 
$"COMMENT: {jsonReader.GetString()}" , 
JsonTokenType 
. Comment 
JsonTokenType.String $"STRING: {jsonReader.GetString()}" , 
$"NUMBER: {jsonReader.GetInt32()}" , 
JsonTokenType.Number 
$"BOOL: {jsonReader.GetBoolean()}" , 
JsonTokenType 
. True 
$"BOOL: {jsonReader.GetBoolean()}" , 
JsonTokenType 
JsonTokenType.Null 
"NULL" , 
$ TOKEN: {jsonReader.TokenType}"

Main方法里面,我们使用File.ReadAllBytessample.json文件读取数格式为byte[],然后通过AsSpan这个扩展方法将其转化为Span<byte>数据类型,然后把它传递到 Utf8JsonReader 的构造函数来创建一个JSON的reader 

 

接下来使用while循环对JSON数据的每个Token进行读取,每次执行Read()方法时,reader就会移动到JSON数据里面的下一个Token那里。 

 

Token分成几种类型,GetTokenInfo方法就是判断一下Token的类型,并返回一些描述性信息,这里面应该是包含了所有的类型。这里面使用到了C# 8  switch 表达式。 

 

运行程序 

结果如下: 

hema Selected> 
"post Title": "Programming" , 
"language": 
"author": 
"lastName": "Carter" 
"firstName": 
"publishedAt 
"Nick", 
"wordCount " : 
13435, 
"isoriginal"• 
true, 
"tags" • 
• "C#", "JSON 
API", ".NET Core" 
PROPERTY: postTit1e 
STRING: Programming 
PROPERTY: language 
STRING: 
PROPERTY: author 
START OBJECT 
PROPERTY: firstName 
STRING: Nick 
PROPERTY: lastName 
STRING: carter 
END OBJECT 
PROPERTY: publishedAt 
STRING: 
PROPERTY: wordcount 
NUMBER: 13435 
PROPERTY: isoriginal 
BOOL: True 
PROPERTY: tags 
START ARRAY 
STRING: 
STRING: JSON API 
STRING: .NET core 
End ARRAY 
END OBJECT

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

 

JsonDocument 

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

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

 

例子: 

using 
using 
var 
var 
File .0penRead( path: 
"sample.json"); 
stream = 
JsonDocument . Parse( stream) ; 
doc

这里我通过File.OpenReadjson文件转化为stream。然后使用JsonDocument.Parse方法把stream解析成JSON文档对象模型。 

注意,这里我使用了C# 8using var语法,这个以后再说。 

 

下面我们开始从这个JSON文档对象模型的根节点开始遍历,也就是RootElement 

root 
var 
doc . Root Element;

 

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

firstName 
var 
root .GetProperty( "author") 
. GetProperty( "firstName" ) 
. GetString( ) ;

最后一行使用GetString方法来获得该属性的字符串值。 

 

然后我们可以写一个递归调用的方法来遍历整个模型的每个属性: 

EnumerateElement(JsonElement root) 
private static void 
foreach (var prop in root. EnumerateObject()) 
if (prop.Value.ValueKind = 
JsonValueKind .0bject) 
Console . WriteLine($" {prop . Name}" ) ; 
Console.WriteLine(" 
- Object Start - 
EnumerateElement(prop . Value); 
Console.WriteLine(" 
Object End 
else 
{prop. Value.GetRawText()}");

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

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

否则就输出原始的文本。 

 

最后调用该方法: 

File. OpenRead( 
"sample.json"); 
using var stream 
path: 
JsonDocument . Parse( stream) ; 
using var doc - 
doc . Root Element; 
var root 
var firstName 
root .GetProperty( "author") 
. GetProperty( "firstName" ) 
. GetString( ) 
Console.WriteLine($"First Name is {firstName}"); 
EnumerateElement(root);

 

输出结果为: 

First Name 
post Title: 
language: 
author 
is Nick 
" Programmi ng" 
Object Start 
irstName: "Nick" 
lastName: "Carter" 
Object End 
publishedAt : 
22T2ø: 21 . eeøz" 
rdcount: 13435 
isoriginal: true 
ags: [ "C#", " 
JSON API 
% ".NET core" :

与json文件的内容匹配。 

 

Utf8JsonWriter 

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

直接看代码: 

这个类需要传递的参数类型是Stream或者Buffer,也就是向StreamBuffer里面写入数据。 

 

那么就提供一个buffer 

var buffer = 
new 
= new Utf8JsonWriter(buffer); 
using var 
'son

 

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

PopulateJson(Utf8JsonWriter json) 
private static void 
Json. 
write 
W rite 
W r ite Base64St ringVaIue 
W r ite Boolean 
W r ite BooleanVaIue 
W r iteCo m mentVaIue 
Write EndArray 
W r ite EndObject 
Wr iteNuII 
W r ite NullVaIue 
Write Number 
W rite Nu mbe rVaIue 
void 
void 
void 
void 
void 
void 
void 
void 
void 
void 
void 
(JsonEncodedText propertyName, ReadOnIyS 
Writes the pre-encoded property name and 
a name/value pair of a JSON object. 
utf8PropertyName, Re; 
propertyName, ReadO 
(string propertyName,

参数类型是Utf8JsonWriter。通过智能提示可以看到它提供了很多用于写入不同类型数据的方法。 

 

JSON对象 

现在我想写一个json对象,那么就从WriteStartObject()开始,然后以WriteEndObject()结束: 

json . WriteStartObject( ); 
json.WriteEndObject();

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

 

写属性和值 

可以分开写属性和值: 

json . WritePropertyName( "title"); 
json . WriteStringValue( " Programming" ) ;

 

也可以同时把属性和值写出来: 

json .WriteString( propertyName: "language" , 
"C#"); 
value:

 

显示JSON数据 

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

grgs) 
static void Mgin(stringC] 
new ArrayBufferWriter<byte>(); 
var buffer - 
new Utf8JsonWriter(buffer); 
using var Ison = 
PopulateJson( j son) ; 
I reference 
private static void PopulateJson(Utf8JsonWriter json) 
Json. 
Json. 
Json. 
Json. 
Json. 
Json. 
Json. 
WriteStartObject( ) ; 
WritePropertyName( "title"); 
WriteStringValue( " Programming" ) ; 
WriteString( propertyName: "language" , 
WriteString( propertyName: "firstName" , 
WriteString( propertyName: "lastName" , 
WriteEndObject( ) ; 
"C#"); 
value: 
"Nick"); 
value: 
"Carter"); 
value:

 

首先需要告诉writer把它的内容flush给buffer,使用这个buffer我们可以获得writer的输出,这样的话就会得到一个byte数组,然后把这个byte数组转化为字符串,这样就可以在控制台显示它了: 

new ArrayBufferWriter<byte>(); 
var buffer = 
new Utf8JsonWriter(buffer); 
using var Ison = 
PopulateJson( json); 
json. Flush(); 
var output = buffer.WrittenSpan.ToArray(); 
Encoding. UTF8. GetString(output); 
var outJson - 
Console. WriteLine(outJson);

 

运行一下看看效果: 

{"title" : "Programming" , "language" : "C#" , "firstName" : "Nick" , "lastName" : "Carter"}

没啥太大的问题,就是格式不好看。 

 

对输出进行格式化 

.NET Core提供了一个JsonWriterOptions类,它可以对Writer进行一些设置。 

var options = 
Indented = 
new JsonWriterOptions 
true 
new Utf8JsonWriter(buffer, 
using var Ison = 
options);

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

 

再次运行: 

"title": "Programming", 
"language" • " 
"firstName": "Nick", 
"lastName" : "Carter"

现在好看多了。 

 

JsonSerializer 

前面几节的内容可能稍微有点底层,我们大部分时候可能只需要对C#的类进行串行化或者将JSON数据反串行化成C#类,在.NET Core 3.0里面,我们可以使用JsonSerializer这个类来做这些事情。 

 

例子:

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

"post Title": "Programming" 
"language": 
"author": 
"firstName": "Nick", 
"lastName": "Carter" 
"publishedAt 
"wordCount " : 
13435, 
"isoriginal"• 
true, 
"tags" • 
"JSON API", ".NET Core"

 

然后我们需要建建立两个类,对应这个文件: 

public class 
BlogPost 
O references 
public 
O references 
public 
O references 
public 
O references 
public 
O references 
public 
O references 
public 
public 
I reference 
{ get; set; } 
string 
Post Title 
{ get; set; } 
string 
Language 
{ get; set; } 
Author Author 
{ get; set; 
DateTime PublishedAt 
{ get; set; } 
int 
WordCount 
{ get; set; } 
bool 
Isoriginal 
:iag$ 
{ get; set; } 
stringC] 
public class Author 
O references 
{ get; set; } 
public string 
FirstName 
O references 
{ get; set; } 
public string 
LastName

 

反串行化 

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

  • JSON数据的字符串 

  • Utf8JsonReader 

  • ReadOnlySpan<byte>,它里面包含JSON数据 

 

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