c# - 使用不同的模式反序列化 JSON

Question

我在 .NET 4.7 中使用 JSON.Net。

在我调用的 API 中，对于同一个调用，我可以随机获得两种错误 json :(。

错误类型 1:

{
   "Code": 0,
   "Msg": ["Some Warning"]
}

错误类型 2:

{
    "Code": 0,
    "Msg": [
          {"Error": 5 },
          {"Error": 6 }
    ]
}

如您所见，Msg 改变了它的结构。我想要一个通用的 POCO 来反序列化，但是当 Msg 发生变化时如何？

JsonConvert.DeserializeObject<MyCommonPoco>(theJson);

Answer 1

您可以 write a custom JsonConverter处理不同的类型。例如，您可以拥有以下 JSON:

{
    "Code": 0,
    "Msg": [
        "A single string",
        { "Message": "An object with a message" },
        { "Message": "An object with a message and a code", "Code": 5 },
        { "Code": 5 }
    ]
}

在此示例中，Msg 数组可以包含原始字符串或复杂对象。该对象可以包含 Message、Code 或两者。

您可以为此选择最常见的数据结构，一种能够表示所有信息的数据结构。这意味着，例如，您必须将该原始字符串包装到一个兼容的对象中。

public class Error
{
    public int Code { get; set; }
    public ErrorMessage[] Msg { get; set; }
}

public class ErrorMessage
{
    public string Message { get; set; }
    public int? Code { get; set; }
}

然后你可以使用自定义

然后，使用自定义 JsonConverter ，你可以解析上面的 JSON:

public class ErrorMessageConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
        => objectType == typeof(ErrorMessage);

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        // handle the primitive string
        if (reader.TokenType == JsonToken.String)
            return new ErrorMessage { Message = (string)reader.Value };

        // handle a complex object; just assume that it is an `ErrorMessage` here
        else if (reader.TokenType == JsonToken.StartObject)
            return JObject.Load(reader).ToObject<ErrorMessage>();

        throw new NotSupportedException();
    }

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

这将是使用该转换器的一种方式:

// the single quotes are just here to make it more readable; JSON.NET support this
// although it isn’t valid JSON
var json = @"{
    'Code': 0,
    'Msg': [
        'A single string',
        { 'Message': 'An object with a message' },
        { 'Message': 'An object with a message and a code', 'Code': 5 },
        { 'Code': 5 }
    ]
}";

var settings = new JsonSerializerSettings()
settings.Converters.Add(new ErrorMessageConverter());

var result = JsonConvert.DeserializeObject<Error>(json, settings);