本文目标

了解常用Spring MVC 注解校验，掌握基础的校验开发

练习场景

前端表单提交的数据在后端完成校验，检验不通过统一以ResultDto的形式返回提示

操作步骤

常用注解列表

注解	描述
@Min	数值范围校验，被注解的元素必须是一个数字，其值必须大于等于指定的最小值
@Max	数值范围校验，被注解的元素必须是一个数字，其值必须小于等于指定的最大值
@Length(min= ,max=)	字符串长度校验，被注解的字符串长度必须在指定范围内
@NotEmpty	非空校验，被注解的字符串必须为非空
@Null	被注解的元素必须为null
@NotNull	非null校验，被注解的元素必须必须不为null
@Mobile	手机号校验
@Email	邮箱校验
@In	选项内校验
@Pattern	正则表达式校验，被注解的元素必须符合指定的正则表达式
@Size	数组长度校验
@AssertFalse	限制必须为false
@AssertTrue	限制必须为true
@DecimalMax(value)	限制必须为一个不大于指定值的数字
@DecimalMin(value)	限制必须为一个不小于指定值的数字
@Digits(integer,fraction)	限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction
@Future	限制必须是一个将来的日期
@Past	限制必须是一个过去的日期
@NotBlank	验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格

实例开发

创建需要被校验的实体类

Student.java实体类对需要校验的属性添加注解，每一个注解都包含了message字段，用于校验失败时作为提示信息；需要校验的属性需生成Getter方法

@Min(value = 0, message = "不能小于{value}")
          @Max(value = 100, message = "不能大于{value}")
          private Integer age;
          
          @Length(max = 10, message = "不超过{max}个字符")
          private String name;
          
          @NotEmpty(message = "不能为空")
          @In(list = { "0", "1" }, message = "必须是{list}之一")
          private String sex;
          
          @Email(message = "邮箱格式不正确")
          @NotNull(message = "不能为null")
          private String email;
          @Size(max = 3, message = "数量不超过{max}个")
          @Valid
          private List<Subjects> subjects = new ArrayList<Subjects>();
          
          @Mobile(message = "手机号码格式不正确")
          @Pattern(regexp = "^1[34578]\\d{9}$", message = "手机号码格式匹配不正确")
          private String mobile;

接收层校验数据

接收层添加校验生效注解@Validated即可

@PostMapping("/api/tool/validation/test1")
public ResultDto test1(@RequestBody @Validated Student student)  {
       return new ResultDto(student);
 }

测试

正确

请求数据

 {
      "age": 10,
      "name": "lily",
      "sex": "1",
      "email": "123@163.com",
      "phone":"13587611234",
      "subjects":[
        {
        "subject": "English",
        "score": 90
        },{
        "subject": "Chinese",
        "score": 90
        }
      ],
       "mobile": "13587611234"
 }

校验正确结果返回格式

{
    "code": 0,
    "total": 0,
    "message": null,
    "level": null,
    "data": {
        "age": 10,
        "name": "lily",
        "sex": "1",
        "email": "123@163.com",
        "phone": "13587611234",
        "subjects": [
            {
                "subject": "English",
                "score": 90
            },
            {
                "subject": "Chinese",
                "score": 90
            }
        ],
        "mobile": "13587611234"
    }
}

错误

请求数据

 {
      "age": 11111,
      "name": "lilylilylilylilylilylily",
      "sex": "3",
      "email": "123@",
      "phone":"12345",
      "subjects":[
        {
        "subject": "English",
        "score": 90
        },{
        "subject": "Chinese",
        "score": 90
        },
        {
        "subject": "Math",
        "score": 90
        },
        {
        "subject": "Music",
        "score": 90
        }
      ],
       "mobile": "12345"
  }

校验错误结果返回格式

{
    "code": 503,
    "total": 0,
    "message": "age:不能大于100  sex:必须是[0, 1]之一  email:邮箱格式不正确  subjects:数量不超过3个  name:不超过10个字符  mobile:手机号码格式匹配不正确  phone:手机号码格式不正确  ",
    "level": "error",
    "data": null
}

