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

2025-09-26 00:50

本文主要是介绍Java JDK Validation 注解解析与使用方法验证,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《JavaJDKValidation注解解析与使用方法验证》JakartaValidation提供了一种声明式、标准化的方式来验证Java对象,与框架无关,可以方便地集成到各种Java应用中,...

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. 核心接口

  • 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
@RequestMphpapping("/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 PhoneNumberphpValidator 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.m编程atcher(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 getUserhttp://www.chinasem.cn(@NotNull Long id) {
        // ...
    }
}

最佳实践

  • 合理选择验证级别:在DTO层进行基本验证,在业务层进行复杂验证
  • 使用适当的消息:提供清晰、用户友好的错误消息
  • 组合使用注解:如@NotNull + @Size比单独使用更安全
  • 避免过度验证:只在必要的地方添加验证
  • 考虑性能:大量验证可能影响性能,特别是在批量操作中

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

到此这篇关于Java JDK Validation 注解解析与使用的文章就介绍到这了,更多相关Java JDK Validation 注解内容请搜索China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程China编程(www.chinasem.cn)!

这篇关于Java JDK Validation 注解解析与使用方法验证的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1156032

相关文章

分析 Java Stream 的 peek使用实践与副作用处理方案

《分析JavaStream的peek使用实践与副作用处理方案》StreamAPI的peek操作是中间操作,用于观察元素但不终止流,其副作用风险包括线程安全、顺序混乱及性能问题,合理使用场景有限... 目录一、peek 操作的本质:有状态的中间操作二、副作用的定义与风险场景1. 并行流下的线程安全问题2. 顺

Java JUC并发集合详解之线程安全容器完全攻略

《JavaJUC并发集合详解之线程安全容器完全攻略》Java通过java.util.concurrent(JUC)包提供了一整套线程安全的并发容器,它们不仅是简单的同步包装,更是基于精妙并发算法构建... 目录一、为什么需要JUC并发集合?二、核心并发集合分类与详解三、选型指南:如何选择合适的并发容器?在多

JAVA实现Token自动续期机制的示例代码

《JAVA实现Token自动续期机制的示例代码》本文主要介绍了JAVA实现Token自动续期机制的示例代码,通过动态调整会话生命周期平衡安全性与用户体验,解决固定有效期Token带来的风险与不便,感兴... 目录1. 固定有效期Token的内在局限性2. 自动续期机制:兼顾安全与体验的解决方案3. 总结PS

Java Instrumentation从概念到基本用法详解

《JavaInstrumentation从概念到基本用法详解》JavaInstrumentation是java.lang.instrument包提供的API,允许开发者在类被JVM加载时对其进行修改... 目录一、什么是 Java Instrumentation主要用途二、核心概念1. Java Agent

python依赖管理工具UV的安装和使用教程

《python依赖管理工具UV的安装和使用教程》UV是一个用Rust编写的Python包安装和依赖管理工具,比传统工具(如pip)有着更快、更高效的体验,:本文主要介绍python依赖管理工具UV... 目录前言一、命令安装uv二、手动编译安装2.1在archlinux安装uv的依赖工具2.2从github

Java 结构化并发Structured Concurrency实践举例

《Java结构化并发StructuredConcurrency实践举例》Java21结构化并发通过作用域和任务句柄统一管理并发生命周期,解决线程泄漏与任务追踪问题,提升代码安全性和可观测性,其核心... 目录一、结构化并发的核心概念与设计目标二、结构化并发的核心组件(一)作用域(Scopes)(二)任务句柄

Java实现为PDF设置背景色和背景图片

《Java实现为PDF设置背景色和背景图片》在日常的文档处理中,PDF格式因其稳定性和跨平台兼容性而广受欢迎,本文将深入探讨如何利用Spire.PDFforJava库,以简洁高效的方式为你的PDF文档... 目录库介绍与安装步骤Java 给 PDF 设置背景颜色Java 给 PDF 设置背景图片总结在日常的

利用Python把路径转为绝对路径的方法

《利用Python把路径转为绝对路径的方法》在Python中,如果你有一个相对路径并且想将其转换为绝对路径,你可以使用Path对象的resolve()方法,Path是Python标准库pathlib中... 目录1. os.path.abspath 是什么?怎么用?基本用法2. os.path.abspat

Java中的Schema校验技术与实践示例详解

《Java中的Schema校验技术与实践示例详解》本主题详细介绍了在Java环境下进行XMLSchema和JSONSchema校验的方法,包括使用JAXP、JAXB以及专门的JSON校验库等技术,本文... 目录1. XML和jsON的Schema校验概念1.1 XML和JSON校验的必要性1.2 Sche

C++读写word文档(.docx)DuckX库的使用详解

《C++读写word文档(.docx)DuckX库的使用详解》DuckX是C++库,用于创建/编辑.docx文件,支持读取文档、添加段落/片段、编辑表格,解决中文乱码需更改编码方案,进阶功能含文本替换... 目录一、基本用法1. 读取文档3. 添加段落4. 添加片段3. 编辑表格二、进阶用法1. 文本替换2