java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > Java JDK Validation 注解

Java JDK Validation 注解解析与使用方法验证

作者：Full Stack Developme

Jakarta Validation提供了一种声明式、标准化的方式来验证Java对象,与框架无关,可以方便地集成到各种Java应用中,本文给大家介绍Java JDK Validation 注解解析与使用,感兴趣的朋友一起看看吧

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

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

位于 jakarta.validation。

核心概念

1. 主要注解

基本约束注解

注解作用
@NotNull验证值不为 null
@Null验证值必须为 null
@AssertTrue验证布尔值为 true
@AssertFalse验证布尔值为 false
@Min(value)验证数字不小于指定值
@Max(value)验证数字不大于指定值
@DecimalMin(value)验证数字不小于指定值（字符串形式）
@DecimalMax(value)验证数字不大于指定值（字符串形式）
@Size(min, max)验证集合/数组/字符串大小在范围内
@Digits(integer, fraction)验证数字格式
@Past验证日期是过去的
@PastOrPresent验证日期是过去或现在
@Future验证日期是将来的
@FutureOrPresent验证日期是将来或现在
@Pattern(regex)验证字符串匹配正则表达式
@Email验证字符串是有效的电子邮件格式

其他常用注解

注解作用
@Valid级联验证对象中的属性
@NotEmpty验证字符串/集合不为 null 且不为空
@NotBlank验证字符串不为 null 且至少包含一个非空白字符
@Positive验证数字为正数
@PositiveOrZero验证数字为正数或零
@Negative验证数字为负数
@NegativeOrZero验证数字为负数或零

2. 核心接口

使用方法

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) {
        // ...
    }
}

最佳实践

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

到此这篇关于Java JDK Validation 注解解析与使用的文章就介绍到这了,更多相关Java JDK Validation 注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文