ASP.NET Core实现自定义WebApi模型验证详解(2)

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.heiqu.com/wdszys.html