JsonConverter 等效于使用 System.Text.Json

Posted 2023-03-27

【中文标题】JsonConverter 等效于使用 System.Text.Json

【英文标题】：JsonConverter equivalent in using System.Text.Json

【发布时间】：2019-05-29 12:15:03

【问题描述】：

我开始在 .net Core 3.0 应用程序中将我拥有的一些代码从 Newtonsoft.Json 迁移到 System.Text.Json。

我从

迁移了属性

[JsonProperty("id")] 到 [JsonPropertyName("id")]

但我有一些用JsonConverter 属性装饰的属性：

[JsonConverter(typeof(DateTimeConverter))] [JsonPropertyName("birth_date")] DateTime BirthDate get; set;

但我在System.Text.Json 中找不到与此 Newtonsoft 转换器等效的东西有人知道如何在 .net Core 3.0 中实现这一点吗？

谢谢！

【问题讨论】：

用 Newtonsoft 代替迁移它不是更容易吗？

这是另一个问题，但我想知道这是否可以在System.Text.Json中实现

不确定新的 JSON 对象是否足够成熟以应对目前的所有情况，但很高兴被证明是错误的。不过，我相信让 .NET Core 3 使用 Newtonsoft 是一项改变。

【参考方案1】：

System.Text.Json 现在支持 .NET 3.0 preview-7 及更高版本中的自定义类型转换器。

您可以添加与类型匹配的转换器，并使用JsonConverter 属性将特定转换器用于属性。

这是一个在 long 和 string 之间转换的示例（因为 javascript 不支持 64 位整数）。

public class LongToStringConverter : JsonConverter<long>

    public override long Read(ref Utf8JsonReader reader, Type type, JsonSerializerOptions options)
    
        if (reader.TokenType == JsonTokenType.String)
        
            // try to parse number directly from bytes
            ReadOnlySpan<byte> span = reader.HasValueSequence ? reader.ValueSequence.ToArray() : reader.ValueSpan;
            if (Utf8Parser.TryParse(span, out long number, out int bytesConsumed) && span.Length == bytesConsumed)
                return number;

            // try to parse from a string if the above failed, this covers cases with other escaped/UTF characters
            if (Int64.TryParse(reader.GetString(), out number))
                return number;
        

        // fallback to default handling
        return reader.GetInt64();
    

    public override void Write(Utf8JsonWriter writer, long value, JsonSerializerOptions options)
    
        writer.WriteStringValue(value.ToString());
    

通过将转换器添加到JsonSerializerOptions 中的Converters 列表来注册转换器

services.AddControllers().AddJsonOptions(options =>

    options.JsonSerializerOptions.Converters.Add(new LongToStringConverter());
);

注意：当前版本还不支持可为空的类型。

【讨论】：

仅供参考：如果有人在 System.Text.Json 中搜索StringEnumConverter：using System.Text.Json.Serialization; [JsonConverter(typeof(JsonStringEnumConverter))]。检查docs.microsoft.com/en-us/dotnet/api/…。

如何转换为自定义类型？ x: foo:1,bar:2,baz:apple:1,orange:2, juice:[1,2,3,4,5]

@boop 您创建您的类型，然后编写一个继承自 JsonConverter<YourType> 的转换器，并使用您需要的读写逻辑。文档中有大量示例向您展示如何与 API 交互：docs.microsoft.com/en-us/dotnet/standard/serialization/…

@FranzHuber23 它确实序列化，但它不尊重EnumMember 属性值，因此枚举名称被序列化而不是System.Text.Json: JsonStringEnumConverter ignores its JsonNamingPolicy during deserialization. #31619

【参考方案2】：

您可以在命名空间System.Text.Json.Serialization 中找到JsonConverterAttribute。

https://docs.microsoft.com/en-us/dotnet/api/system.text.json.serialization.jsonconverterattribute?view=netcore-3.0