问题

Question

问题

许多RESTful JSON API返回包装在对象中的集合。
在这种情况下，还有另一个属性，该属性包含集合中的项目数。

两个例子：

{
    "animals": [
        {"name": "Raven", "wings": 2},
        {"name": "Wolf", "wings": 0}
    ],
    "count": 2
}

{
    "vehicles": [
        {"type": "Car", "wheels": 4},
        {"type": "Motorcycle", "wheels": 2}
        {"type": "Boat", "wheels": 0}
    ],
    "count": 3
}

请注意，这些根对象并不相同，因为它们包含集合的名称。

在弱类型语言（例如JavaScript）中这不是问题，但在强类型语言中，如果有很多类似的包装对象，这将成为问题。

没有泛型

当然可以这样反序列化：

class AnimalsResponse 
{
    public List<Animal> Animals { get; set; }
    public int Count { get; set; }
}

class Animal
{
    public string Name { get; set; }
    public int Wings { get; set; }
}

JsonConvert.DeserializeObject<AnimalsResponse>(content);

class VehiclesResponse 
{
    public List<Vehicle> Vehicles { get; set; }
    public int Count { get; set; }
} 

class Vehicle
{
    public string Type { get; set; }
    public int Wheels { get; set; }
}

JsonConvert.DeserializeObject<VehiclesResponse>(content);

使用泛型

由于根对象始终具有相同的格式（集合名称除外），因此需要反序列化为通用类型：

class CollectionResponse<T>
{
    public List<T> Items { get; set; }
    public int Count { get; set; }
}

（可能过于复杂）解决方案

我已经尝试（成功地）使用自定义解串器执行此操作，但是对于这种常见问题，此解决方案似乎过于复杂。

class CollectionJsonConverter : JsonConverter
{
    private readonly string collectionName;

    public CollectionJsonConverter(string collectionName) : base()
    {
        this.collectionName = collectionName ?? throw new ArgumentNullException(nameof(collectionName));
    }

    public override bool CanConvert(Type objectType)
    {
        return objectType.IsGenericType && 
            objectType.GetGenericTypeDefinition() == typeof(CollectionResponse<>);
    }

    public override object ReadJson(JsonReader reader, 
        Type objectType, object existingValue, JsonSerializer serializer)
    {
        var instance = Activator.CreateInstance(objectType);

        var objectProperties = objectType.GetTypeInfo().DeclaredProperties.ToList();
        var objectProperty = objectProperties.FirstOrDefault(pi =>
            pi.Name == nameof(CollectionResponse<object>.Items));

        var jsonProperties = JObject.Load(reader).Properties();
        var jsonProperty = jsonProperties.FirstOrDefault(p => p.Name == collectionName);

        objectProperty?.SetValue(instance, 
            jsonProperty.Value.ToObject(objectProperty.PropertyType, new JsonSerializer()));

        return instance;
    }

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

JsonConvert.DeserializeObject<CollectionResponse<T>>(content, new CollectionJsonConverter(collectionName));

其中collectionName是集合的名称（如上述示例中的"animals"或"vehicles"）。
不幸的是，这增加了一个额外的参数来处理。

问题

有没有更简单的方法来实现这一目标，最好没有自定义解串器？

Answer 1

没有自定义JsonConverter或自定义ContractResolver，就无法完成您要问的事情。我认为JsonConverter实际上是一个不错的方法，但是您可以对其进行相当多的简化，这样就无需传递集合名称，也不需要进行反射来设置{{1} }属性：

Items

此外，您可以使用class CollectionJsonConverter : JsonConverter { public override bool CanConvert(Type objectType) { return objectType.IsGenericType && objectType.GetGenericTypeDefinition() == typeof(CollectionResponse<>); } public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) { // load the JSON into a JObject var obj = JObject.Load(reader); // we expect one and only one list of items; don't care what its name is var itemsProp = obj.Properties().Single(p => p.Value.Type == JTokenType.Array); // replace the existing list property with a new one called "Items" itemsProp.Replace(new JProperty("Items", itemsProp.Value)); // create an instance of the CollectionResponse model var instance = Activator.CreateInstance(objectType); // populate it from the modified JObject serializer.Populate(obj.CreateReader(), instance); return instance; } public override bool CanWrite => false; public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) { throw new NotImplementedException(); } }属性装饰CollectionResponse<T>类，以将转换器绑定到该类，这样您就无需担心在反序列化时传递转换器：

[JsonConverter]

然后，您可以像这样反序列化（例如）：

[JsonConverter(typeof(CollectionJsonConverter))]
class CollectionResponse<T>
{
    public List<T> Items { get; set; }
    public int Count { get; set; }
}

正在运行的演示：https://dotnetfiddle.net/D3q8ub

如何将JSON包装的集合属性反序列化为通用类？

问题

（可能过于复杂）解决方案

问题

1 个答案: