Java Validated 分组校验的使用

2022-07-22 12:59:22
目录

前言:

开发中我们会遇到多个接口公用一个请求对象的情况，如果需求变更，势必会破坏已有代码的逻辑，不符合开闭原则，对参数校验修修补补，不如一开始就划分明确，所以在这里记录下分组校验注解@Validated的使用。

测试过程：

1.新建SpringBoot项目

新建一个SpringBoot项目，新建module -> 引入依赖 -> 编写主启动类 -> 编写配置文件 -> 新建各种包

2.新建组

Validated有自己默认的组 Default.class

我们要建的组，就是不同业务使用字段分成的组，举例的业务是一个用户对象，用户有不同的角色，不同的接口会用到这个用户对象的不同字段。比如学生(Student)，老师(Teacher):

Student

1
2
public interface Student {
}

Teacher

1
2
public interface Teacher {
}

3.新建请求对象

我们的业务是多个接口共用一个请求对象，所以不同接口用到这个对象里的字段一定不同。所以在这里对不同的字段作了分组，比如：

  • 老师肯定会有手机号、手下也一定有几个学生,所以被划分到Teacher组；

  • 学生一定要有几本书，所以被划分到Student组；

  • 没有被分组的字段默认是Default组；

  • 给所有字段用校验注解添加校验，以便测试是否分组生效。

Java技术迷

UserDTO

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
@Data
public class UserDTO {
 
    @NotBlank(message = "id必传")
    private String id;
 
    @NotBlank(message = "不能没有名称")
    private String name;
 
    @NotBlank(message = "老师不能没有手机号", groups = Teacher.class)
    private String phone;
 
    @NotNull(message = "age必传")
    private Integer age;
 
    @NotBlank(message = "不能没有idCard")
    private String idCard;
 
    @NotEmpty(message = "学生不能没有书")
    @Size(min = 2, message = "学生必须有两本书", groups = Student.class)
    private List<String> bookNames;
 
    @NotEmpty
    @Size(min = 1, message = "老师不能没有学生", groups = Teacher.class)
    private List<String> studentNames;
}

4.接口测试

对这个对象的不同业务划分出5个接口，测试下字段分组之后的必传情况： 这样看的清楚些

Controller

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
@RestController
public class ValidatedController {
     
    /**
     * 测试 分组校验 student
     *
     * @date 2022/2/11 15:47:14
     */
    @PostMapping("student")
    public UserDTO validatedStudent(@Validated(value = {Student.class, Default.class}) @RequestBody UserDTO userDTO) {
        return userDTO;
    }
 
    /**
     * 测试 分组校验  teacher
     *
     * @date 2022/2/11 15:47:14
     */
    @PostMapping("teacher")
    public UserDTO validatedTeacher(@Validated(value = {Teacher.class, Default.class}) @RequestBody UserDTO userDTO) {
        return userDTO;
    }
 
    /**
     * 测试 分组校验  default
     *
     * @date 2022/2/11 15:47:14
     */
    @PostMapping("default")
    public UserDTO validatedDefault(@Validated(value = {Default.class}) @RequestBody UserDTO userDTO) {
        return userDTO;
    }
 
    /**
     * 测试 分组校验 onlyStudent
     *
     * @date 2022/2/11 15:47:14
     */
    @PostMapping("onlyStudent")
    public UserDTO validatedOnlyStudent(@Validated(value = {Student.class}) @RequestBody UserDTO userDTO) {
        return userDTO;
    }
 
    /**
     * 测试 分组校验 onlyTeacher
     *
     * @date 2022/2/11 15:47:14
     */
    @PostMapping("onlyTeacher")
    public UserDTO validatedOnlyTeacher(@Validated(value = {Teacher.class}) @RequestBody UserDTO userDTO) {
        return userDTO;
    }
 
}

对 Student、Teacher、Default、OnlyStudent、OnlyTeacher 进行测试

不需要列举所有情况，这里就用Student接口做测试。这个接口如果不传递Student组的bookNames字段或者bookNames字段长度不足 2 就会抛出异常，但是因为分组的缘故，即使不传递Teacher Group的字段也不会受到影响。

不传bookNames

只传递一个bookNames

5.结论

其它接口例子我就不多说了，因为没有显式分组的默认都是Default组，所以，测试接口里面有Default组的测试，就是默认没有分组的属性都归Default管理;
测试用例中的only这两个组，就是在没有Default的情况下，只对Student和Teacher 组的字段进行校验;
要注意平常我们写@Validated注解的时候，默认就是@Validated(group = {Default.class}),也就是默认所有字段都是Default组的，显式分组之后，剩下的那些没有被划分到自建组的字段都是Default组;
因为这种机制的出现所以我们可以很灵活的使用对象里面的某些字段，比如可以新建一个Master组，可以将Student和Teacher组的字段都划分到Master组，以实现类似于高权限等级的参数传递校验等等操作！




名称：GEEK