你的位置:首页 > 信息动态 > 新闻中心
信息动态
联系我们

System.Text.Json自定义Conveter

2021-11-21 14:12:41

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。下面的代码是两种方法的例子:

  1. 使用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);