如何在自定义 System.Text.Json JsonConverter 中使用默认序列化？

Question

我正在编写一个自定义System.Text.Json.JsonConverter来将旧数据模型升级到新版本。我已经覆盖Read()并实施了必要的后处理。但是，我根本不需要在Write()方法中做任何自定义。如果我根本没有转换器，如何自动生成默认序列化？显然我可以使用不同JsonSerializerOptions的反序列化和序列化，但是我的框架并没有直接为每个提供不同的选项。

下面是一个简化的例子。假设我以前有以下数据模型：

public record Person(string Name);

我已经升级到

public record Person(string FirstName, string LastName);

我写了一个转换器如下：

public sealed class PersonConverter : JsonConverter<Person>
{
    record PersonDTO(string FirstName, string LastName, string Name); // A DTO with both the old and new properties.

    public override Person Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        var dto = JsonSerializer.Deserialize<PersonDTO>(ref reader, options);
        var oldNames = dto?.Name?.Split(' ', StringSplitOptions.RemoveEmptyEntries) ?? Enumerable.Empty<string>();
        return new Person(dto.FirstName ?? oldNames.FirstOrDefault(), dto.LastName ?? oldNames.LastOrDefault());
    }

    public override void Write(Utf8JsonWriter writer, Person person, JsonSerializerOptions options)
        => // What do I do here? I want to preserve other options such as options.PropertyNamingPolicy, which are lost by the following call
        JsonSerializer.Serialize(writer, person);
}

和往返

var options = new JsonSerializerOptions
{
    PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
    Converters = { new PersonConverter() },
};
var person = JsonSerializer.Deserialize<Person>(json, options);
var json2 = JsonSerializer.Serialize(person, options);

那么结果是{"FirstName":"FirstName","LastName":"LastName"}——即序列化过程中的驼峰式外壳丢失了。但是如果我在编写时通过递归调用传递选项

    public override void Write(Utf8JsonWriter writer, Person person, JsonSerializerOptions options)
        => // What do I do here? I want to preserve other options such as options.PropertyNamingPolicy, which are lost by the following call
        JsonSerializer.Serialize(writer, person, options);

然后序列化因堆栈溢出而失败。

如何获得忽略自定义转换器的精确默认序列化？没有等同于 Json.NET 的JsonConverter.CanWrite属性。

演示小提琴在这里。

Answer 1

如文档中所述，转换器的选择优先级如下：

• [JsonConverter] 应用于属性。
• 添加到Converters集合中的转换器。
• [JsonConverter] 应用于自定义值类型或 POCO。

每个案例都需要单独处理。

1. 如果你[JsonConverter]申请了房产。，然后简单地调用JsonSerializer.Serialize(writer, person, options);将生成默认序列化。

2. 如果你有一个转换器添加到Converters集合中。，然后在Write()(or Read()) 方法中，您可以options使用JsonSerializerOptions复制构造函数复制传入的内容，从副本的Converters列表中删除转换器，并将修改后的副本传递到JsonSerializer.Serialize<T>(Utf8JsonWriter, T, JsonSerializerOptions);

   这在 .NET Core 3.x 中无法轻松完成，因为该版本中不存在复制构造函数。临时修改Converters传入选项的集合以删除转换器不是线程安全的，因此不建议这样做。相反，需要创建新选项并手动复制每个属性以及Converters集合，跳过 type 的转换converterType。

3. 如果您已[JsonConverter]申请自定义值类型或 POCO。似乎没有生成默认序列化的方法。

由于在问题中，转换器已添加到Converters列表中，因此以下修改后的版本正确生成了默认序列化：

public sealed class PersonConverter : DefaultConverterFactory<Person>
{
    record PersonDTO(string FirstName, string LastName, string Name); // A DTO with both the old and new properties.

    protected override Person Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions modifiedOptions, JsonConverter<Person> defaultConverter)
    {
        var dto = JsonSerializer.Deserialize<PersonDTO>(ref reader, modifiedOptions);
        var oldNames = dto?.Name?.Split(' ', StringSplitOptions.RemoveEmptyEntries) ?? Enumerable.Empty<string>();
        return new Person(dto.FirstName ?? oldNames.FirstOrDefault(), dto.LastName ?? oldNames.LastOrDefault());
    }
}

public abstract class DefaultConverterFactory<T> : JsonConverterFactory
{
    class DefaultConverter : JsonConverter<T>
    {
        readonly JsonSerializerOptions modifiedOptions;
        readonly DefaultConverterFactory<T> factory;
        readonly JsonConverter<T> defaultConverter;
        
        public DefaultConverter(JsonSerializerOptions options, DefaultConverterFactory<T> factory)
        {
            this.factory = factory;
            this.modifiedOptions = options.CopyAndRemoveConverter(factory.GetType());
            this.defaultConverter = (JsonConverter<T>)modifiedOptions.GetConverter(typeof(T));
        }
    
        public override void Write(Utf8JsonWriter writer, T value, JsonSerializerOptions options) => factory.Write(writer, value, modifiedOptions, defaultConverter);

        public override T Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => factory.Read(ref reader, typeToConvert, modifiedOptions, defaultConverter);
    }

    protected virtual T Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions modifiedOptions, JsonConverter<T> defaultConverter)
        => defaultConverter.ReadOrSerialize<T>(ref reader, typeToConvert, modifiedOptions);

    protected virtual void Write(Utf8JsonWriter writer, T value, JsonSerializerOptions modifiedOptions, JsonConverter<T> defaultConverter) 
        => defaultConverter.WriteOrSerialize(writer, value, modifiedOptions);

    public override bool CanConvert(Type typeToConvert) => typeof(T) == typeToConvert;
    
    public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializerOptions options) => new DefaultConverter(options, this);
}

public static class JsonSerializerExtensions
{
    public static JsonSerializerOptions CopyAndRemoveConverter(this JsonSerializerOptions options, Type converterType)
    {
        var copy = new JsonSerializerOptions(options);
        for (var i = copy.Converters.Count - 1; i >= 0; i--)
            if (copy.Converters[i].GetType() == converterType)
                copy.Converters.RemoveAt(i);
        return copy;
    }
    
    public static void WriteOrSerialize<T>(this JsonConverter<T> converter, Utf8JsonWriter writer, T value, JsonSerializerOptions options)
    {
        if (converter != null)
            converter.Write(writer, value, options);
        else
            JsonSerializer.Serialize(writer, value, options);
    }
    
    public static T ReadOrSerialize<T>(this JsonConverter<T> converter, ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        if (converter != null)
            return converter.Read(ref reader, typeToConvert, options);
        else
            return (T)JsonSerializer.Deserialize(ref reader, typeToConvert, options);
    }
}

笔记：

• 我使用转换器工厂而不是转换器作为基类，PersonConverter因为它允许我方便地在制造的转换器中缓存复制的选项和默认转换器。

• 如果您尝试将 aDefaultConverterFactory<T>应用于自定义值类型或 POCO，例如

  [JsonConverter(typeof(PersonConverter))] public record Person(string FirstName, string LastName);
  

  将发生令人讨厌的堆栈溢出。

演示小提琴在这里。