将JSON反序列化为多个属性

Question

我正在针对返回JSON数据的第三方API编程,但格式可能有点奇怪.某些属性可以是对象(包含Id属性),也可以是字符串(对象的Id).例如,以下两个都是有效的:

{
    ChildObject: 'childobjectkey1'
}

和

{
    ChildObject: {
        Id: 'childobjectkey1',
        // (other properties)
    }
}

我正在尝试使用JSON.net将其反序列化为强类型类,但到目前为止还没有太多运气.我最好的想法是将它序列化为两个属性,一个是字符串,另一个是对象,并为每个属性使用自定义JsonConverter来允许变量行为:

public abstract class BaseEntity
{
    public string Id { get; set; }
}

public class ChildObject : BaseEntity { }

public class MyObject
{
    [JsonProperty("ChildObject")]
    [JsonConverter(typeof(MyCustomIdConverter))]
    public string ChildObjectId { get; set; }

    [JsonProperty("ChildObject")]
    [JsonConverter(typeof(MyCustomObjectConverter))]
    public ChildObject ChildObject { get; set; }
}

但是,JsonProperty在具有相同PropertyName的两个属性上设置属性会导致异常:

Newtonsoft.Json.JsonSerializationException:'.....'上已存在名为'ChildObject'的成员.使用JsonPropertyAttribute指定其他名称.

我很确定如果我可以克服这个障碍,JsonConverter方法将会起作用 - 我怀疑错误是存在的,因为JsonProperty属性用于序列化以及反序列化.在这个例子中,我对序列化这个类没兴趣 - 它只会被用作反序列化的目标.

我无法控制远程端(它是第三方API),但我希望能够实现此序列化.我不介意它是否正在使用我开始使用的方法,或者我还没有想到的方法.

这个问题也有关系,但没有答案.

Answer 1

试试这个(如果你将在你的代码中使用它,通过一些彻底的验证来扩展它):

public class MyObject
{
    public ChildObject MyChildObject;
    public string MyChildObjectId;

    [JsonProperty("ChildObject")]
    public object ChildObject
    {
        get
        {
            return MyChildObject;
        }
        set
        {
            if (value is JObject)
            {
                MyChildObject = ((JToken)value).ToObject<ChildObject>();
                MyChildObjectId = MyChildObject.Id;
            }
            else
            {
                MyChildObjectId = value.ToString();
                MyChildObject = null;
            }
        }
    }
}

Answer 2

明智的做法是为“main”属性创建一个转换器并将另一个转换器链接到它，而不是为每个字段创建两个单独的转换器。 ChildObjectId是源自ChildObject.

public class MyObject
{
    [JsonIgnore]
    public string ChildObjectId
    {
        get { return ChildObject.Id; }

        // I would advise against having a setter here
        // you should only allow changes through the object only
        set { ChildObject.Id = value; }
    }

    [JsonConverter(typeof(MyObjectChildObjectConverter))]
    public ChildObject ChildObject { get; set; }
}

现在转换ChildObject可能有点困难。对象有两种可能的表示形式：字符串或对象。确定您拥有什么表示形式并执行转换。

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

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        serializer.Serialize(writer, value);
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        var obj = serializer.Deserialize<JToken>(reader);
        switch (obj.Type)
        {
        case JTokenType.Object:
            return ReadAsObject(obj as JObject);
        case JTokenType.String:
            return ReadAsString((string)(JValue)obj);
        default:
            throw new JsonSerializationException("Unexpected token type");
        }
    }

    private object ReadAsObject(JObject obj)
    {
        return obj.ToObject<ChildObject>();
    }

    private object ReadAsString(string str)
    {
        // do a lookup for the actual object or whatever here
        return new ChildObject
        {
            Id = str,
        };
    }
}