基于属性中的值类型反序列化对象

人气:960 发布:2022-10-16 标签: json c# json.net deserialization

问题描述

tl;dr:在json.net中有没有一种简单的方法来检查属性的类型并基于它创建实例?

我在JSON中有以下两个对象,它们是JSON API中的关系对象:

{ "data": { "type": "Test", "id": "1" } }

{ "data": [{ "type": "Test", "id": "1" }, { "type": "Test", "id": "2" }]}
使用json.net,我希望将这些对象序列化为ToOneRelation类或ToManyRelation类。这些类如下所示:

[JsonConverter(typeof(RelationshipConverter))]
abstract class Relation
{
    [JsonProperty("meta")]
    public Dictionary<string, object> Meta { get; set; }
}
class ToOneRelation : Relation
{
    [JsonProperty("data")]
    public object Data { get; set; }
}
class ToManyRelation : Relation
{
    [JsonProperty("data")]
    public List<object> Data { get; set; }
}

一般来说,我只知道我想要一个关系,所以我会做以下操作:

var result = JsonConvert.DeserializeObject<Relation>(json);

为了实例化正确的对象,我需要一个自定义转换器,我在其中检查"data"属性的类型。当类型为数组时,我使用ToManyRelation,否则我使用ToOneRelation。

目前,我创建了一个自定义转换器,它将遍历所有属性并反序列化它们。

object toOneData = null;
List<object> toManyRelationData = null;

Dictionary<string, object> meta = null;

reader.Read();
while (reader.TokenType == JsonToken.PropertyName)
{
    string propertyName = reader.Value.ToString();
    reader.Read();
    if (string.Equals(propertyName, "data", StringComparison.OrdinalIgnoreCase))
    {
        if (reader.TokenType == JsonToken.StartObject)
        {
            toOneData = serializer.Deserialize<object>(reader);
        }
        else if (reader.TokenType == JsonToken.StartArray)
        {
            toManyRelationData = serializer.Deserialize<List<object>>(reader);
        }
    }
    else if (string.Equals(propertyName, "meta", StringComparison.OrdinalIgnoreCase))
    {
        meta = serializer.Deserialize<Dictionary<string, object>>(reader);
    }
    else
    {
        reader.Skip();
    }
    reader.Read();
}

虽然这很有效,但我有一个问题,那就是这段代码并不是真正可维护的。一旦将额外的属性引入关系对象(或其他对象),我就需要修改此代码以反映这些更改。

所以我的问题是,有没有更好的方法来检查属性以确定要创建哪种类型,而不是使用serializer.Populate方法来完成其余的工作? (CustomCreationConverter不起作用,因为它无法在创建对象之前检查属性...)

(注意,工作示例可以找到here)

推荐答案

基于this answer我想出了以下解决方案:

public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
{
    var json = JToken.Load(reader);
    object relationship = CreateObject(json);
    if (relationship != null)
    {
        serializer.Populate(json.CreateReader(), relationship);
    }
    return relationship;
}
private object CreateObject(JToken token)
{
    if (token.Type == JTokenType.Null)
    {
        return null;
    }
    if (token["data"] == null)
    {
        return new ToOneRelation();
    }

    switch (token["data"].Type)
    {
        case JTokenType.Null:
        case JTokenType.Object:
            return new ToOneRelation();
        case JTokenType.Array:
            return new ToManyRelation();
        default:
            throw new Exception("Incorrect json.");
    }
}

272