Hibernate Validator 校验 （二）

发表于 分类于 ， 阅读次数：

在Hibernate Validator 校验 （一）中，谈了如何利用 Hibernate Validator 提供的约束注解完成较为简单的对象校验，但这也不能满足开发的需求。这时，我们需要自己实现校验逻辑。

自定义校验逻辑

自实现校验有很多优点，一个项目下，肯定存在多个服务对同一类型的实例操作，而其校验逻辑大多类似。通过自实现校验将该逻辑抽象出来，一方面减少代码重复，又可以满足当下模块开发的思想。

先来看看测试类与 Controller 层实现，其实与上一篇中的实现无太大差别，只是此次我们将使用正则表达式校验username，规则是匹配任何字类字符，包括下划线，因此此处我们模拟发起增添用户的POST请求。

Controller层实现：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
@RestController
@RequestMapping("/user")
public class UserController {
  @PostMapping
  public User updateUser(@PathVariable Integer id, @RequestBody @Valid User user, BindingResult result) {
      // 输出错误信息
      if (result.hasErrors()) {
          result.getAllErrors().forEach(err -> System.out.println(err.getDefaultMessage()));
      }

      user.setId(id);

     return userService.update(user);
  }
}

测试类：

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
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserControllerTest {

  @Autowired
  private WebApplicationContext wac;

  private MockMvc mockMvc;

  @Before
  public void setUp() {
      this.mockMvc = MockMvcBuilders.webAppContextSetup(wac).build();
  }

  @Test
  public void testValidUser() throws Exception {
      Date date = new Date();
      String content = "{\"username\": \"@ksjkd\",\"password\": \"password\",\"birthday\":"
           - date.getTime() + "}";
      mockMvc.perform(post("/user")
                      .contentType(MediaType.APPLICATION_JSON_UTF8)
                      .content(content))
                      .andExpect(status().isOk());
  }

}

上一篇中也有提到，JPA Validation 规范对约束的定义包括两部分，一是约束注解，如上篇中用到的@NotBlank、NotNull等就是约束注解；二是约束校验器，每一个约束注解都存在对应的约束校验器，约束校验器实现具体的校验逻辑。我们自己实现 validator 也需要满足这两点。

一、创建约束注解与其对应的约束校验器

1
2
3
4
5
6
7
8
9
10
11
12
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = { TestValidator.class })
public @interface TestConstraint {

    String message() default ""; // 约束注解校验时的输出消息

    Class<?>[] groups() default { }; // 约束注解在校验时所属的组别

    Class<? extends Payload>[] payload() default { }; // 约束注解的有效负载
}

如上，在该注解上@Target与@Retention是 Java 中元注解中的两个，分别用于指明该注解的作用目标与保留位置，此处不多做赘述。而Constraint注解特用于指明 JPA 约束注解与约束校验器的对应关系。

另外，JPA Validation 规范要求自实现的约束注解必须声明以上三个参数，分别是：message, groups, payload。其中message属性便是当校验器校验失败时的输出消息，另两个属性的大致用途已在代码中注释，不再详述。

如下，为该校验器的实现：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
public class TestValidator implements ConstraintValidator<TestConstraint, String> {

    @Autowired
    private TestService testService;

    @Override
    public void initialize(TestConstraint constraintAnnotation) {
        // 添加约束注解在初始化时需要做的动作
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        System.out.println(testService.test(value));

        String pattern = "^\\w+$"; // 匹配任何字类字符，包括下划线。与"[A-Za-z0-9_]"等效

        Pattern r = Pattern.compile(pattern);
        Matcher m = r.matcher(value);

        return m.matches();
    }
}

自实现的校验器必须实现ConstraintValidator<A, T>接口，该接口有两个泛型，分别是该校验器所“对应的约束注解的类类型”和“被校验对象的类类型”。这里是针对String类型的username字段进行校验，所以两泛型类型分别为TestConstraint与String。

如果是 Spring 项目，当实现该接口则会自动被 Bean 容器收集为 Bean。因此，我们可以按需求Autowired需要的Bean。TestService实现如下：

1
2
3
4
5
6
@Service
public class TestService {
    public String test(String o) {
        return "test:[" + o + "]";
    }
}

本例中，该校验器采用“正则规则”对字符串进行匹配。

二、在实体中声明需要校验的字段

1
2
3
4
5
6
7
8
@Entity
public class User {

    @TestConstraint(message = "测试校验：用户名必须是数字、字母或_的组合")
    private String username;

    ...
}

利用我们方才定义的约束注解@TestConstraint对 username 字段进行校验，并自定义校验错误消息。

测试结果

在测试请求中，我们模拟的请求数据中username字段中添加了非法字符@，因此校验肯定是无法通过的：