c# - 如何使 DTO 属性对于 json 模式可选

Question

我的 DTO 具有仅与 GET 响应相关的属性。在 POST 请求中，我不需要它 - 不仅如此 - 我不应该将它包含在序列化的 json 中。

因此，我将此 DTO 作为 GET 请求的响应，并在发出 POST 请求时在正文中发送它(不带提到的属性)。

除了从原始类中删除可选属性并将其定位在继承类中 - 我还有什么其他选择？ (例如使用 JsonProperties 或其他选项)

这是我的 DTO:

public class MyDTO
{
    [JsonProperty("id")]
    public int ID {get; set;}
    
    [JsonProperty("remark")]
    public string Remark {get; set;}
    
    [JsonProperty("optionalremark")] //relevant only to the GET request
    public string OptionalRemark {get; set;}
}

Answer 1

有多种方法可以实现这一目标:

单独的对象

最明显的选择可能是将 GET 的响应对象与 POST 的请求对象分开。这两个 API 很可能可以独立发展。如果这两个更改中的任何一个发生变化，则需要对 DTO 进行修改。您可以使用某种映射器(例如 AutoMapper )来定义这两个类之间的关系。

条件序列化

Newtonsoft 确实支持 conditional seralization 。您所要做的就是定义一个返回 bool 的方法，并命名为 ShouldSerialize{PropertyName}:

public class MyDTO
{
    [JsonProperty("id")]
    public int ID {get; set;}
    
    [JsonProperty("remark")]
    public string Remark {get; set;}
    
    [JsonProperty("optionalremark")]
    public string OptionalRemark {get; set;}
    
    public bool ShouldSerializeOptionalRemark() => false;
}

此方法仅在序列化期间调用。因此，反序列化按预期工作。

合约解析器

如果您不想在 DTO 中包含 ShouldSerialize{PropertyName} 方法，则可以将此逻辑放入自定义 ContractResolver 中:

public class MyDTOContractResolver : DefaultContractResolver
{
    protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
    {
        var property = base.CreateProperty(member, memberSerialization);

        if (property.DeclaringType == typeof(MyDTO) && property.PropertyName == nameof(MyDTO.OptionalRemark).ToLower())
        {
            property.ShouldSerialize = _ => false;
        }

        return property;
    }
}

您也可以为 SerializeObject 和 DeserializeObject 指定此解析器:

var getResponse = JsonConvert.DeserializeObject<MyDTO>(json, new JsonSerializerSettings { ContractResolver = new MyDTOContractResolver() });

var postRequest = JsonConvert.SerializeObject(getResponse, new JsonSerializerSettings { ContractResolver = new MyDTOContractResolver() });

在反序列化期间它没有任何影响。因此，如果您需要，您也可以全局注册此解析器:

services.AddControllers()
.AddNewtonsoftJson(opts =>
{
    opts.SerializerSettings.ContractResolver = new MyDTOContractResolver();
});

此代码适用于 ASP.NET Core 3.x 或更高版本的项目。如果是较旧的 ASP.NET Core 项目，请使用 AddJsonOptions 而不是 AddNewtonsoftJson。