介绍

Hibernate-Validator 是一个 Java 数据校验框架，它是 Bean Validation 规范（JSR 303/JSR 349）的参考实现。Bean Validation 是 Java EE 6 中的一项子规范，旨在为 Java 应用提供一种统一的数据验证机制。

通过 Hibernate-Validator，开发者可以在 POJO（Plain Old Java Object）类或其属性上使用注解来定义数据验证规则，如非空检查、长度限制、数值范围等。这些注解包括内置的约束注解以及一些自定义扩展注解。当需要进行数据验证时，只需调用特定的方法即可执行验证过程，如果数据不符合指定的规则，则会抛出异常并提供相应的错误信息。

Hibernate-Validator 提供了以下功能：

1. 空与非空检查：`@NotNull` 和 `@Null`

2. 布尔值检查：`@AssertTrue` 和 `@AssertFalse`

3. 日期检查：`@Past`、`@Future`、`@Pattern`（正则表达式）

4. 数值检查：`@Min`、`@Max`、`@DecimalMin`、`@DecimalMax`、`@Size`

5. 其他 Hibernate-validator 扩展约束：例如 `@Email`、`@NotBlank` 等

6. 支持 EL 表达式（Expression Language），可以更灵活地编写验证规则

使用 Hibernate-Validator 可以将数据验证逻辑从业务代码中分离出来，提高代码可读性和维护性，同时简化了数据验证的过程。此外，由于它遵循 JSR 303/JSR 349 标准，因此与其他支持 Bean Validation 的框架和库具有良好的兼容性。

gradle.build

 dependencies {    implementation 'org.springframework.boot:spring-boot-starter-web'    compileOnly 'org.projectlombok:lombok'    annotationProcessor 'org.projectlombok:lombok'     implementation("org.hibernate.validator:hibernate-validator:8.0.1.Final")    implementation 'org.json:json:20230227'}

@RestControllerAdvicepublic class MyAppExceptionHandler {    @ExceptionHandler(Exception.class)    public ResponseEntity<String> handlerException(Throwable e) {        e.printStackTrace();        if (e instanceof MethodArgumentNotValidException appException) {            List<ObjectError> allErrors = appException.getBindingResult().getAllErrors();            ObjectError objectError = allErrors.stream().findFirst().get();            JSONObject jsonObject = new JSONObject();            jsonObject.put("code", 100001);            jsonObject.put("message", objectError.getDefaultMessage());            String r = jsonObject.toString();            return new ResponseEntity<>(r, HttpStatus.OK);        }else if(e instanceof HandlerMethodValidationException appException){        }        JSONObject jsonObject = new JSONObject();        jsonObject.put("code", -1);        jsonObject.put("message", "未知异常,请联系管理员");        String r = jsonObject.toString();        return new ResponseEntity<>("", HttpStatus.OK);    }}

注解

说明

@AssertFalse

所注解的元素必须是Boolean类型，且值为false

@AssertTrue

所注解的元素必须是Boolean类型，且值为true

@DecimalMax

所注解的元素必须是数字，且值小于等于给定的值

@DecimalMin

所注解的元素必须是数字，且值大于等于给定的值

@Digits

所注解的元素必须是数字，且值必须是指定的位数

@Future

所注解的元素必须是将来某个日期

@Max

所注解的元素必须是数字，且值小于等于给定的值

@Min

所注解的元素必须是数字，且值小于等于给定的值

@Range

所注解的元素需在指定范围区间内

@NotNull

所注解的元素值不能为null

@NotBlank

所注解的元素值有内容

@Null

所注解的元素值为null

@Past

所注解的元素必须是某个过去的日期

@PastOrPresent

所注解的元素必须是过去某个或现在日期

@Pattern

所注解的元素必须满足给定的正则表达式

@Size

所注解的元素必须是String、集合或数组，且长度大小需保证在给定范围之内

@Email

所注解的元素需满足Email格式

输入实体类

import jakarta.validation.constraints.AssertFalse;import jakarta.validation.constraints.NotBlank;import lombok.AllArgsConstructor;import lombok.Data;@Data@AllArgsConstructorpublic class TestInput {    @AssertFalse(message = "age值错误")    private Boolean age;    @NotBlank(message = "name 错误")    private String name;}

测试控制器

import com.my.app.vo.TestInput;import jakarta.validation.Valid;import org.springframework.web.bind.annotation.*;@RestControllerpublic class TestController {    @PostMapping("/test1")    String test1(@RequestBody @Valid TestInput input) {        return "success";    }}

测试

curl --location '; \--header 'Content-Type: application/json' \--data '{    "age":true,    "name":"test"}'{"code":100001,"message":"age值错误"}

curl --location '; \--header 'Content-Type: application/json' \--data '{    "age":false,    "name":""}'{"code":100001,"message":"name 错误"}

完整案例github地址