【参数校验框架】@Validated 的分组序列的使用

一、概念理解

• 默认情况下，不同组别的约束验证是无序的，然而在某些情况下，约束验证的顺序却很重要

• 第二个组中的约束验证依赖于一个稳定状态来运行，而这个稳定状态是由第一个组来进行验证的

• 某个组的验证比较耗时，CPU 和内存的使用率相对比较大，最优的选择是将其放在最后进行验证。因此，在进行组验证的时候尚需提供一种有序的验证方式，这就提出了组序列的概念

• 一个组可以定义为其它组的序列，使用它进行验证的时候必须符合该序列规定的顺序。在使用组序列验证的时候，如果序列前边的组验证失败，则后面的组将不再给予验证

• 在某些场景下，对于一个实体对象进行属性校验的过程中，可能一个场景需要校验属性 A，一个场景需要校验属性 B，更甚至的是，一个场景需要校验属性 A 不能为空，一个场景也同样需要校验属性 A，但是校验到是属性 A 的最小值不能小于多少

• 类似这样的场景，我们就需要采用 @Validated 的分组功能才能解决此类问题，扩展性高，可以根据不同的业务需求，根据设置分组进行校验

二、场景说明

• 假设场景 B 校验的时候需要很长的时间或者很耗性能

• 需要先验证场景 A 的合规性以后才验证场景 B 的合规性

三、校验场景

• 用户注册和更新的场景

• 用户更新场景中，需要校验用户 ID 不能为空，用户名、密码不能为空

• 用户注册场景中，需要校验用户名不能为空、密码长度必须为 8~10

四、框架使用

1. 定义分组接口，需要继承 Default 校验接口

   /**
    * Copyright (C), 1998-2021, Shenzhen Rambo Technology Co., Ltd
    * 此接口只用于 validated 的分组验证功能，具体接口命名请采用见名知意的方式
    *
    * 需要继承默认校验分组，如果不继承默认校验分组，则会出现，如果实体中出现了分组的设置，
    * 那么默认分组（也就是没有设置分组的属性）则不被校验
    *
    * @author  Rambo
    * @date    2021/3/13 11:06
    * @since   1.0.0.1
    */
   public interface ValidatedSectionA extends Default {
   }    
   

   /**
    * Copyright (C), 1998-2021, Shenzhen Rambo Technology Co., Ltd
    * 此接口只用于 validated 的分组验证功能，具体接口命名请采用见名知意的方式
    *
    * 需要继承默认校验分组，如果不继承默认校验分组，则会出现，如果实体中出现了分组的设置，
    * 那么默认分组（也就是没有设置分组的属性）则不被校验
    *
    * @author  Rambo
    * @date    2021/3/13 11:06
    * @since   1.0.0.1
    */
   public interface ValidatedSectionB extends Default {
   }
   

2. 定义分组序列接口

   /**
    * Copyright (C), 1998-2021, Shenzhen Rambo Technology Co., Ltd
    * 分组序列接口，定义的是对分组的校验规则进行顺序校验，只有符合规则 A 的场景以后才去校验规则 B
    *
    * 需要继承默认校验分组，如果不继承默认校验分组，则会出现，如果实体中出现了分组的设置，
    * 那么默认分组（也就是没有设置分组的属性）则不被校验
    *
    * @author  Rambo
    * @date    2021/3/13 12:20
    * @since   1.0.0.1
    */
   @GroupSequence({ValidatedSectionA.class, ValidatedSectionB.class})
   public interface ValidatedGroup extends Default {
   }    
   

   P.S

   分组接口和分组序列接口都需要继承默认校验分组，如果不继承默认校验分组，则会出现，如果实体中出现了分组的设置，那么默认分组（也就是没有设置分组的属性）则不被校验

3. 用户实体定义

   @Data
   @ToString
   @AllArgsConstructor
   @NoArgsConstructor
   public class User implements Serializable {
       private static final long serialVersionUID = 278493012658730L;
   
       private int id;
   
       // 只有场景A（更新用户）的时候才校验
       @NotNull(message = "用户ID不能为空", groups = ValidatedSectionA.class)
       private int userId;
   
       // 场景A（更新用户） 或 场景B（注册用户） 都需要校验
       @NotNull(message = "用户名不能为空", groups = {ValidatedSectionA.class, ValidatedSectionB.class})
       private String userName;
   
       // 场景A（更新用户）校验密码不能为空
       @NotNull(message = "用户密码不能为空",groups = ValidatedSectionA.class)
       // 场景B（注册用户）校验密码长度规则
       @Size(min = 8, max = 10, message = "用户密码长度必须为 8 ～ 10 之间", groups = ValidatedSectionB.class)
       private String password;
   
       @NotNull(message = "手机号码不能为空")
       @Pattern(regexp = "^1[3|4|5|6|7|8|9][0-9]{9}$", message = "用户手机号不合法")
       private String telephone;
   }
   

4. 控制器绑定参数的校验方式

   @PostMapping("/queue/user")
   @ApiOperation(value = "用户更新、注册采用分组序列校验模拟", notes = "采用分组序列模拟用户更新和注册分组校验")
   public DataResult groupValidUser(@RequestBody @Validated(value = ValidatedGroup.class) User user) {
       log.info("The result is {}", user.toString());
       return DataResult.success();
   }
   

5. 模拟请求参数

   {
   }
   

6. 验证响应结果

   {
     "code": 10009,
     "msg": "手机号码不能为空;用户名不能为空;用户密码不能为空;",
     "detail": null,
     "data": null
   }