Hibernate Validator：优雅的Java参数校验框架

2023-11-09 16:27:13

Hibernate Validator简介

Hibernate Validator是一个流行的Java参数校验框架，它可以帮助我们轻松地对Java对象的参数进行校验。Hibernate Validator提供了丰富的校验注解和校验规则，支持级联校验、分组校验和自定义校验。

2. Hibernate Validator基本用法

2.1 依赖引入

首先，我们需要在项目中引入Hibernate Validator的依赖。

<dependency>
  <groupId>org.hibernate.validator</groupId>
  <artifactId>hibernate-validator</artifactId>
  <version>7.0.1.Final</version>
</dependency>

2.2 校验注解

Hibernate Validator提供了丰富的校验注解，我们可以通过在Java对象的参数上使用这些注解来对参数进行校验。常用的校验注解包括：

@NotNull: 校验参数不能为空。
@NotEmpty: 校验参数不能为空字符串或集合。
@Size: 校验参数的长度或大小是否在指定范围内。
@Email: 校验参数是否为有效的电子邮件地址。
@Pattern: 校验参数是否符合指定的正则表达式。

2.3 校验方式

Hibernate Validator提供了两种校验方式：

方法校验 ：在方法的参数上使用校验注解，在方法调用时进行校验。
属性校验 ：在Java对象的属性上使用校验注解，在对象创建或更新时进行校验。

3. Hibernate Validator高级特性

3.1 级联校验

级联校验是指对Java对象及其嵌套对象的属性进行校验。Hibernate Validator支持级联校验，我们可以通过在Java对象上使用@Valid注解来启用级联校验。

3.2 分组校验

分组校验是指根据不同的校验场景对Java对象进行校验。Hibernate Validator支持分组校验，我们可以通过在校验注解上指定校验组来实现分组校验。

3.3 自定义校验

Hibernate Validator还支持自定义校验。我们可以通过实现javax.validation.ConstraintValidator接口来实现自定义校验。

4. Hibernate Validator使用示例

我们来看一个简单的使用示例。假设我们有一个User类，它的属性包括name、age和email。

public class User {

  @NotNull
  private String name;

  @Min(18)
  private int age;

  @Email
  private String email;

  //省略getter和setter方法
}

我们可以使用Hibernate Validator来校验User类。

public class UserController {

  @PostMapping("/user")
  public User createUser(@RequestBody User user) {
    ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
    Validator validator = factory.getValidator();
    Set<ConstraintViolation<User>> violations = validator.validate(user);
    if (violations.isEmpty()) {
      //保存用户
      return userService.save(user);
    } else {
      //校验失败，返回错误信息
      return ResponseEntity.badRequest().body(violations);
    }
  }
}