@Validated和@Valid区别

Spring Validation验证框架对参数的验证机制提供了@Validated（Spring's JSR-303规范，是标准JSR-303的一个变种），javax提供了@Valid（标准JSR-303规范），配合BindingResult可以直接提供参数验证结果。在检验Controller的入参是否符合规范时，使用@Validated或者@Valid在基本验证功能上没有太多区别。但是在分组、注解地方、嵌套验证等功能上两个有所不同：

1. 分组 @Validated：提供了一个分组功能，可以在入参验证时，根据不同的分组采用不同的验证机制，这个网上也有资料，不详述。@Valid：作为标准JSR-303规范，还没有吸收分组的功能。 2. 注解地方 @Validated：可以用在类型、方法和方法参数上。但是不能用在成员属性（字段）上 @Valid：可以用在方法、构造函数、方法参数和成员属性（字段）上 两者是否能用于成员属性（字段）上直接影响能否提供嵌套验证的功能。 3. 嵌套验证 在比较两者嵌套验证时，先说明下什么叫做嵌套验证。如下有个实体叫做Item：

public class Item { 
    @NotNull(message = "id不能为空") 
    @Min(value = 1, message = "id必须为正整数") 
    private Long id;
 
    @NotNull(message = "props不能为空") 
    @Size(min = 1, message = "至少要有一个属性")
    private List<Prop> props;
}

Item带有很多属性，属性里面有属性id，属性值id，属性名和属性值，如下所示：

public class Prop { 
    @NotNull(message = "pid不能为空") 
    @Min(value = 1, message = "pid必须为正整数") 
    private Long pid;
 
    @NotNull(message = "vid不能为空") 
    @Min(value = 1, message = "vid必须为正整数") 
    private Long vid;
 
    @NotBlank(message = "pidName不能为空") 
    private String pidName;
 
    @NotBlank(message = "vidName不能为空") 
    private String vidName;
}

属性这个实体也有自己的验证机制，比如属性和属性值id不能为空，属性名和属性值不能为空等

如果Item实体的props属性不额外加注释，只有@NotNull和@Size，无论入参采用@Validated还是@Valid验证，Spring Validation框架只会对Item的id和props做非空和数量验证，不会对props字段里的Prop实体进行字段验证，也就是@Validated和@Valid加在方法参数前，都不会自动对参数进行嵌套验证。也就是说如果传的List<Prop>中有Prop的pid为空或者是负数，入参验证不会检测出来

为了能够进行嵌套验证，必须手动在Item实体的props字段上明确指出这个字段里面的实体也要进行验证。由于@Validated不能用在成员属性（字段）上，但是@Valid能加在成员属性（字段）上，而且@Valid类注解上也说明了它支持嵌套验证功能，由此推断出：@Valid加在方法参数时并不能够自动进行嵌套验证，而是用在需要嵌套验证类的相应字段上，来配合方法参数上@Validated或@Valid来进行嵌套验证，即item修改如下

public class Item { 
    @NotNull(message = "id不能为空") 
    @Min(value = 1, message = "id必须为正整数") 
    private Long id;
 
    @Valid // 嵌套验证必须用@Valid
    @NotNull(message = "props不能为空") 
    @Size(min = 1, message = "至少要有一个属性")
    private List`<Prop>` props;
}

然后我们在Controller/Resource中再使用@Validated或者@Valid，就能对Item的入参进行嵌套验证。此时Item里面的props如果含有Prop的相应字段为空的情况，Spring Validation框架就会检测出来

总结一下@Validated和@Valid在嵌套验证功能上的区别：

@Validated：用在方法入参上无法单独提供嵌套验证功能。不能用在成员属性（字段）上，也无法提示框架进行嵌套验证。能配合嵌套验证注解@Valid进行嵌套验证

@Valid：用在方法入参上无法单独提供嵌套验证功能。能够用在成员属性（字段）上，提示验证框架进行嵌套验证。能配合嵌套验证注解@Valid进行嵌套验证