ASP.NET Core - 实现自定义WebApi模型验证

  1. 云栖社区>
  2. 博客>
  3. 正文

ASP.NET Core - 实现自定义WebApi模型验证

优惠券活动 2019-08-01 12:29:10 浏览125
展开阅读全文

ASP.NET Core - 实现自定义WebApi模型验证
  Framework时代  
  在Framework时代,我们一般进行参数验证的时候,以下代码是非常常见的

复制代码

    [HttpPost]
    public async Task<JsonResult> SaveNewCustomerAsnyc(AddCustomerInput input)
    {
        if (!ModelState.IsValid)
        {
            return Json(Result.FromCode(ResultCode.InvalidParams));
        }

       .....
    }

复制代码
  或者高级一点是实现IActionFilter进行拦截,如下:  

复制代码
  public class ApiValidationFilter : IActionFilter

{
    public bool AllowMultiple => false;

    public async Task<HttpResponseMessage> ExecuteActionFilterAsync(HttpActionContext actionContext, CancellationToken cancellationToken, Func<Task<HttpResponseMessage>> continuation)
    {
        var method = actionContext.ActionDescriptor.GetMethodInfoOrNull();
        if (method == null)
        {
            return await continuation();
        }           

        if (!actionContext.ModelState.IsValid)
        {
            var error = actionContext.ModelState.GetValidationSummary();
            var result = Result.FromError($"参数验证不通过:{error}", ResultCode.InvalidParams);
            return actionContext.Request.CreateResponse(result);
        }

        return await continuation();
    }

}
复制代码
复制代码
 public static class ModelStateExtensions

{
    /// <summary>
    /// 获取验证消息提示并格式化提示
    /// </summary>
    public static string GetValidationSummary(this ModelStateDictionary modelState, string separator = "\r\n")
    {
        if (modelState.IsValid) return null;

        var error = new StringBuilder();

        foreach (var item in modelState)
        {
            var state = item.Value;
            var message = state.Errors.FirstOrDefault(p => !string.IsNullOrWhiteSpace(p.ErrorMessage))?.ErrorMessage;
            if (string.IsNullOrWhiteSpace(message))
            {
                message = state.Errors.FirstOrDefault(o => o.Exception != null)?.Exception.Message;
            }
            if (string.IsNullOrWhiteSpace(message)) continue;

            if (error.Length > 0)
            {
                error.Append(separator);
            }

            error.Append(message);
        }

        return error.ToString();
    }
} 

复制代码
  然后在启动项把这个拦截注册进来使用即可 

  .Net Core时代  
  自动模型状态验证
  在.Net Core的时代中,框架会帮你自动验证model的state,也就是ModelState。框架会为你自动注册ModelStateInvalidFilter,这个会运行在OnActionExecuting事件里面。

  基于现有框架的代码编写的话,所以我们不再需要在业务中耦合这样的模型判断代码,系统内部会检查ModelState是否为Valid,如果为InValid会直接返回400 BadRequest,这样就没有必要执行后面的代码,提高效率。因此,操作方法中不再需要以下代码: 

if (!ModelState.IsValid)
{

return BadRequest(ModelState);

}
  问题引入  
  在我们的真实开发中,当我们碰到参数验证没通过400错误时,我们希望的是后台返回一个可理解的Json结果返回,而不是直接在页面返回400错误。所以我们需要替换掉默认的BadRequest响应结果,把结果换成我们想要的Json结果返回。

  自定义 BadRequest 响应
  我们如何改变 ASP.NET Core WEB API 模型验证的默认行为呢?具体的做法是在通过Startup的ConfigureServices方法配置ApiBehaviorOptions来实现,先来看一下这个类。 

复制代码
  public class ApiBehaviorOptions

{
    public Func<ActionContext, IActionResult> InvalidModelStateResponseFactory { get; set; }

    public bool SuppressModelStateInvalidFilter { get; set; }

    public bool SuppressInferBindingSourcesForParameters { get; set; }

    public bool SuppressConsumesConstraintForFormFileParameters { get; set; }
}

复制代码
  所有bool类型的属性默认都是false。

  方案一
  当 SuppressModelStateInvalidFilter 属性设置为 true 时,会禁用默认行为  

复制代码
  public void ConfigureServices(IServiceCollection services)

    {           
        services
              .AddMvc()
            .AddXmlSerializerFormatters() //设置支持XML格式输入输出
            .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

        //禁用默认行为
        services.Configure<ApiBehaviorOptions>(options =>
        {
            options.SuppressModelStateInvalidFilter = true;
        });
    }

复制代码
  当我们禁用完之后,需要我们自定义的返回结果了,我们使用上面的定义的ApiValidationFilter进行拦截和返回。需要在ConfigureServices方法里面把这个拦截器注册进来

复制代码

 public void ConfigureServices(IServiceCollection services)
    {
        .....
        services
              .AddMvc(options =>
              {
                  options.Filters.Add<ApiValidationFilter>();
              })
            .AddXmlSerializerFormatters() //设置支持XML格式输入输出
            .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

    }

复制代码
  方案二  
  这也是官网的推荐的做法是,若要自定义验证错误引发的响应,请使用InvalidModelStateResponseFactory。这个InvalidModelStateResponseFactory是一个参数为ActionContext,返回值为IActionResult的委托,具体实现如下:  

复制代码

public void ConfigureServices(IServiceCollection services)
    {           
        services
              .AddMvc()
            .AddXmlSerializerFormatters() //设置支持XML格式输入输出
            .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

        //参数验证
        services.Configure<ApiBehaviorOptions>(options =>
        {
            options.InvalidModelStateResponseFactory = (context) =>
            {
                var error = context.ModelState.GetValidationSummary();
                
                return new JsonResult(Result.FromError($"参数验证不通过:{error.ToString()}", ResultCode.InvalidParams));
            };
        });
    }

复制代码
  上面的代码是覆盖ModelState管理的默认行为(ApiBehaviorOptions),当数据模型验证失败时,程序会执行这段代码。没通过验证的ModelState,把它抛出的错误信息通过格式化利用JsonResult返回给客户端。

  总结
  我们在实际应用过程中,针对WebApi的开发基本上对于所有的请求都是要返回自定义结果的,所以我们需要覆盖默认的覆盖默认的模型认证行为,上面给出了两种方案:

  第一种方案:符合Framework时代的风格,需要额外在指定覆盖原有的模型验证(SuppressModelStateInvalidFilter = true)

  第二种方案:官方建议做法,符合Core时代的风格,只需复写InvalidModelStateResponseFactory委托即可,个人也推荐第二种方案。

  如果你有更好的想法,欢迎给我留言交流。
原文地址https://www.cnblogs.com/lex-wu/p/11265458.html

网友评论

作者关闭了评论
优惠券活动
+ 关注