具有多态子对象的类型的Json.Net序列化

一尘不染

具有多态子对象的类型的Json.Net序列化

我们希望能够从C＃类对json进行序列化/反序列化，而主类具有一个多态子对象的实例。使用Json.Net的TypeNameHandling.Auto设置很容易做到。但是，我们希望没有“
$ type”字段。

首先想到的是能够将“ $ type”重命名为我们选择的值，并使该类型的值成为可以正确映射子类型的枚举。我没有看到这是一个选择，但是很高兴听到是否有可能。

第二个想法是根据以下几行进行的…下面是类的第一步，顶层类具有一个指示符（SubTypeType），用于指示子对象（SubTypeData）中包含什么类型的数据。我已经研究了Json.Net文档，尝试了一些尝试，但是没有运气。

我们目前对数据定义拥有完全的控制权，但是一旦将其部署，就将一切锁定。

public class MainClass
{
  public SubType          SubTypeType { get; set; }
  public SubTypeClassBase SubTypeData { get; set; }
}

public class SubTypeClassBase
{
}

public class SubTypeClass1 : SubTypeClassBase
{
  public string AaaField { get; set; }
}

public class SubTypeClass2 : SubTypeClassBase
{
  public string ZzzField { get; set; }
}

阅读 300

2020-05-19

共1个答案

一尘不染

在容器类中具有子类型信息存在问题，原因有两个：

当Json.NET读取包含的类时，无法访问容器类实例。
如果以后需要将SubTypeClassBase属性转换为列表，则将无处放置子类型信息。

相反，我建议将子类型信息作为属性添加到基类中：

[JsonConverter(typeof(SubTypeClassConverter))]
public class SubTypeClassBase
{
    [JsonConverter(typeof(StringEnumConverter))] // Serialize enums by name rather than numerical value
    public SubType Type { get { return typeToSubType[GetType()]; } }
}

现在，每当可分配给其的对象被序列化时，自定义子类型枚举都将被序列SubTypeClassBase化。完成此操作后，对于反序列化，您可以创建一个JsonConverter将给定的json加载SubTypeClassBase到临时库中JObject，检查"Type"属性值，并将JSON对象反序列化为适当的类。

原型实现如下：

public enum SubType
{
    BaseType,
    Type1,
    Type2,
}

[JsonConverter(typeof(SubTypeClassConverter))]
public class SubTypeClassBase
{
    static readonly Dictionary<Type, SubType> typeToSubType;
    static readonly Dictionary<SubType, Type> subTypeToType;

    static SubTypeClassBase()
    {
        typeToSubType = new Dictionary<Type,SubType>()
        {
            { typeof(SubTypeClassBase), SubType.BaseType },
            { typeof(SubTypeClass1), SubType.Type1 },
            { typeof(SubTypeClass2), SubType.Type2 },
        };
        subTypeToType = typeToSubType.ToDictionary(pair => pair.Value, pair => pair.Key);
    }

    public static Type GetType(SubType subType)
    {
        return subTypeToType[subType];
    }

    [JsonConverter(typeof(StringEnumConverter))] // Serialize enums by name rather than numerical value
    public SubType Type { get { return typeToSubType[GetType()]; } }
}

public class SubTypeClass1 : SubTypeClassBase
{
    public string AaaField { get; set; }
}

public class SubTypeClass2 : SubTypeClassBase
{
    public string ZzzField { get; set; }
}

public class SubTypeClassConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(SubTypeClassBase);
    }

    public override bool CanWrite { get { return false; } }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        var token = JToken.Load(reader);
        var typeToken = token["Type"];
        if (typeToken == null)
            throw new InvalidOperationException("invalid object");
        var actualType = SubTypeClassBase.GetType(typeToken.ToObject<SubType>(serializer));
        if (existingValue == null || existingValue.GetType() != actualType)
        {
            var contract = serializer.ContractResolver.ResolveContract(actualType);
            existingValue = contract.DefaultCreator();
        }
        using (var subReader = token.CreateReader())
        {
            // Using "populate" avoids infinite recursion.
            serializer.Populate(subReader, existingValue);
        }
        return existingValue;
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }
}

2020-05-19