无法将JSON数组反序列化为类型 - Json.NET。

Question

我试图将JSON数据反序列化为一个模型类，但是失败了。这是我的操作步骤：

    public CountryModel GetCountries() {

        using (WebClient client = new WebClient()) {

            var result = client.DownloadString("http://api.worldbank.org/incomeLevels/LIC/countries?format=json");

            var output = JsonConvert.DeserializeObject<List<CountryModel>>(result);

            return output.First();
        }
    }

这是我的模型的样子：

public class CountryModel
{
    public int Page { get; set; }
    public int Pages { get; set; }
    public int Per_Page { get; set; }
    public int Total { get; set; }

    public List<Country> Countries { get; set; }
}

public class Country
{
    public int Id { get; set; }
    public string Iso2Code { get; set; }
    public string Name { get; set; }
    public Region Region { get; set; }
}

public class Region
{
    public int Id { get; set; }
    public string Value { get; set; }
}

您可以在此处查看我获取的Json：http://api.worldbank.org/incomeLevels/LIC/countries?format=json

这是我收到的错误：

无法将 JSON 数组反序列化为类型“Mvc4AsyncSample.Models.CountryModel”。行1，位置1。

- tugberk

---

那似乎不是一个好的JSON表示法。如果使用XML格式，可能会更好一些。 - svick

是的，我认为是这样。他们把一个单独的对象放在了一个数组里面。我认为这不应该出现。有没有可能绕过这个问题？ - tugberk

XML格式更加清晰，我会选择这个：http://api.worldbank.org/incomeLevels/LIC/countries?format=xml - Paul Tyng

@PaulTyng 我认为在我所知道的范围内，Json.NET序列化比.NET XML序列化要快得多。这就是为什么我坚持使用JSON的原因。但是我不确定自己是否百分之百正确。 - tugberk

@tugberk 哦，我明白了。如果速度是您关心的问题，您可能需要查看其他JSON库：http://theburningmonk.com/2011/08/performance-test-json-serializers/（或http://code.google.com/p/protobuf-net/） - Paul Tyng

Answer 1

你需要编写一个自定义的 JsonConverter:

    public class CountryModelConverter : JsonConverter
    {

        public override bool CanConvert(Type objectType)
        {
            if (objectType == typeof(CountryModel))
            {
                return true;
            }

            return false;
        }

        public override object ReadJson(JsonReader reader, Type objectType
            , object existingValue, JsonSerializer serializer)
        {
            reader.Read(); //start array
            //reader.Read(); //start object
            JObject obj = (JObject)serializer.Deserialize(reader);

            //{"page":1,"pages":1,"per_page":"50","total":35}
            var model = new CountryModel();

            model.Page = Convert.ToInt32(((JValue)obj["page"]).Value);
            model.Pages = Convert.ToInt32(((JValue)obj["pages"]).Value);
            model.Per_Page = Int32.Parse((string) ((JValue)obj["per_page"]).Value);
            model.Total = Convert.ToInt32(((JValue)obj["total"]).Value);

            reader.Read(); //end object

            model.Countries = serializer.Deserialize<List<Country>>(reader);

            reader.Read(); //end array

            return model;
        }

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

将该转换器与CountryModel标记（我还必须将一些int更改为string）：

    [JsonConverter(typeof(CountryModelConverter))]
    public class CountryModel
    {
        public int Page { get; set; }
        public int Pages { get; set; }
        public int Per_Page { get; set; }
        public int Total { get; set; }

        public List<Country> Countries { get; set; }
    }

    public class Country
    {
        public string Id { get; set; }
        public string Iso2Code { get; set; }
        public string Name { get; set; }
        public Region Region { get; set; }
    }

    public class Region
    {
        public string Id { get; set; }
        public string Value { get; set; }
    }

那么你应该可以像这样反序列化：

var output = JsonConvert.DeserializeObject<CountryModel>(result);

- Paul Tyng

---

你不能使用serializer.Deserialize<CountryModel>(reader)简化反序列化CountryModel属性吗？ - svick

如果你只需要读取，svick的答案更好，JsonConverter只有在你需要双向转换时才是必需的。 - Paul Tyng

@svick 我考虑过这个问题，但是 CountryModel 有这个属性，所以会陷入无限循环，如果对象模型改变了，它会更简单，但我试图保持他的对象模型。 - Paul Tyng

好的，我没想到那个。 - svick

Answer 2

这看起来像是一种将XML表示为JSON的（不太好的）尝试。JSON看起来像这样:

[
  {
    "page": 1,
    …
  },
  [
    {
      "id": "AFG",
      "name": "Afghanistan",
      …
    },
    {
      "id": "BDI",
      "name": "Burundi",
      …
    },
    …
  ]
]

一个合理的JSON（恰好可以很好地映射到您的模型）应该长这样：

{
  "page": 1,
  …,
  "countries": [
    {
      "id": "AFG",
      "name": "Afghanistan",
      …
    },
    {
      "id": "BDI",
      "name": "Burundi",
      …
    },
    …
  ]
}

如果您确定要使用 JSON（而不是 XML），您可以先将其反序列化为 JSON.NET 的对象模型，然后再将其反序列化为您的模型：

var json = client.DownloadString("http://api.worldbank.org/incomeLevels/LIC/countries?format=json");

var array = (JArray)JsonConvert.DeserializeObject(json);

var serializer = new JsonSerializer();

var countryModel = serializer.Deserialize<CountryModel>(array[0].CreateReader());

countryModel.Countries = serializer.Deserialize<List<Country>>(array[1].CreateReader());

return countryModel;

不要忘记将您的 Id 属性更改为 string，因为这就是它们的数据类型。

- svick

---

比我的版本简单多了，很好，我不知道你可以从内置对象中创建读取器。 - Paul Tyng

Answer 3

你的模型与JSON结构不匹配。看起来你缺少了最后6个属性。

{
"id": "AFG",
"iso2Code": "AF",
"name": "Afghanistan",
"region": {
    "id": "SAS",
    "value": "South Asia"
},
"adminregion": {
    "id": "SAS",
    "value": "South Asia"
},
"incomeLevel": {
    "id": "LIC",
    "value": "Low income"
},
"lendingType": {
    "id": "IDX",
    "value": "IDA"
},
"capitalCity": "Kabul",
"longitude": "69.1761",
"latitude": "34.5228"

}

- ChrisS

---

这不会影响反序列化过程。 - tugberk