Java中jakarta.validation数据校验依赖包讲解

概述

在Java中，数据校验通常依赖于Bean Validation API，特别是Jakarta Bean Validation（以前的Hibernate Validator）。这个API允许你在Java对象上定义和执行约束规则，以确保数据的有效性和一致性。以下是有关jakarta.validation及其相关依赖包的详细讲解：

1. 依赖包

对于使用Bean Validation API的项目，通常需要添加相关的依赖包。以Maven为例，通常会包括以下几个主要依赖：

Jakarta Bean Validation API

这是Bean Validation的API规范定义包，定义了数据校验的基本接口和注解。

<dependency>
    <groupId>jakarta.validation</groupId>
    <artifactId>jakarta.validation-api</artifactId>
    <version>3.0.2</version> <!-- 版本可能会变化 -->
</dependency>

Hibernate Validator

这是Bean Validation的一个实现，提供了API的具体实现。

<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>8.0.1.Final</version> <!-- 版本可能会变化 -->
</dependency>

EL (Expression Language) 实现

Hibernate Validator 可能需要EL实现来处理一些注解的表达式。

<dependency>
    <groupId>org.glassfish</groupId>
    <artifactId>javax.el</artifactId>
    <version>3.0.0</version> <!-- 版本可能会变化 -->
</dependency>

2. 主要注解及其功能

以下是 jakarta.validation 包中一些核心注解的详细讲解：

@NotNull

• 功能: 确保值不为null。
• 用法:

@NotNull
private String name;

@Size

• 功能: 验证字符串、集合或数组的长度。
• 属性:
  • min: 最小长度
  • max: 最大长度
• 用法:

@Size(min = 2, max = 30)
private String username;

@Min 和 @Max

• 功能: 用于设置数值的最小值和最大值。
• 属性:
  • value: 最小值（@Min）或最大值（@Max）
• 用法:

@Min(18)
private int age;

@Max(120)
private int age;

@Email

• 功能: 验证字符串是否符合电子邮件格式。
• 用法:

@Email
private String email;

@Pattern

• 功能: 验证字符串是否符合正则表达式模式。
• 属性:
  • regexp: 正则表达式
• 用法:

@Pattern(regexp = "\\d{10}")
private String phoneNumber;

@Positive 和 @Negative

• 功能: 验证数值是否为正数或负数。
• 用法:

@Positive
private int positiveNumber;

@Negative
private int negativeNumber;

@Past 和 @Future

• 功能: @Past 验证日期是否在当前日期之前，@Future 验证日期是否在当前日期之后。
• 用法:

@Past
private LocalDate birthDate;

@Future
private LocalDate expiryDate;

3. 如何使用

配置和使用Validator

使用Bean Validation API通常涉及以下步骤：

1、创建和配置 ValidatorFactory:

ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
Validator validator = factory.getValidator();

2、验证对象:

User user = new User();
user.setUsername("A");
user.setAge(17);

Set<ConstraintViolation<User>> violations = validator.validate(user);
for (ConstraintViolation<User> violation : violations) {
    System.out.println(violation.getMessage());
}

3、使用Spring Boot集成:

在Spring Boot应用中，jakarta.validation 与 spring-boot-starter-validation 自动集成。Spring Boot会自动处理带有注解的Java Bean的验证。

示例:

Java Bean:

import jakarta.validation.constraints.Email;
import jakarta.validation.constraints.Min;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Size;

public class User {
    @NotNull(message = "Username cannot be null")
    @Size(min = 2, max = 30, message = "Username must be between 2 and 30 characters")
    private String username;

    @NotNull(message = "Age cannot be null")
    @Min(value = 18, message = "Age must be at least 18")
    private Integer age;

    @Email(message = "Email should be valid")
    private String email;

    // Getters and Setters
}

Controller:

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

import jakarta.validation.Valid;
import org.springframework.http.ResponseEntity;

@RestController
public class UserController {
    @PostMapping("/users")
    public ResponseEntity<String> createUser(@Valid @RequestBody User user) {
        // 处理有效的user
        return ResponseEntity.ok("User is valid!");
    }
}

1. 在这个示例中，Spring Boot会自动验证请求体中的User对象，并返回相应的验证错误信息（如果有的话）。

4. 定制验证逻辑

你也可以自定义验证逻辑，通过实现 ConstraintValidator 接口来创建自定义注解。

示例:

自定义注解:

import jakarta.validation.Constraint;
import jakarta.validation.Payload;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Constraint(validatedBy = CustomValidator.class)
@Target({ ElementType.METHOD, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface CustomConstraint {
    String message() default "Custom validation failed";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

自定义验证器:

import jakarta.validation.ConstraintValidator;
import jakarta.validation.ConstraintValidatorContext;

public class CustomValidator implements ConstraintValidator<CustomConstraint, String> {
    @Override
    public void initialize(CustomConstraint constraintAnnotation) {}

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 自定义验证逻辑
        return value != null && value.length() > 5;
    }
}

应用自定义注解:

public class Example {
    @CustomConstraint
    private String customField;
}

总结

jakarta.validation 包及其实现如 Hibernate Validator 提供了一个强大的数据验证框架，能够有效地在Java应用中确保数据的有效性。通过注解、接口和自定义验证逻辑，你可以灵活地实现数据校验，并与Spring Boot等框架集成，以提高应用程序的健壮性和用户体验。