如何使用JSON.NET反序列化可以是两种不同数据类型的JSON属性

Question

我正在使用Json.NET进行一个项目。从一个外部API，我接收的JSON属性是对象，但当它们为空时，传递"false"。

例如：

data: {
    supplier: {
        id: 15,
        name: 'TheOne'
    }
}

也可能是：

data: {
    supplier: false
}

我应该如何定义供应商属性，以便将供应商反序列化为供应商对象或null。

现在我有：

public class Data {
   [JsonProperty("supplier")]
   public SupplierData Supplier { get; set; }
}
public class SupplierData {
    [JsonProperty("id")]
    public int Id { get; set; }
    [JsonProperty("name")]
    public string Name { get; set; }
}

但现在，当供应商的值为"false"时，尝试反序列化时会失败。当JSON值为"false"时，我希望Supplier属性为null。

我希望有人知道怎么做。谢谢

Answer 1

这可以通过为SupplierData类创建自定义JsonConverter来解决。以下是转换器的外观：

class SupplierDataConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return (objectType == typeof(SupplierData));
    }
    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        JToken token = JToken.Load(reader);
        if (token.Type == JTokenType.Object)
        {
            return token.ToObject<SupplierData>();
        }
        return null;
    }
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        serializer.Serialize(writer, value);
    }
}

要使用它，您只需要在Data类的Supplier属性中添加一个[JsonConverter]属性，如下所示：

public class Data
{
    [JsonProperty("supplier")]
    [JsonConverter(typeof(SupplierDataConverter))]
    public SupplierData Supplier { get; set; }
}

以下是转换器工作情况的演示。注意，这个演示假设data属性有某种包含对象，因为问题中的JSON不能独立存在。为此，我定义了一个名为RootObject的类：

public class RootObject
{
    [JsonProperty("data")]
    public Data Data { get; set; }
}

实际演示代码如下：

class Program
{
    static void Main(string[] args)
    {
        string json = @"
        {
            ""data"": 
            {
                ""supplier"": 
                {
                    ""id"": 15,
                    ""name"": ""TheOne""
                }
            }
        }";
        Console.WriteLine("--- first run ---");
        RootObject obj = JsonConvert.DeserializeObject<RootObject>(json);
        DumpSupplier(obj.Data.Supplier);
        json = @"
        {
            ""data"": 
            {
                ""supplier"": false
            }
        }";
        Console.WriteLine("--- second run ---");
        obj = JsonConvert.DeserializeObject<RootObject>(json);
        DumpSupplier(obj.Data.Supplier);
    }
    static void DumpSupplier(SupplierData supplier)
    {
        if (supplier != null)
        {
            Console.WriteLine("Id: " + supplier.Id);
            Console.WriteLine("Name: " + supplier.Name);
        }
        else
        {
            Console.WriteLine("(null)");
        }
        Console.WriteLine();
    }
}

这是上面的输出：

--- first run ---
Id: 15
Name: TheOne
--- second run ---
(null)