ASP.NET Core如何添加统一模型验证处理机制详解

一.前言

模型验证自asp.net mvc便有提供，我们可以在model(dto)的属性上加上数据注解（data annotations）特性，在进入action之前便会根据数据注解，来验证输入的数据是否合法，下面介绍以下如何统一处理验证并返回错误信息。话不多说了，来一起看看详细的介绍吧。

二.action过滤器实现统一验证

我们在判断验证状态时一般会在action里判断modelstate.isvalid是否为true。

public iactionresult create([frombody]createorderdto dto)
{
 if(modelstate.isvalid)
 {
  //todo:...
 }
}

如果我们在每个需要验证的action里面都写这个判断岂不是太麻烦，我们是否可以在进入所有的action之前都进行验证，如果错误，就直接返回错误信息，不去执行action了，当然时可以的。我们可以利用mvc的actionfilter即action过滤器，在执行action之前统一判断处理。

1.首先定义一个通用的返回结果类：

public class xchttpresult
{
 public string msg { get; set; }
 public bool result { get; set; }
}

2.定义一个actionfilter

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里配置过滤器，使其生效：

public void configureservices(iservicecollection services)
{
 services.addmvc(options =>
 {
 options.filters.add<xcactionfilter>();
 });
}

三.测试

定义一个dto:

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被成功拦截并返回错误信息.

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对的支持。