跟着官网学ASP.NET Core 6.0之请求参数模型验证

前面，我们学习了模型绑定，这一节，我们继续跟着官网来学习一下模型验证，一般情况下，我们需要对传入的参数进行校验，常规操作一般是通过if来对每一个需要校验的参数进行判断，在使用模型之后，我们便可以借助ASP.NET Core提供的特性来简化我们这繁琐、重复的判断过程

我们继续前面的例子,一个ModelBindVo类型

1
2
3
4
5
6
7

public class ModelBindVo
   {
       public string Name { get; set; }

       public int Age { get; set; }

   }

一个Get请求方法

1
2
3
4
5
6

[HttpGet]
      public void GetUrlParams([FromQuery] ModelBindVo vo)
      {
          _logger.LogInformation(String.Format("{0},{1}",vo.Name,vo.Age));
          
      }

如果我们访问/api/ModelBind?Name=000&Age=90，会在日志中打印出000,90,如果我们是参数不是模型中的类型，如/api/ModelBind?Name=000&Age=happy，那么，服务端会直接返回400,并有这样的提示

这样的错误提示，肯定是要不得滴，另外，如果我们访问/api/ModelBind?Name=000，那么Age便会默认为0,如果，我们业务要求必须是年龄在18-60岁才能处理，其他情况便返回错误，这种怎么处理呢？一般是在程序里面写if是吧，用模型校验就不一样了，我们只需要这样

1
2
3
4
5
6
7
8

public class ModelBindVo
  {
      public string Name { get; set; }

      [Range(18, 60)]
      public int Age { get; set; }

  }

此时我们在访问接口/api/ModelBind?Name=000或者api/ModelBind?Name=000&Age=9，

作为开发人员来说，这样的提示肯定是看得懂的，那么，用户怎么看得懂呢？莫慌，我们可以在Range特性中指定ErrorMessage的错误提示内容

1
2
3
4
5
6
7
8

public class ModelBindVo
{
    public string Name { get; set; }

    [Range(18, 60, ErrorMessage = "年龄必须大于18岁，小于60岁")]
    public int Age { get; set; }

}

除了Range特性外，ASP.NET Core还为我们提供了其他验证特性,如:

• [Compare]：验证模型中的两个属性是否匹配。
• [EmailAddress]：验证属性是否具有电子邮件格式。
• [Phone]：验证属性是否具有电话号码格式。
• [Range]：验证属性值是否位于指定范围内。
• [RegularExpression]：验证 属性值是否与指定的正则表达式匹配。
• [Required]：验证字段是否不为 null。
• [StringLength]：验证字符串属性值是否不超过指定的长度限制。
• [Url]：验证属性是否是URL格式。

其他的特性，可以在
System.ComponentModel.DataAnnotations 命名空间下找到

当然，可能这些特性依然满足不了你的需要，那这就需要自定义校验特性。这有两种方式，第一种就是创建继承ValidationAttribute自定义验证特性类来重写IsValid方法,用法和内置特性一致;第二种便让模型继承IValidatableObject接口，我们来试试第二种

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

public class ModelBindVo: IValidatableObject
   {
       public string Name { get; set; }

       [Range(18, 60, ErrorMessage = "年龄必须大于18岁，小于60岁")]
       public int Age { get; set; }

       public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
       {
           if (this.Age==30)
           {
               yield return new ValidationResult("三十年河东，三十年河西，莫欺中年穷");
           }
       }
   }

这时，我们访问api/ModelBind?Name=000&Age=30,便会进入到我们自定义的逻辑中

ASP.NET Core还提供参数校验失败次数，今天就先不了解了，有兴趣的可以去官网了解一下，下面，我们继续学学设置 ASP.NET Core Web API 中响应数据的格式