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委托即可,个人也推荐第二种方案。
好了,以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对猪先飞的支持。
相关文章
- 这篇文章主要介绍了.NET Core下使用Kafka的方法步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-09-22
- 这篇文章主要给大家介绍了关于C#创建自定义控件及添加自定义属性和事件使用的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用C#具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧...2020-06-25
- 本文实例讲述了JS实现自定义简单网页软键盘效果。分享给大家供大家参考,具体如下:这是一款自定义的简单点的网页软键盘,没有使用任何控件,仅是为了练习JavaScript编写水平,安全性方面没有过多考虑,有顾虑的可以不用,目的是学...2015-11-08
- 为了增强android应用的用户体验,我们可以在一些Button按钮上自定义动态的设置一些样式,比如交互时改变字体、颜色、背景图等。 今天来看一个通过重写Button来动态实...2016-09-20
- 下面我们来看一篇关于Android自定义WebView网络视频播放控件开发例子,这个文章写得非常的不错下面给各位共享一下吧。 因为业务需要,以下代码均以Youtube网站在线视...2016-10-02
- 这篇文章主要介绍了详解.NET Core 3.0 里新的JSON API,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-09-22
- 自定义一个jquery模态窗口插件,将它集成到现有平台框架中时,它只能在mainFrame窗口中显示,无法在顶层窗口显示. 解决这个问题的办法: 通过以下代码就可能实现在顶层窗口弹窗 复制代码 代码如下: $(window.top.documen...2014-05-31
- 这篇文章主要介绍了自定义feignClient的常见坑及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-10-20
- 今天小编就为大家分享一篇pytorch 自定义卷积核进行卷积操作方式,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-05-06
ASP.NET Core根据环境变量支持多个 appsettings.json配置文件
这篇文章主要介绍了ASP.NET Core根据环境变量支持多个 appsettings.json配置文件,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-09-22- 这篇文章主要介绍了记一次EFCore类型转换错误及解决方案,帮助大家更好的理解和学习使用asp.net core,感兴趣的朋友可以了解下...2021-09-22
PHP YII框架开发小技巧之模型(models)中rules自定义验证规则
YII的models中的rules部分是一些表单的验证规则,对于表单验证十分有用,在相应的视图(views)里面添加了表单,在表单被提交之前程序都会自动先来这里面的规则里验证,只有通过对其有效的限制规则后才能被提交,可以很有效地保证...2015-11-24- 这篇文章主要介绍了jquery自定义插件开发之window的实现过程的相关资料,需要的朋友可以参考下...2016-05-09
- 这篇文章主要介绍了Vue 组件复用多次自定义参数操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-07-27
- 这篇文章主要介绍了C#自定义事件监听实现方法,涉及C#事件监听的实现技巧,具有一定参考借鉴价值,需要的朋友可以参考下...2020-06-25
详解ASP.NET Core 中基于工厂的中间件激活的实现方法
这篇文章主要介绍了ASP.NET Core 中基于工厂的中间件激活的实现方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-09-22- Underscore 是一个 JavaScript 工具库,它提供了一整套函数式编程的实用功能,但是没有扩展任何 JavaScript 内置对象。这篇文章主要介绍了underscore源码分析相关知识,感兴趣的朋友一起学习吧...2016-01-02
详解.NET Core 使用HttpClient SSL请求出错的解决办法
这篇文章主要介绍了.NET Core 使用HttpClient SSL请求出错的解决办法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧...2021-09-22- 这篇文章主要介绍了使用BindingResult 自定义错误信息,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-10-23
- 这篇文章主要介绍了在Vue中获取自定义属性方法:data-id的实例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-09-09