為什么需要新的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資料型別，
直接上代碼：
Main方法里面，我們使用File.ReadAllBytes從sample.json檔案讀取數格式為byte[]，然后通過AsSpan這個擴展方法將其轉化為Span<byte>資料型別，然后把它傳遞到 Utf8JsonReader 的建構式來創建一個JSON的reader，
接下來使用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檔案，
寫屬性和值
可以分開寫屬性和值：
也可以同時把屬性和值寫出來：
顯示JSON資料
我先寫這些內容，然后在Main方法里面呼叫一下：
首先需要告訴writer把它的內容flush給buffer，使用這個buffer我們可以獲得writer的輸出，這樣的話就會得到一個byte陣列，然后把這個byte陣列轉化為字串，這樣就可以在控制臺顯示它了：
運行一下看看效果：
沒啥太大的問題，就是格式不好看，
對輸出進行格式化
.NET Core提供了一個JsonWriterOptions類，它可以對Writer進行一些設定，
這里對輸出進行了縮進，最后把這個options傳遞給Utf8JsonWriter的建構式即可，
再次運行：
現在好看多了，
JsonSerializer
前面幾節的內容可能稍微有點底層，我們大部分時候可能只需要對C#的類進行串行化或者將JSON資料反串行化成C#類，在.NET Core 3.0里面，我們可以使用JsonSerializer這個類來做這些事情，
例子:
還是使用之前用到的json資料：
然后我們需要建建立兩個類，對應這個檔案：
反串行化
可以使用JsonSerializer類的Deserialize()方法對json資料反串行化，這個方法支持三種型別的輸入引數，分別是：
-
JSON資料的字串
-
Utf8JsonReader
-
ReadOnlySpan<byte>，它里面包含JSON資料
為了簡單一點，我直接把json檔案讀取成字串，然后傳給Deserialize方法：
然后我試圖列印出反串行化之后的一些屬性資料，但是這不會成功，因為JSON檔案里面資料的大小寫命名規范使用的是camel casing（簡單理解為首字母是小寫的），而默認情況下Deserializer會尋找Pascal casing這種規范（簡單理解為每個單詞的首字母都是大寫的）的屬性名，
格式化
為解決這個問題，就需要使用JsonSerializerOptions類：
建立該類的一個實體，設定PropertyNamingPolicy為CamelCase，然后把這個實體傳遞給Deserialize方法的第二個引數，
運行看結果:
這次就沒有問題了，
串行化
JsonSerializer也支持串行化，也就是把C#資料轉化為JSON資料：
這里使用了相同的options，
運行結果：
如果想讓輸出結果更好看一些，可以在JsonSerializerOptions里面進行相應的設定：
這次輸出結果為：
總結
總結一下.NET Core 3.0新的JSON API：
-
Utf8JsonReader - 讀操作，快速，低級
-
Utf8JsonWriter - 寫操作，快速，低級
-
JsonDocument - 基于DOM，快速
-
JsonSeriliazer - 串行化/反串行化，快速
另外 JSON.NET 仍然被支持，
轉載請註明出處，本文鏈接：https://www.uj5u.com/net/101966.html
標籤：.NET Core