System.Text.Json 中的 JsonExtensionData

Intro

最近兩天在排查我們 API 的一個(gè)問(wèn)題，查看源碼過(guò)程中發(fā)現(xiàn) System.Text.Json 里有一個(gè)有意思的 JsonExtensionData

在反序列化的時(shí)候，如果反序列化的 Model 中沒(méi)有對(duì)應(yīng)的屬性信息，這些信息就會(huì)丟失，只會(huì)保留 Model 里有的數(shù)據(jù)，而 JsonExtensionData 則可以將這些沒(méi)有對(duì)應(yīng)屬性的信息也保留下來(lái)，在序列化的時(shí)候也會(huì)保留下來(lái)。

Sample

直接來(lái)看示例吧：

定義的 Model 如下，這里使用了 C# 9 引入的 record 來(lái)簡(jiǎn)化代碼

public?record?Person(string?Name,?int?Age);

如果我們的 JSON 字符串正好只有這兩個(gè)屬性的話

JsonSerializer.Serialize(new{Name?=?"Ming",Age?=?10,});

如果是這樣的，那么也不會(huì)有什么問(wèn)題

如果 JSON 字符串會(huì)有更多的信息，比如：

JsonSerializer.Serialize(new{Name?=?"Ming",Age?=?10,Title?=?"SDE",City?=?"Shanghai"});

可以看到，這個(gè) JSON 會(huì)有更多的信息，會(huì)包含 Model 里沒(méi)有定義的 City 和 Title

此時(shí)在使用上面的 Model 就會(huì)出現(xiàn)信息丟失，Title 和 City 的信息就會(huì)丟掉了，System.Text.Json 提供了一種方式 JsonExtensionData ?來(lái)保存這些在 Model 里沒(méi)有定義的屬性/字段信息

使用 JsonExtensionData 的屬性/字段有類型要求，需要是以下三種類型之一：

• IDictionary<string, object>

• IDictionary<string, JsonElement>

• JsonObject(.NET 6 新增支持)

于是我們就有了下面的測(cè)試 Model

public?record?Person(string?Name,?int?Age);public?record?Person1(string?Name,?int?Age)?:?Person(Name,?Age) {[JsonExtensionData]public?Dictionary<string,?object?>?Extensions?{?get;?set;?}?=?new(); }public?record?Person2(string?Name,?int?Age)?:?Person(Name,?Age) {[JsonExtensionData]public?Dictionary<string,?JsonElement>?Extensions?{?get;?set;?}?=?new(StringComparer.OrdinalIgnoreCase); }public?record?Person3(string?Name,?int?Age)?:?Person(Name,?Age) {[JsonExtensionData]public?JsonObject??Extensions?{?get;?set;?} }

測(cè)試代碼如下：

var?p1?=?JsonSerializer.Deserialize<Person1>(jsonString); ArgumentNullException.ThrowIfNull(p1,?nameof(p1)); WriteLine(JsonSerializer.Serialize(p1.Extensions));var?p2?=?JsonSerializer.Deserialize<Person2>(jsonString); ArgumentNullException.ThrowIfNull(p2,?nameof(p2)); WriteLine(JsonSerializer.Serialize(p2.Extensions));var?p3?=?JsonSerializer.Deserialize<Person3>(jsonString); ArgumentNullException.ThrowIfNull(p3,?nameof(p3)); WriteLine(JsonSerializer.Serialize(p3.Extensions));

輸出結(jié)果如下：

可以看到使用了 JsonExtensionData 之后，多余的信息也會(huì)保存下來(lái)，把 Extensions 打印一下都是一樣的結(jié)果

Extensions 中保存了我們沒(méi)有匹配到的信息，這樣我們就可以獲取到那些可能會(huì)丟失掉的數(shù)據(jù)了

我們可以把整個(gè)對(duì)象直接打印出來(lái)

using?static?System.Console;var?p?=?JsonSerializer.Deserialize<Person>(jsonString); ArgumentNullException.ThrowIfNull(p,?nameof(p)); WriteLine(JsonSerializer.Serialize(p));var?p1?=?JsonSerializer.Deserialize<Person1>(jsonString); ArgumentNullException.ThrowIfNull(p1,?nameof(p1)); WriteLine(JsonSerializer.Serialize(p1));var?p2?=?JsonSerializer.Deserialize<Person2>(jsonString); ArgumentNullException.ThrowIfNull(p2,?nameof(p2)); WriteLine(JsonSerializer.Serialize(p2));var?p3?=?JsonSerializer.Deserialize<Person3>(jsonString); ArgumentNullException.ThrowIfNull(p3,?nameof(p3)); WriteLine(JsonSerializer.Serialize(p3)); WriteLine(new?string('-',?20));

輸出結(jié)果如下：

output

More

借助 JsonExtensionData 我們可以實(shí)現(xiàn)一些比較靈活的擴(kuò)展，沒(méi)有用過(guò)的童鞋不妨試一下

細(xì)心的童鞋可能會(huì)發(fā)現(xiàn)最后一個(gè)輸出的結(jié)果會(huì)有一些不同，這是一個(gè) BUG 可以參考 issue: https://github.com/dotnet/runtime/issues/60806

上述示例可以在 Github 獲取 https://github.com/WeihanLi/SamplesInPractice/blob/master/JsonSample/SystemTextJsonSample/JsonExtensionDataSample.cs

References

• https://github.com/WeihanLi/SamplesInPractice/blob/master/JsonSample/SystemTextJsonSample/JsonExtensionDataSample.cs

• https://docs.microsoft.com/en-us/dotnet/standard/serialization/system-text-json-handle-overflow?WT.mc_id=DT-MVP-5004222

• https://docs.microsoft.com/en-us/dotnet/api/system.text.json.serialization.jsonextensiondataattribute?WT.mc_id=DT-MVP-5004222

• https://github.com/dotnet/runtime/issues/61080

總結(jié)

以上是生活随笔為你收集整理的System.Text.Json 中的 JsonExtensionData的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。