一、场景说明
-
在某些场景下,对于一个实体对象进行属性校验的过程中,可能一个场景需要校验属性
A
,一个场景需要校验属性B
,更甚至的是,一个场景需要校验属性A
不能为空,一个场景也同样需要校验属性A
,但是校验到是属性A
的最小值不能小于多少 -
类似这样的场景,我们就需要采用
@Validated
的分组功能才能解决此类问题,扩展性高,可以根据不同的业务需求,根据设置分组进行校验
二、校验场景
-
用户注册和更新的场景
-
用户注册场景中,需要校验用户名不能为空、密码长度必须为
8~10
-
用户更新场景中,需要校验用户
ID
不能为空,用户名、密码不能为空
三、框架使用
-
定义分组接口,需要继承
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 { }
P.S
需要继承默认校验分组,如果不继承默认校验分组,则会出现,如果实体中出现了分组的设置,那么默认分组(也就是没有设置分组的属性)则不被校验
-
用户实体定义
@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; }
-
控制器绑定参数的校验方式
-
场景
A
的校验方式@PutMapping("/valid/user") @ApiOperation(value = "用户更新校验模拟", notes = "模拟用户更新分组校验") public DataResult updateUser(@RequestBody @Validated(value = ValidatedSectionA.class) User user) { log.info("The request is {}", user.toString()); return DataResult.success(); }
-
场景
A
和B
的校验方式@PostMapping("/valid/user") @ApiOperation(value = "用户更新、注册校验模拟", notes = "模拟用户更新和注册分组校验") public DataResult registerUser(@RequestBody @Validated(value = {ValidatedSectionA.class, ValidatedSectionB.class}) User user) { log.info("The request is {}", user.toString()); return DataResult.success(); }
-
-
模拟请求参数
-
场景
A
的校验方式{ "id": 0, "password": "123456", "telephone": "13999999999", "userId": 0, "userName": "string" }
-
场景
A
和B
的校验方式{ "id": 0, "password": "123456", "telephone": "13999999999", "userId": 0, "userName": "string" }
-
-
验证响应结果
-
场景
A
的校验方式{ "code": 0, "msg": "操作成功", "detail": null, "data": true }
-
场景
A
和B
的校验方式{ "code": 10009, "msg": "用户密码长度必须为 8 ~ 10 之间;", "detail": null, "data": null }
-