JDK Validation 注解解析与使用

Jakarta Validation（原 JSR-380，也称为 Bean Validation 2.0）是 Java 中用于验证对象数据的标准 API。

它提供了一套注解和接口，用于声明和执行验证规则。

位于 jakarta.validation。

核心概念

1. 主要注解

基本约束注解

其他常用注解

2. 核心接口

• Validator: 执行验证的主要接口

• ConstraintValidator: 自定义约束验证器接口

• ConstraintViolation: 表示验证失败的结果

• ConstraintValidatorContext: 自定义验证器的上下文

使用方法

1. 基本使用

添加依赖 (Maven)

<dependency>
    <groupId>jakarta.validation</groupId>
    <artifactId>jakarta.validation-api</artifactId>
    <version>3.0.2</version>
</dependency>
<!-- 实现 (如 Hibernate Validator) -->
<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>8.0.1.Final</version>
</dependency>

定义验证对象

public class User {
    @NotNull(message = "用户名不能为空")
    @Size(min = 3, max = 20, message = "用户名长度必须在3-20之间")
    private String username;

    @Email(message = "邮箱格式不正确")
    private String email;

    @Min(value = 18, message = "年龄必须大于18岁")
    private int age;

    // getters and setters
}

执行验证

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

User user = new User();
user.setUsername("ab"); // 太短
user.setEmail("invalid-email");
user.setAge(17);

Set<ConstraintViolation<User>> violations = validator.validate(user);

for (ConstraintViolation<User> violation : violations) {
    System.out.println(violation.getPropertyPath() + ": " + violation.getMessage());
}

2. 在 Spring Boot 中使用

Spring Boot 自动集成了 Bean Validation，可以直接使用：

控制器验证

@RestController
@RequestMapping("/users")
public class UserController {
    
    @PostMapping
    public ResponseEntity<String> createUser(@Valid @RequestBody User user) {
        // 如果验证失败，会抛出MethodArgumentNotValidException
        return ResponseEntity.ok("用户创建成功");
    }
}

全局异常处理

@ControllerAdvice
public class GlobalExceptionHandler {
    
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, String>> handleValidationExceptions(
        MethodArgumentNotValidException ex) {
        
        Map<String, String> errors = new HashMap<>();
        ex.getBindingResult().getAllErrors().forEach((error) -> {
            String fieldName = ((FieldError) error).getField();
            String errorMessage = error.getDefaultMessage();
            errors.put(fieldName, errorMessage);
        });
        return ResponseEntity.badRequest().body(errors);
    }
}

3. 自定义验证注解

定义注解

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = PhoneNumberValidator.class)
public @interface PhoneNumber {
    String message() default "无效的电话号码";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

实现验证器

public class PhoneNumberValidator implements ConstraintValidator<PhoneNumber, String> {
    private static final Pattern PHONE_PATTERN = Pattern.compile("^1[3-9]\\d{9}$");

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (value == null) {
            return true; // 使用@NotNull处理null值
        }
        return PHONE_PATTERN.matcher(value).matches();
    }
}

使用自定义注解

public class ContactInfo {
    @PhoneNumber
    private String phone;
    
    // getter and setter
}

高级特性

1. 分组验证

public interface BasicInfo {}
public interface AdvancedInfo {}

public class User {
    @NotNull(groups = BasicInfo.class)
    private String username;
    
    @Email(groups = AdvancedInfo.class)
    private String email;
}

// 使用分组验证
Set<ConstraintViolation<User>> violations = validator.validate(user, BasicInfo.class);

2. 级联验证

public class Order {
    @Valid
    private List<OrderItem> items;
}

public class OrderItem {
    @NotNull
    private String productId;
    
    @Min(1)
    private int quantity;
}

3. 自定义消息

可以使用表达式和EL表达式：

@Size(min = 6, max = 20, message = "密码长度必须在 {min} 到 {max} 之间")
private String password;

4. 方法验证

验证方法参数和返回值：

public class UserService {
    @Validated
    public void createUser(@Valid User user) {
        // ...
    }
    
    @Valid
    public User getUser(@NotNull Long id) {
        // ...
    }
}

最佳实践

1. 合理选择验证级别：在DTO层进行基本验证，在业务层进行复杂验证

2. 使用适当的消息：提供清晰、用户友好的错误消息

3. 组合使用注解：如@NotNull + @Size比单独使用更安全

4. 避免过度验证：只在必要的地方添加验证

5. 考虑性能：大量验证可能影响性能，特别是在批量操作中

Jakarta Validation 提供了一种声明式、标准化的方式来验证Java对象，与框架无关，可以方便地集成到各种Java应用中。