一.前言
模型验证自ASP.NET MVC便有提供，我们可以在Model(DTO)的属性上加上数据注解（Data Annotations）特性，在进入Action之前便会根据数据注解，来验证输入的数据是否合法，下面介绍以下如何统一处理验证并返回错误信息。话不多说了，来一起看看详细的介绍吧。
二.Action过滤器实现统一验证
我们在判断验证状态时一般会在Action里判断ModelState.IsValid是否为true。
|
1
2
3
4
5
6
7
|
public IActionResult Create([FromBody]CreateOrderDto dto){ if(ModelState.IsValid) { //TODO:... }} |
如果我们在每个需要验证的Action里面都写这个判断岂不是太麻烦，我们是否可以在进入所有的Action之前都进行验证，如果错误，就直接返回错误信息，不去执行Action了，当然时可以的。我们可以利用MVC的ActionFilter即Action过滤器，在执行Action之前统一判断处理。
1.首先定义一个通用的返回结果类：
|
1
2
3
4
5
|
public class XcHttpResult{ public string Msg { get; set; } public bool Result { get; set; }} |
2.定义一个ActionFilter
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
public class XcActionFilter : IActionFilter{ public void OnActionExecuting(ActionExecutingContext context) { if (!context.ModelState.IsValid) { XcHttpResult result = new XcHttpResult() { Result = false }; foreach (var item in context.ModelState.Values) { foreach (var error in item.Errors) { result.Msg += error.ErrorMessage + "|"; } } context.Result = new JsonResult(result); } } public void OnActionExecuted(ActionExecutedContext context) { }} |
3.配置过滤器
在Startup.cs里配置过滤器，使其生效：
|
1
2
3
4
5
6
7
|
public void ConfigureServices(IServiceCollection services){ services.AddMvc(options => { options.Filters.Add<XcActionFilter>(); });} |
三.测试
定义一个DTO:
|
1
2
3
4
5
6
7
8
9
10
|
public class CreateOrderDto{ [Required(ErrorMessage = "商品ID不得为空")] public string ProductId { get; set; } [Required(ErrorMessage = "购买商品数量不得为空")] [Range(1, 999, ErrorMessage = "购买商品数量必须介于1~999之间")] public int Number { get; set; } = 0; [Required(ErrorMessage = "用户ID不得为空")] public string UserId { get; set; }} |
使用Postman来测试接口：
可以看出已经成功验证！设置了商品数量的取值范围为1~999之间，而我输入了9999被成功拦截并返回错误信息.
总结
以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对服务器之家的支持。
原文链接：http://www.cnblogs.com/stulzq/p/8962018.html
