关于 System.Text.Json 操作 JSON 的一些技巧

小渣渣

在 .NET Core 3.1 版本之前，我们对对象序列化和反序列化，通过需要引用第三方包，例如：Newtonsoft.Json，现在 .NET 已经自带对 JSON 操作的支持。System.Text.Json 命名空间提供用于序列化和反序列化 JavaScript 对象表示法 (JSON) 的功能。 System.Text.Json 库包含在 .NET Core 3.1 和更高版本的运行时中。

JsonSerializerOptions 线程安全

如果你通过相同的选项重复使用 JsonSerializerOptions，则请勿在每次使用时都创建新的 JsonSerializerOptions 实例。 对每个调用重复使用同一实例。 本指南适用于你为自定义转换器编写的代码，以及调用 JsonSerializer.Serialize 或 JsonSerializer.Deserialize时。 在多个线程中使用相同的实例是安全的。 选项实例上的元数据缓存是线程安全的，并且实例在第一次序列化或反序列化之后不可变。

参考：https://learn.microsoft.com/zh-cn/dotnet/standard/serialization/system-text-json/configure-options

序列化和反序列化

代码如下：

登录可见。

使用 ASP.NET Core 中 JSON 配置

如果想使用 ASP.NET Core 中的 JSON 全局配置，可以在构造函数注入如下：

登录可见。

使用 Web 版配置方案

JsonSerializerDefaults 枚举指定可用于构造 JsonSerializerOptions 实例的基于方案的默认序列化选项。

代码如下：

登录可见。

参考：https://learn.microsoft.com/zh-cn/dotnet/api/system.text.json.jsonserializerdefaults?view=net-8.0

小渣渣

使用 JsonNode 读取 JSON 字符串某个值

有时候，我们可能只需要读取 JSON 字符串里面某个值就行，新建一个对象，再反序列化成此对象比较麻烦，可以直接使用 JsonNode 读取 JSON 字符串某个值，代码如下：

登录可见。

小渣渣

序列化为 UTF-8 字节数组（Utf8Bytes）

序列化为 UTF-8 字节数组比使用基于字符串的方法快 5-10%。这是因为字节（UTF-8）不需要转换为字符串（UTF-16）。

要序列化为 UTF-8 字节数组，请调用JsonSerializer.SerializeToUtf8Bytes方法：

登录可见。

https://learn.microsoft.com/zh-cn/dotnet/standard/serialization/system-text-json/how-to

小渣渣

使用 System.Text.Json 移除字符串为 null 或者 "" 的数据，将 json 字符串反序列化成 object 对象，如果有几百个字段，很多都是记录为 null，为了节省传输，可以将这些字段移除。System.Text.Json 会将 json 字符串反序列化成 System.Text.Json.JsonElement。



代码如下：

登录可见。

JsonObject 不尊重 JsonIgnoreCondition.WhenWritingNull：https://github.com/dotnet/runtime/issues/54184

小渣渣

使用 JsonObject 直接创建对象，并且序列化成 json 字符串，如下图：



代码：

登录可见。

小渣渣

通过 [JsonPropertyName] 属性来自定义字段的序列化名称

登录可见。