如何反序列化包含对象或对象数组的JSON对象

Question

我正在尝试反序列化我从ARIN whois REST API返回的JSON响应。我是JSON的新手，但我认为他们会根据结果返回两种不同的模式，而且我很难将它分开。

如果有多个网络对象，则返回JSON的删节版本：

{
  "nets": {
    "@xmlns":{"ns3":"http:\/\/www.arin.net\/whoisrws\/netref\/v2",
    "net": [{
        "customerRef": {
          "@name": "Internet Customer",
        },
      }, {
        "orgRef": {
          "@name": "Internet Service Provider",
        },
      }
    ]
  }
}

请注意，网络是一个网络对象数组。当只返回一个网络对象时，JSON如下所示：

{
  "nets": {
    "@xmlns":{"ns3":"http:\/\/www.arin.net\/whoisrws\/netref\/v2",
    "net": {
        "orgRef": {
          "@name": "Internet Customer",
        },
      }
  }
}

在这种情况下，nets是一个包含单个net对象的对象。我可以使用数组或单个嵌入对象定义我的类，但使用JsonConvert.DeserializeObject<ARINWhois>(response)反序列化将在与我的模式不一致的结果上抛出异常。

我考虑过两种选择：

1. 用JsonTextReader手动反序列化。
2. 如果抛出异常，则定义两个对象模式并使用另一个重试。

是否有更简单，更优雅的解决方案？

Answer 1

感谢Eser22指导我使用JsonConverter，它完全符合我的需要。 How to Handle both a single item and an array for the same property是一个很好的解释。完美的工作！

这是我的代码的最终版本。

/*
 * parse the response
 */
ARINWhois WhoisResp = JsonConvert.DeserializeObject<ARINWhois>(response);

/*
 *  custom converter
 */
class SingleOrArrayConverter<T> : JsonConverter
{
  public override bool CanConvert(Type objectType)
  {
    return (objectType == typeof(List<T>));
  }

  public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
  {
    JToken token = JToken.Load(reader);
    if (token.Type == JTokenType.Array)
    {
      return token.ToObject<List<T>>();
    }
    return new List<T> { token.ToObject<T>() };
  }

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

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

/*
 * data models
 */
public class ARINWhois
{
  [JsonProperty("nets")]
  public ARINNets Network { get; set; }
}
public class ARINNets
{
  [JsonProperty("net")]
  [JsonConverter(typeof(SingleOrArrayConverter<ARINNet>))]
  public List<ARINNet> Networks;
}

public class ARINNet
{
  [JsonProperty("registrationDate")]
  public ARINregistrationDate RegistrationDate;
  [JsonProperty("orgRef")]
  public ARINorgRef Organization;
  [JsonProperty("customerRef")]
  public ARINcustomerRef Customer;
}
public class ARINregistrationDate
{
  [JsonProperty("$")]
  public string date { get; set; } 
}
public class ARINorgRef
{
  [JsonProperty("@name")]
  public string name { get; set; }
  [JsonProperty("@handle")]
  public string handle { get; set; }
}
public class ARINcustomerRef
{
  [JsonProperty("@name")]
  public string name { get; set; }
  [JsonProperty("@handle")]
  public string handle { get; set; }
}