c# - 如何干净地反序列化字符串值包含在同名对象中的 JSON

Question

我想将一些奇怪的 JSON 反序列化为 C# 类:

{
    "Result": {
        "Client": {
            "ProductList": {
                "Product": [
                    {
                        "Name": {
                            "Name": "Car polish"
                        }
                    }
                ]
            },
            "Name": {
                "Name": "Mr. Clouseau"
            },
            "AddressLine1": {
                "AddressLine1": "Hightstreet 13"
            }
        }
    }
}

json2csharp为 JSON 生成以下类:

public class Name
{
    public string Name { get; set; }
}

public class Product
{
    public Name Name { get; set; }
}

public class ProductList
{
    public List<Product> Product { get; set; }
}

public class Name2
{
    public string Name { get; set; }
}

public class AddressLine1
{
    public string AddressLine1 { get; set; }
}

public class Client
{
    public ProductList ProductList { get; set; }
    public Name2 Name { get; set; }
    public AddressLine1 AddressLine1 { get; set; }
}

public class Result
{
    public Client Client { get; set; }
}

public class RootObject
{
    public Result Result { get; set; }
}

问题是对象中重复的属性名称(Product 和 Client 中的Name、AddressLine1在 Client 中)迫使我创建一个只有一个字符串属性(Name、AddressLine1)的额外类，以便能够反序列化 JSON。

生成的代码也是无效的，因为成员名称不能与其封闭类型相同(但我知道可以使用 [JsonProperty(PropertyName = "Name")] 属性解决) .

避免类层次结构中出现不必要级别并拥有干净的类结构以便能够使用 JSON.NET 反序列化此 JSON 的最佳方法是什么？请注意，这是第三方 API，因此我不能只更改 JSON。

Answer 1

的确，这是 API 结果的一种奇怪格式，使其更难使用。解决该问题的一个想法是创建一个自定义 JsonConverter，它可以采用包装值并返回内部值，就好像包装器不存在一样。这将允许您将笨重的 JSON 反序列化为更合理的类层次结构。

这是一个应该可以工作的转换器:

class WrappedObjectConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return true;
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        JToken token = JToken.Load(reader);
        // Get the value of the first property of the inner object
        // and deserialize it to the requisite object type
        return token.Children<JProperty>().First().Value.ToObject(objectType);
    }

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

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

有了这个转换器，您可以创建一个类层次结构来消除额外的嵌套级别。您必须使用 [JsonConverter] 属性标记需要“展开”的属性，以便 Json.Net 知道何时应用自定义转换器。这是改进后的类结构:

public class RootObject
{
    public Result Result { get; set; }
}

public class Result
{
    public Client Client { get; set; }
}

public class Client
{
    [JsonConverter(typeof(WrappedObjectConverter))]
    public List<Product> ProductList { get; set; }

    [JsonConverter(typeof(WrappedObjectConverter))]
    public string Name { get; set; }

    [JsonConverter(typeof(WrappedObjectConverter))]
    public string AddressLine1 { get; set; }
}

public class Product
{
    [JsonConverter(typeof(WrappedObjectConverter))]
    public string Name { get; set; }
}

(请注意，如果 Result 对象将不包含除 Client 之外的任何其他属性，您也可以在那里应用 WrappedObjectConverter 以移动Client 到 RootObject 并消除 Result 类。)

这是一个显示转换器运行的演示:

class Program
{
    static void Main(string[] args)
    {
        string json = @"
        {
            ""Result"": {
                ""Client"": {
                    ""ProductList"": {
                        ""Product"": [
                            {
                                ""Name"": {
                                    ""Name"": ""Car polish""
                                }
                            }
                        ]
                    },
                    ""Name"": {
                        ""Name"": ""Mr. Clouseau""
                    },
                    ""AddressLine1"": {
                        ""AddressLine1"": ""Hightstreet 13""
                    }
                }
            }
        }";

        RootObject obj = JsonConvert.DeserializeObject<RootObject>(json);

        Client client = obj.Result.Client;
        foreach (Product product in client.ProductList)
        {
            Console.WriteLine(product.Name);
        }
        Console.WriteLine(client.Name);
        Console.WriteLine(client.AddressLine1);
    }
}

输出:

Car polish
Mr. Clouseau
Hightstreet 13