如何在使用 Json.net 反序列化时传递自定义类的默认值

Question

我想像这样反序列化一个 JSON 结构：

{
    "Name": "Foo",
    "bar": {
        "Name": "Bar",
        "DefaultableProperty": "default"
    }
}

。其中定义 "bar" 是可选的。在未定义的情况下，我想使用一些默认值加载 Bar 类型的对象。

以下是我对Foo和Bar的类定义

public class Foo
{
    [JsonConstructor]
    public Foo()
    {
        string bardefaults = @"{ ""Name"": ""defaultname""}";
        b = new Bar(bardefaults);
    }
    public string Name { get; set; }
    public Bar bar { get; set; }
}
public class Bar
{
    public Bar() { }
    public Bar(string json)
    {
        Bar copy = JsonConvert.DeserializeObject<Bar>(json);
        Name = copy.Name;
        DefaultableProperty = copy.DefaultableProperty;
    }
    public string Name { get; set; }
    [DefaultValue("default")]
    [JsonProperty(DefaultValueHandling = DefaultValueHandling.Populate)]
    public string DefaultableProperty { get; set; }
}

这是我反序列化某些 JSON 的测试方法：

[TestMethod]
public void CanDeserializeObjectWithDefaultValues()
{
     string s = @"{ 'Name': 'aname', 
                  }";
     Foo foo = JsonConvert.DeserializeObject<Foo>(s);
     Assert.AreEqual("aname", foo.Name);
     Assert.AreEqual("default", foo.bar.DefaultableProperty);
     Assert.IsNotNull(foo.bar.Name);
}

使用

上面的代码，我能够使用默认值反序列化 Bar 类型的对象。但是，我希望能够像Bar.DefaultableProperty一样使用DefaultValue进行Foo.bar。我无法使用以下语法实现这一点：

• [DefaultValue(typeof(Bar), @"{ ""Name"": ""bar"" }")]
• [DefaultValue(new Bar(@"{ ""Name"": ""bar"" }"))]

所以我的问题是 Json.NET 是否支持创建默认自定义对象？如果没有，那么处理这种情况的最佳方法是什么？

Answer 1

我所做的是创建一个派生自 DefaultValueAttribute 的新 JsonDefaultValueAttribute 属性，并添加了一个新的 ctor 以支持将 json-string 值转换为目标类型，如下所示：

public class JsonDefaultValueAttribute : DefaultValueAttribute
{
    public JsonDefaultValue(string json, Type type) : base (ConvertFromJson(json, type))
    {            
    }
    private static object ConvertFromJson(string json, Type type)
    {
        var value = JsonConvert.DeserializeObject(json, type, new JsonSerializerSettings
        {
            MissingMemberHandling = MissingMemberHandling.Error,
            NullValueHandling = NullValueHandling.Include,
            DefaultValueHandling = DefaultValueHandling.Populate
        });
        return value;
    }
    ....
}

现在，您可以使用新属性，而不是使用默认属性。