如何让 WebAPI 使用 JsonProperty(Required = Required.Always) 验证我的 JSON？

Question

public class MyModel
{
    [JsonProperty(PropertyName = "foo", Required = Required.Always)]
    public String Bar;
}

public class MyController : ApiController
{
    public String PostVersion1([FromBody] MyModel myModel)
    {
        if (ModelState.IsValid)
        {
            if (myModel.Bar == null)
                return "What?!";
            else
                return "Input is valid.";
        }
        else
        {
            return "Input is invalid.";
        }
    }
}

结果：

Input              |Output
-------------------|------
{ "bad" : "test" } | What?!
{ "Bar" : "test" } | What?!
{ "foo" : "test" } | Input is valid.

显然支持 JsonPropertyAttribute，因为我可以设置 PropertyName 并使其生效。但是，我希望 ModelState.IsValid 对于前两个示例输入为 false，因为 Required JsonProprty 参数设置为 Always。

如果我只是通过 JsonConvert 运行它：

JsonConvert.DeserializeObject<MyModel>(@"{'bad':'test'}");

反序列化过程中按预期抛出异常：

Result Message: Newtonsoft.Json.JsonSerializationException : Required property 'foo' not found in JSON. Path '', line 1, position 14.

Answer 1

默认JsonMediaTypeFormatter确实不依赖JsonProperty来决定是否需要模型字段。但是它确实依赖于RequiredAttribute

如果你想这样做，那么实现一个新的IRequiredMemberSelector 并将其设置为MediaTypeFormatter.RequiredMemberSelector。

在您的IRequiredMemberSelector 实现中，您将获得MemberInfo。您可以使用它来评估模型成员是否具有 JsonProperty 属性以及是否设置了 required 标志，最后返回 true 或 false。此将传播到ModelState.IsValid 属性（虽然它不会使用 JSON.NET 错误消息，但会使用 DataAnnotations/WebApi 之一。

如果你这样做，那么我建议你也保留默认行为。

Answer 2

为了解决这个问题，我最终创建了自己的自定义 JSON.NET MediaTypeFormatter。我的格式化程序允许 JSON.NET 反序列化异常冒泡，导致异常信息返回给调用者。

这是我构建的 MediaTypeFormatter：

public class JsonMediaFormatter : MediaTypeFormatter
{
    private readonly JsonSerializer _jsonSerializer = new JsonSerializer();

    public JsonMediaFormatter()
    {
        SupportedMediaTypes.Add(new MediaTypeHeaderValue("application/json"));
    }

    public override Boolean CanReadType(Type type)
    {
        if (type == null)
            return false;

        return true;
    }

    public override Boolean CanWriteType(Type type)
    {
        if (type == null)
            return false;

        return true;
    }

    public override Task<Object> ReadFromStreamAsync(Type type, Stream readStream, HttpContent content, IFormatterLogger formatterLogger)
    {
        return Task.FromResult(Deserialize(readStream, type));
    }

    public override Task WriteToStreamAsync(Type type, Object value, Stream writeStream, HttpContent content, TransportContext transportContext, CancellationToken cancellationToken)
    {
        Serialize(writeStream, value);
        return Task.FromResult(0);
    }

    private Object Deserialize(Stream readStream, Type type)
    {
        var streamReader = new StreamReader(readStream);
        return _jsonSerializer.Deserialize(streamReader, type);
    }

    private void Serialize(Stream writeStream, Object value)
    {
        var streamWriter = new StreamWriter(writeStream);
        _jsonSerializer.Serialize(streamWriter, value);
        streamWriter.Flush();
    }
}

为了在内置的格式化程序上使用这个格式化程序，我在我的 WebApiConfig 中添加了这一行：

config.Formatters.Insert(0, new Formatters.JsonMediaFormatter());

通过在索引 0 处插入它，它优先于内置格式化程序。如果您愿意，可以删除内置的 JSON 格式化程序。

在这种情况下，ModelState 在操作中始终有效，因为如果反序列化失败，则会在触发操作之前向用户抛出异常。需要做更多的工作才能使用空的FromBody 参数执行操作。

Answer 3

我知道这是一个老问题，但我是这样解决的：

var formatter = new JsonMediaTypeFormatter {
    SerializerSettings = {
        ContractResolver = new DefaultContractResolver(true)
    }
};
configuration.Formatters.Insert(0, formatter);

解析错误随后将包含在ModelState中

Answer 4

如果你只想支持 JSON，那么你可以这样做：

public String PostVersion1([FromBody] JObject json)
{
  if(json == null) {
    // Invalid JSON or wrong Content-Type
    throw new HttpResponseException(HttpStatusCode.BadRequest);
  }

  MyModel model;
  try
  {
    model = json.ToObject<MyModel>();
  }
  catch(JsonSerializationException e)
  {
    // Serialization failed
    throw new HttpResponseException(HttpStatusCode.BadRequest);
  }
}

但您不想在每个请求处理程序中都这样做。这是[FromBody] 属性的多个缺陷之一。更多详情请看这里：https://stackoverflow.com/a/52877955/2279059