ASP.NET Core实现自定义WebApi模型验证详解
Framework时代
在Framework时代，我们一般进行参数验证的时候，以下代码是非常常见的
[HttpPost] publicasyncTaskSaveNewCustomerAsnyc(AddCustomerInputinput) { if(!ModelState.IsValid) { returnJson(Result.FromCode(ResultCode.InvalidParams)); } ..... }
或者高级一点是实现IActionFilter进行拦截，如下：
publicclassApiValidationFilter:IActionFilter
{
publicboolAllowMultiple=>false;
publicasyncTaskExecuteActionFilterAsync(HttpActionContextactionContext,CancellationTokencancellationToken,Func>continuation)
{
varmethod=actionContext.ActionDescriptor.GetMethodInfoOrNull();
if(method==null)
{
returnawaitcontinuation();
}
if(!actionContext.ModelState.IsValid)
{
varerror=actionContext.ModelState.GetValidationSummary();
varresult=Result.FromError($"参数验证不通过：{error}",ResultCode.InvalidParams);
returnactionContext.Request.CreateResponse(result);
}
returnawaitcontinuation();
}
}
publicstaticclassModelStateExtensions
{
///
///获取验证消息提示并格式化提示
///
publicstaticstringGetValidationSummary(thisModelStateDictionarymodelState,stringseparator="\r\n")
{
if(modelState.IsValid)returnnull;
varerror=newStringBuilder();
foreach(variteminmodelState)
{
varstate=item.Value;
varmessage=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);
}
returnerror.ToString();
}
}
然后在启动项把这个拦截注册进来使用即可
.NetCore时代
自动模型状态验证
在.NetCore的时代中，框架会帮你自动验证model的state，也就是ModelState。框架会为你自动注册ModelStateInvalidFilter，这个会运行在OnActionExecuting事件里面。
基于现有框架的代码编写的话，所以我们不再需要在业务中耦合这样的模型判断代码，系统内部会检查ModelState是否为Valid，如果为InValid会直接返回400BadRequest，这样就没有必要执行后面的代码，提高效率。因此，操作方法中不再需要以下代码：
if(!ModelState.IsValid)
{
returnBadRequest(ModelState);
}
问题引入
在我们的真实开发中，当我们碰到参数验证没通过400错误时，我们希望的是后台返回一个可理解的Json结果返回，而不是直接在页面返回400错误。所以我们需要替换掉默认的BadRequest响应结果，把结果换成我们想要的Json结果返回。
自定义BadRequest响应
我们如何改变ASP.NETCoreWEBAPI模型验证的默认行为呢？具体的做法是在通过Startup的ConfigureServices方法配置ApiBehaviorOptions来实现，先来看一下这个类。
publicclassApiBehaviorOptions
{
publicFuncInvalidModelStateResponseFactory{get;set;}
publicboolSuppressModelStateInvalidFilter{get;set;}
publicboolSuppressInferBindingSourcesForParameters{get;set;}
publicboolSuppressConsumesConstraintForFormFileParameters{get;set;}
}
所有bool类型的属性默认都是false。
方案一
当SuppressModelStateInvalidFilter属性设置为true时，会禁用默认行为
publicvoidConfigureServices(IServiceCollectionservices)
{
services
.AddMvc()
.AddXmlSerializerFormatters()//设置支持XML格式输入输出
.SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
//禁用默认行为
services.Configure(options=>
{
options.SuppressModelStateInvalidFilter=true;
});
}
当我们禁用完之后，需要我们自定义的返回结果了，我们使用上面的定义的ApiValidationFilter进行拦截和返回。需要在ConfigureServices方法里面把这个拦截器注册进来
publicvoidConfigureServices(IServiceCollectionservices)
{
.....
services
.AddMvc(options=>
{
options.Filters.Add();
})
.AddXmlSerializerFormatters()//设置支持XML格式输入输出
.SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
}
方案二
这也是官网的推荐的做法是，若要自定义验证错误引发的响应，请使用InvalidModelStateResponseFactory。这个InvalidModelStateResponseFactory是一个参数为ActionContext，返回值为IActionResult的委托，具体实现如下：
publicvoidConfigureServices(IServiceCollectionservices)
{
services
.AddMvc()
.AddXmlSerializerFormatters()//设置支持XML格式输入输出
.SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
//参数验证
services.Configure(options=>
{
options.InvalidModelStateResponseFactory=(context)=>
{
varerror=context.ModelState.GetValidationSummary();
returnnewJsonResult(Result.FromError($"参数验证不通过：{error.ToString()}",ResultCode.InvalidParams));
};
});
}
上面的代码是覆盖ModelState管理的默认行为（ApiBehaviorOptions），当数据模型验证失败时，程序会执行这段代码。没通过验证的ModelState，把它抛出的错误信息通过格式化利用JsonResult返回给客户端。
总结
我们在实际应用过程中，针对WebApi的开发基本上对于所有的请求都是要返回自定义结果的，所以我们需要覆盖默认的覆盖默认的模型认证行为，上面给出了两种方案：
第一种方案：符合Framework时代的风格，需要额外在指定覆盖原有的模型验证（SuppressModelStateInvalidFilter=true）
第二种方案：官方建议做法，符合Core时代的风格，只需复写InvalidModelStateResponseFactory委托即可，个人也推荐第二种方案。
好了，以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，谢谢大家对毛票票的支持。
声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。