使用 System.Text.Json.Serialization.JsonConverter 解析 JSON 序列化过程中复杂类型的循环引用

有一个复杂类型引用相同类型的对象（有时是同一对象）：

public class User
{
    public string Name { get; set; }

    public int Age { get; set; }

    public User Reference { get; set; }
}

有一个自定义 JsonConverter (System.Text.Json.Serialization) 实现来反序列化此对象，避免一些特殊属性。

public class UserJsonConverter : JsonConverter<User>
{
    public override User Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        throw new NotImplementedException();
    }

    public override void Write(Utf8JsonWriter writer, User value, JsonSerializerOptions options)
    {
        writer.WriteStartObject();

        // write the name property only and ignore the age
        writer.WriteString(nameof(value.Name), value.Name);

        writer.WritePropertyName(nameof(value.Reference));
        JsonSerializer.Serialize(writer, value.Reference, options);

        writer.WriteEndObject();
    }
}

但尚不清楚在对象指向自身的情况下如何配置引用解析。例子：

var user = new User
{
    Age = 10,
    Name = "username"
};

user.Reference = user;

var options = new JsonSerializerOptions();
options.ReferenceHandler = ReferenceHandler.Preserve;
options.Converters.Add(new UserJsonConverter());

var result = JsonSerializer.Serialize(user, user.GetType(), options);

异常发生：

System.Text.Json.JsonException. A possible object cycle was detected. This can either be due to a cycle or if the object depth is larger than the maximum allowed depth of 64. Consider using ReferenceHandler.Preserve on JsonSerializerOptions to support cycles

我们使用System.Text.Json，版本=5.0.0.0

默认对象转换器的所有基于“$ref”和“$id”的方法都是内部的，不可使用。我看到的唯一方法是在序列化之前简化某些 DTO 中的 User 对象，并在没有此自定义转换器的情况下使用它。

但也许有人知道是否有正确的方法来解析自定义 JsonConverter 中的这些引用？

基于自定义引用处理程序使用的解决方案

UserJsonConverter 更改：

public override void Write(Utf8JsonWriter writer, User value, JsonSerializerOptions options)
{
    // use reference handler manually
    var v_resolver = options.ReferenceHandler?.CreateResolver();
    if (v_resolver != null)
    {
        var v_refID = v_resolver.GetReference(value, out bool alreadyExists);
        if (alreadyExists)
        {
            writer.WriteStartObject();
            writer.WriteString(JsonEncodedText.Encode("$ref", encoder: null), v_refID);
            writer.WriteEndObject();
            return;
        }
        else
        {
            writer.WriteStartObject();
            writer.WriteString(JsonEncodedText.Encode("$id", encoder: null), v_refID);
        }
    }

    //writer.WriteStartObject();

    ...
}

用法变化：

...
var options = new JsonSerializerOptions();
options.ReferenceHandler = new CutomReferenceHandler();
...

自定义参考处理程序实现可在此处获得：https://github.com/dotnet/docs/issues/21777#issuecomment-736751404 https://github.com/dotnet/docs/issues/21777#issuecomment-736751404 or docs https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json-preserve-references?pivots=dotnet-5-0#persist-reference-metadata-across-multiple-serialization-and-deserialization-calls

它有效，但我有点害怕以这种方式使用它，因为内部引用解析器逻辑将来可能会改变（$id，$refs）。