Alby's blog

世上没有巧合，只有巧合的假象。

0%

ASP.NET Core WEB API 模型验证的有关问题

发表于 更新于 分类于

一、概述

改变 ASP.NET Core WEB API 模型验证的默认行为。

二、问题

ApiControllerAttribure 特性通常结合 ControllerBase 来为控制器启用特定于 REST 行为。 通过 ControllerBase 可使用 NotFound 和 File 等方法。
它其中一个作用是自动 HTTP 400 响应。即验证错误会自动触发 HTTP 400 响应。 操作中不需要以下代码：

1
2
3
4
if (!ModelState.IsValid)
{
    return BadRequest(ModelState);
}

如果要改变这种行为，比如希望以 HTTP 200 响应，则有如下解决方案 。

三、解决方案

1、第一步

当 SuppressModelStateInvalidFilter 属性设置为 true 时，会禁用默认行为。 将以下代码添加至 Startup.ConfigureServices 中的 services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1); 后：

1
2
3
4
5
// File: Startup.cs Method: ConfigureServices
services.Configure<ApiBehaviorOptions>(options =>
{
    options.SuppressModelStateInvalidFilter = true;
});

2、解决方案1： 在 Action 开头进行验证

1
2
3
4
5
// File: XXXController.cs Method: XXXAction
if (!ModelState.IsValid)
{
    return new OkObjectResult(ModelState);
}

3 、解决方案2：自定义 ActionFilterAttribure

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// File: ModelValidaionActionFilterAttribute.cs
public class ModelValidaionActionFilterAttribute : ActionFilterAttribure
{
    public override void OnActionExecuting(ActionExecutingContext context)
    {
        if (!context.ModelState.IsValid)
        {
            context.Result = new OkObjectResult(context.ModelState);
        }
        else
        {
            base.OnActionExecuting(context);
        }
    }
}

ModelValidaionActionFilterAttribute 可在 Controller 或 Action 上使用；也可以做一个继承于 ControllerBase 的类，在其上使用该 Attribute，而其他 Controller 继承与该类；也可以全局注册 ModelValidaionActionFilterAttribute :

1
2
3
4
// File: Startup.cs Method: ConfigureServicess
services.AddMvc(options => {
    options.Filters.Add(typeof(ModelValidaionActionFilterAttribute));
}).SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

4、解决方案3：使用 InvalidModelStateResponseFactory

不用再将 SuppressModelStateInvalidFilter 设置为 true，不再使用 ModelValidaionActionFilterAttribute, 也无需在 Action 中判断 ModelState.IsValid。

1
2
3
4
5
// File: Startup.cs Method: ConfigureServices
services.Configure<ApiBehaviorOptions>(options =>
{
    options.InvalidModelStateResponseFactory = context => new OkObjectResult(context.ModelState);
});

四、其他

不太重要的优化。模型验证时如果发生错误，将继续验证字段，直至达到错误数上限（默认为 200 个）。 通过向 Startup.cs 文件中的 ConfigureServices 方法插入以下代码，可配置该数字：

1
2
3
4
// File: Startup.cs Method: ConfigureServicess
services.AddMvc(options => {
    options.MaxModelValidationErrors = 1;
}).SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

参考资料