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

Question

我正在写一个 custom

System.Text.Json.JsonConverter<T>

将旧数据模型升级到新版本。我已经覆盖了

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

如 docs 中所述，转换器的选择具有以下优先级：

• [JsonConverter]

  应用于财产。
• 转换器添加到

  Converters

  集合中。

• [JsonConverter]

  应用于自定义值类型或 POCO。

另外还有一个案例：

• a

  JsonConverter<T>

  一些

  JsonConverterFactory

  当工厂通过以上三种方法中的任何一种应用时返回

每个案件都需要单独处理

1. 如果您将

   [JsonConverter]

   应用于属性。，那么只需调用

   JsonSerializer.Serialize(writer, person, options);

   将生成默认序列化。

2. 如果你有A转换器添加到

   Converters

   集合。，那么在

   Write()

   （或

   Read()

   ）方法中，你可以使用options复制构造函数复制传入的

   JsonSerializerOptions

   ，从副本的

   Converters

   列表中删除转换器，并将修改后的副本传递给

   JsonSerializer.Serialize<T>(Utf8JsonWriter, T, JsonSerializerOptions);

   这在 .NET Core 3.x 中无法轻松完成，因为该版本中不存在复制构造函数。临时修改传入选项的

   Converters

   集合以删除转换器不会不是线程安全的，因此不推荐。相反，需要创建新选项并手动复制每个属性以及

   Converters

   集合，跳过类型

   converterType

   .
   的转换

   请注意，这会导致树等递归类型的序列化出现问题，因为相同类型的嵌套对象最初不会使用转换器进行序列化。

3. 如果您有

   [JsonConverter]

   应用于自定义值类型或 POCO。 似乎没有生成默认序列化的方法。

4. 转换器列表中

   JsonConverter<T>

   返回的

   JsonConverterFactory

   的情况未由此答案解决，因为有必要禁用工厂，而不仅仅是转换器。在这种情况下，不清楚是完全禁用工厂，还是只针对特定的具体类型

   T

   .

由于在问题中，转换器被添加到

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)
    {
        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;

        public DefaultConverter(JsonSerializerOptions options, DefaultConverterFactory<T> factory)
        {
            this.factory = factory;
            this.modifiedOptions = options.CopyAndRemoveConverter(factory.GetType());
        }

        public override void Write(Utf8JsonWriter writer, T value, JsonSerializerOptions options) => factory.Write(writer, value, modifiedOptions);

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

    protected virtual T Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions modifiedOptions)
        => (T)JsonSerializer.Deserialize(ref reader, typeToConvert, modifiedOptions);

    protected virtual void Write(Utf8JsonWriter writer, T value, JsonSerializerOptions modifiedOptions) 
        => JsonSerializer.Serialize(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;
    }
}

备注：

• 我使用转换器工厂而不是转换器作为

  PersonConverter

  的基类，因为它允许我方便地在制造的转换器中缓存复制的选项。

• 如果您尝试将

  DefaultConverterFactory<T>

  应用于自定义值类型或 POCO，例如

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

  会发生讨厌的堆栈溢出。

演示小提琴这里.