System.Text.Json 是.NET 中提供的高性能 JSON 序列化器，但是它对于比较特殊的类型支持并不好，然而在实际项目中的需求总是各种各样的，很多时候我们需要自定义 Converter ，并且微软新出的 DateOnly 和 TimeOnly 也是需要自定义 Converter 来支持下面我们看一个简单的例子，需求是这样的：一个 id 可能是 string 也有可能是 int，想用同一个 Model 来保存结果。下面我们根据这个需求来分析一下该怎么做。如果 id 只是 int 或是可以转换为 int 的字符串，那么我们可以用 int 来表示，这是因为 System.Text.Json 已经支持解析带引号的数字，只需要配置 JsonNumberHandling 即可, 这个功能在 ASP.NET Core 中是默认是开启的。但是如果 id 的值不能转为数字怎么办？这时我们想到的是使用 string 来处理，这样我们设计的 model 是这样的：
public record Test{ public string Id { get; init; } = default!; public string? Name { get; set; }}
复制代码
但是如果我们的 json 是这种的{"Id": 1, "Name": "Test"}，JSON 在反序列化的时候时会报错。因此我们需要自定义 Converter 支持数字转换成字符串。实现自定义 Converter 的原则是属性的类型和泛型的类型是一样的，针对前面所提到的问题，实现代码如下：
public class StringOrIntConverter:JsonConverter<string>{ public override string Read(ref Utf8JsonReader reader, Type typeToConvert,JsonSerializerOptions options) { if (reader.TokenType == JsonTokenType.Number) { return reader.GetInt32().ToString(); } return reader.GetString(); }
public override void Write(Utf8JsonWriter writer, string value, JsonSerializerOptions options) { writer.WriteStringValue(value); }}
复制代码
使用这个自定义 Converter 有两种方法，一个是在属性上添加 JsonConverter，另一个是作为全局 Converter 使用，直接在 JsonSerializerOptions 中配置 Converter。下面的代码是两种方法的例子：
使用 Converter 属性
public record Test{ [JsonConverter(typeof(StringOrIntConverter))] public string Id { get; init; } = default!; public string? Name { get; set; }}
复制代码
2.配置 JsonSerializerOptions：
JsonSerializer.Deserialize<Test>(node.ToJsonString(), new JsonSerializerOptions{ Converters ={new StringOrIntConverter()}});
复制代码
这样我们就可以支持从 int 转换为 string 了。总结上述的代码，如下：
var tm = new Test{ Id = "123", Name = "456"};var jsonString = JsonSerializer.Serialize(tm);WriteLine(jsonString);var node = JsonNode.Parse(jsonString);ArgumentNullException.ThrowIfNull(node, nameof(node));node["Id"] = 123;var newJsonString = node.ToJsonString();WriteLine(newJsonString);var newModel = JsonSerializer.Deserialize<Test>(newJsonString);WriteLine(tm== newModel);
node["Name"] = 345;WriteLine(JsonSerializer.Deserialize<Test>(node.ToJsonString(), new JsonSerializerOptions{ Converters = { new StringOrIntConverter() }})?.Name);
复制代码
评论