如何使用自定义的JsonConverter在Json.NET中只反序列化一个子对象？

Question

我希望能够从Web响应中反序列化JSON。以下是一个典型的响应：

{
    "response": {
        "garbage": 0,
        "details": [
            {
                "id": "123456789"
            }
        ]
    }
}

然而，这种格式并不理想。理想情况下，响应应该只包含：

{
    "id": "123456789"
}

这样它就可以被反序列化成一个对象，如下所示：

public class Details {
    [JsonProperty("id")]
    public ulong Id { get; set; }
}

由于服务器不受我控制（它是一个公共API），所以我希望修改反序列化过程以实现我想要的格式。

---

我试图利用自定义的JsonConverter来实现这一目标。 思路是跳过令牌，直到找到Details的期望起始点进行反序列化。 但是，我不确定应该在反序列化过程中的哪个位置使用它。

using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using Newtonsoft.Json;

namespace ConsoleApp2 {
    class Program {
        static void Main(string[] args) {
            // Simulating a stream from WebResponse.
            const string json = "{"response":{"garbage":0,"details":[{"id":"123456789"}]}}";
            byte[] bytes = System.Text.Encoding.UTF8.GetBytes(json);
            Stream stream = new MemoryStream(bytes);

            Details details = Deserialise<Details>(stream);

            Console.WriteLine($"ID: {details.Id}");
            Console.Read();
        }

        public static T Deserialise<T>(Stream stream) where T : class {
            using (StreamReader reader = new StreamReader(stream, Encoding.UTF8)) {
                JsonSerializerSettings settings = new JsonSerializerSettings {
                    MissingMemberHandling = MissingMemberHandling.Ignore,
                    DateParseHandling = DateParseHandling.None
                };

                settings.Converters.Add(new DetailConverter());
                return JsonSerializer.Create(settings).Deserialize(reader, typeof(T)) as T;
            }
        }
    }

    public class Details {
        [JsonProperty("id")]
        public ulong Id { get; set; }
    }

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

        public override object ReadJson(JsonReader reader,
                                        Type objectType,
                                        object existingValue,
                                        JsonSerializer serializer) {
            if (reader.Depth == 0) {
                while (!(reader.Path.Equals("response.details[0]", StringComparison.OrdinalIgnoreCase) && reader.TokenType == JsonToken.StartObject)) {
                    reader.Read();
                }

                try {
                    return serializer.Deserialize(reader, objectType);
                } finally {
                    reader.Read(); // EndArray - details
                    reader.Read(); // EndObject - response
                    reader.Read(); // EndObject - root
                }
            }

            return serializer.Deserialize(reader, objectType);
        }

        public override bool CanWrite => false;
        public override bool CanConvert(Type objectType) => true;
    }
}

目前的情况是，由于重复使用DetailConverter.ReadJson()并且它从未被反序列化，导致堆栈溢出。我认为问题出在我通过JsonSerializerSettings将DetailConverter设置为“全局”转换器。我认为问题在于何时以及如何使用我的转换器，而不是其内部工作方式。

---

我已经让类似的DetailConverter适用于以下结构。但是，虽然来自details的数组已被删除，但由于嵌套和未使用的属性，这仍然是不可取的。

public class Root {
    [JsonProperty("response")]
    public Response Response { get; set; }
}

public class Response {
    [JsonProperty("details")]
    [JsonConverter(typeof(DetailConverter))]
    public Details Details { get; set; }

    [JsonProperty("garbage")]
    public uint Garbage { get; set; }
}

public class Details {
    [JsonProperty("id")]
    public ulong Id { get; set; }
}

我以为将转换器扩展到整个JSON而不仅仅是一个属性会很简单。我错在哪里了？

- bgfvdu3w

---

你应该使用默认的JsonConverter来采用第二种方法。此外，如果你不使用"Garbage"，就不必声明它——只需直接使用父级即可。 - aaron

即使是有很多嵌套的更大的JSON文件，由于代码生成器的存在也不会那么烦人。然而，创建一堆虚拟父类似乎并不优雅。 - bgfvdu3w

@aaron，这里有两天的等待期。 - bgfvdu3w

Answer 1

Linq to JSON 对您是否可行？

using System;
using Newtonsoft.Json.Linq;

public class Program
{
    public static void Main()
    {
        var json = "{'response':{'garbage':0,'details':[{'id':'123456789'}]}}";
        var obj = JObject.Parse(json);
        var details = obj["response"]["details"];

        Console.WriteLine(details);
    }
}

- Richard Matsen

---

我不知道，我对此不熟悉。我想继续使用流而不是转换为字符串。我还使用了一个简化的示例。我使用更多的转换器来将字典数组转换为其值的数组，并将Unix时间戳转换为日期对象。 - bgfvdu3w

@Mark，所以你想要解决一个你无法解决的问题，但又不想改变你的工作方式？有趣。 - Gusdor

但也许公平地说，对于某些情况来说，流更有用。 - Richard Matsen

@Gusdor 我在询问如何使用JsonConverter来完成这个任务。我想了解为什么我的代码无法正常工作，以及我的方法有什么问题。对我来说，这比找到解决响应中不良JSON格式的根本问题更重要。 - bgfvdu3w

Answer 2

看起来你想从details数组中获取单个值，所以我的答案只取第一个。这样的转换器是否可行？它会从JObject中挑选出details数组中的单个值，然后将其转换为Details类。

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

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

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        var obj = JObject.Load(reader);
        var value = obj["response"]?["details"]?.FirstOrDefault();
        if (value == null) { return null; }
        return value.ToObject<Details>();
    }

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

当您使用序列化程序时，可以像这样简单地调用它：

``` var details = JsonConvert.DeserializeObject

(json, settings); ```

请注意，您需要创建 `JsonSerializerSettings settings`，并将 `DetailsConverter` 包含在设置对象的转换器列表中。

- ProgrammingLlama

Answer 3

解决方法是在从我的 JsonConverter 调用 JsonSerializer.Deserialize 之前清除 JsonSerializer 的转换器列表。

我从 这里 得到了这个想法，其中一个用户描述了如何将 JsonContract 的 JsonConverter 置空以恢复默认的 JsonConverter。这避免了反复调用我自定义的 JsonConverter 来反序列化我想要的子对象的问题。

public override object ReadJson(JsonReader reader,
                                Type objectType,
                                object existingValue,
                                JsonSerializer serializer) {
    while (reader.Depth != 3) {
        reader.Read();
    }

    serializer.Converters.Clear();

    return serializer.Deserialize(reader, objectType);
}

代码也已经被简化，移除了 try - finally 块。不必读取结束标记，因为永远不会尝试对其进行反序列化。也不需要检查深度，因为自定义的 JsonConverter 只会使用一次。

- bgfvdu3w