仅当 JSON 为值类型属性指定值时才反序列化

Question

If I have a DTO class containing value type properties, how can I idiomatically use Newtonsoft to deserialize JSON to my DTO class while ensuring that the JSON defines the value type, possibly containing the default value for the type? 到目前为止，我所看到的方法依赖于检查该值是否为default值，但是，当default值也是属性的有效值时，这不是一个合适的解决方案。

例子

public class MyDto
{
    public bool MyProp { get; set; }
}

JSON	可以反序列MyDto
{"MyProp": true}	真的
{"MyProp": false}	真的
{}	错误的

当前解决方案

目前我使用System.ComponentModel.DataAnnotations.RequiredAttribute并将类型声明为可为空，但这仅在 model 绑定期间有效（而不是任何反序列化），并导致过度使用! 引用该属性时。

public class MyDto
{
    [Required]
    public bool? MyProp { get; set; }
}

Answer 1

我相信您正在寻找的是JsonPropertyAttribute 必需的属性：

public class MyDto
{
    [JsonProperty(Required = Required.Always)]
    public bool MyProp { get; set; }
}

当反序列化的 JSON 不包含指定的属性 ( MyProp ) 时，这会导致异常。 例如，以下内容：

string json = "{\"MyProp\": true}";
MyDto myDto = JsonConvert.DeserializeObject<MyDto>(json);
Console.WriteLine(myDto.MyProp);

json = "{\"MyProp\": false}";
myDto = JsonConvert.DeserializeObject<MyDto>(json);
Console.WriteLine(myDto.MyProp);

json = "{}";
myDto = JsonConvert.DeserializeObject<MyDto>(json);
Console.WriteLine(myDto.MyProp);

给出结果：

True
False
Run-time exception (line 17): Required property 'MyProp' not found in JSON. Path '', line 1, position 2.

Answer 2

您可以使用 JSON 架构（ Newtonsoft.Json.Schema ）验证 JSON，如下所示：

public class MyDto
{
    [JsonProperty(Required = Required.Always)]
    public bool MyProp { get; set; }
}


var generator = new JSchemaGenerator();
var schema = generator.Generate(typeof(MyDto));
var dto = JObject.Parse(@"{ 'MyProp': true }");
bool isValid = dto.IsValid(schema);
Console.WriteLine(isValid); // True

dto = JObject.Parse(@"{}");
isValid = dto.IsValid(schema);
Console.WriteLine(isValid); // False