如何使用Json.Net将JSON数组反序列化为对象？

Question

我有一个有效的JSON对象，其中包含一个JSON数组。JSON数组没有花括号，其中包含一个混合类型的逗号分隔列表。它看起来像这样:

{
    "ID": 17,
    "Days": 979,
    "Start_Date": "10/13/2012",
    "End_Date": "11/12/2012",
    "State": "",
    "Page": 1,
    "Test": "Valid",
    "ROWS": [
        [441210, "A", "12/31/2009", "OK", "Done", "KELLEY and Co'", "12/31/2009", "06/29/2010", "TEXAS", "Lawyers", 6, "", "<img src=\"/includes/images/Icon_done.gif\" border=\"0\" alt=\"Done\" title=\"Done\" />"],
        [441151, "B", "12/31/2009", "No", "In-process", "Sage & Co", "12/31/2009", "06/29/2010", "CALIFORNIA", "Realtor", 6, "", "<img src=\"/includes/images/Icon_InProcess.gif\" border=\"0\" alt=\"In Process\" title=\"In Process\" />"]
    ]
}

我创建了一个类来反映JSON结构，其中包含复杂数组的List：

class myModel
{
    public int ID { get; set; }
    public int Days { get; set; }
    public DateTime StartDate { get; set; }
    public DateTime EndDate { get; set; }
    public string State { get; set; }
    public string Page { get; set; }
    public string Test { get; set; }
    List<ChildModel> Rows { get; set; }
}

我也已经用一个列表的列表进行了测试：

List<List<ChildModel>> Rows { get; set; }

还有这样的子模型：

class ChildModel
{
    public int ID { get; set; }
    public string StatusId { get; set; }
    public DateTime ContactDate { get; set; }
    public string State { get; set; }
    public string Status { get; set; }
    public string CustomerName { get; set; }
    public DateTime WorkStartDate { get; set; }
    public DateTime WorkEndDate { get; set; }
    public string Territory { get; set; }
    public string CustType { get; set; }
    public int JobOrder { get; set; }
    public string Filler { get; set; }
    public string Link { get; set; }
}

在我的program.cs文件中，我是这样反序列化的：

using (StreamReader r = new StreamReader(@"D:\01.json"))
{
    myModel items = JsonConvert.DeserializeObject<myModel>(r.ReadToEnd());
}

当我运行这个程序时，子对象（Rows）总是null。我做错了什么？

- SJaka

---

所以您的意思是 ChildModel 被序列化为数组而不是对象？序列化是否超出了您的控制？ - 15ee8f99-57ff-4f92-890c-b56153

我猜这是因为你的列表中的内容与你的ChildModel类之间没有映射。反序列化器怎么知道将哪个值放入模型的哪个属性中呢？如果可能的话，修复序列化，否则构建一个自定义解析器，并祈求上帝不要改变列表中数据的顺序。 - Erik Kinding

要将该数组反序列化为 ChildModel，您可以使用来自 C# JSON.NET - Deserialize response that uses an unusual data structure 的 ObjectToArrayConverter<ChildModel>。 - dbc

@EdPlunkett，是的，我无法控制该序列化。我只是使用供应商提供的服务。 - SJaka

尝试这个解决方案 https://stackoverflow.com/questions/63982417/deserialize-json-array-of-array-to-list-of-string-in-c-sharp。 - Ali Potasyum

Answer 1

Json.Net没有自动将数组映射到类的功能。为了实现这一点，您需要一个自定义的JsonConverter。这里有一个通用的转换器可以为您工作。它使用一个自定义的[JsonArrayIndex]属性来标识类中哪些属性对应于数组中的哪些索引。这将允许您在JSON更改时轻松更新模型。此外，您可以安全地从您的类中省略不需要的属性，例如Filler。

以下是代码：

public class JsonArrayIndexAttribute : Attribute
{
    public int Index { get; private set; }
    public JsonArrayIndexAttribute(int index)
    {
        Index = index;
    }
}

public class ArrayToObjectConverter<T> : JsonConverter where T : class, new()
{
    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(T);
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        JArray array = JArray.Load(reader);

        var propsByIndex = typeof(T).GetProperties()
            .Where(p => p.CanRead && p.CanWrite && p.GetCustomAttribute<JsonArrayIndexAttribute>() != null)
            .ToDictionary(p => p.GetCustomAttribute<JsonArrayIndexAttribute>().Index);

        JObject obj = new JObject(array
            .Select((jt, i) =>
            {
                PropertyInfo prop;
                return propsByIndex.TryGetValue(i, out prop) ? new JProperty(prop.Name, jt) : null;
            })
            .Where(jp => jp != null)
        );

        T target = new T();
        serializer.Populate(obj.CreateReader(), target);

        return target;
    }

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

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

为了使用转换器，您需要按照下面所示标记出您的ChildModel类：

[JsonConverter(typeof(ArrayToObjectConverter<ChildModel>))]
class ChildModel
{
    [JsonArrayIndex(0)]
    public int ID { get; set; }
    [JsonArrayIndex(1)]
    public string StatusId { get; set; }
    [JsonArrayIndex(2)]
    public DateTime ContactDate { get; set; }
    [JsonArrayIndex(3)]
    public string State { get; set; }
    [JsonArrayIndex(4)]
    public string Status { get; set; }
    [JsonArrayIndex(5)]
    public string CustomerName { get; set; }
    [JsonArrayIndex(6)]
    public DateTime WorkStartDate { get; set; }
    [JsonArrayIndex(7)]
    public DateTime WorkEndDate { get; set; }
    [JsonArrayIndex(8)]
    public string Territory { get; set; }
    [JsonArrayIndex(9)]
    public string CustType { get; set; }
    [JsonArrayIndex(10)]
    public int JobOrder { get; set; }
    [JsonArrayIndex(12)]
    public string Link { get; set; }
}

然后按照通常的方式进行反序列化，它应该按照您想要的方式工作。这里有一个演示：https://dotnetfiddle.net/n3oE3L

注意：我没有实现WriteJson，因此如果您将模型序列化回JSON，则不会将其序列化回数组格式；而是使用默认对象序列化。

- Brian Rogers

---

这个答案非常好。但是要注意它很慢，可能是由于反射代码的原因。在我的解析253118837条记录中，这段代码花费了80分钟。如果性能是一个问题，考虑放弃强类型并使用动态和索引，例如 dynamic items = JsonConvert.DeserializeObject(r.ReadToEnd()); var id = items.ROWS[0]; ...。那段代码将我的80分钟查询缩短到了11分钟。 - Lee Richardson

可以通过针对每种类型缓存propsByIndex来进行优化。 - dizarter

Answer 2

使用此方法将您的数据反序列化为JSON对象...

public class Rootobject
{
    public int ID { get; set; }
    public int Days { get; set; }
    public string Start_Date { get; set; }
    public string End_Date { get; set; }
    public string State { get; set; }
    public int Page { get; set; }
    public string Test { get; set; }
    public object[][] ROWS { get; set; }
}

...然后创建一个实用函数来将 object[][] 转换为您所需的目标对象...

(使用Visual Studio创建：编辑 -> 粘贴特殊 -> JSON类)

- Michael