讲师中心 微信公众号
AI工具推荐 视频效率加速

Java 中自定义校验注解怎么实现才能完成参数合法性检查

阿伟大大_4069

阿伟大大_4069

发布时间:2026-10-20 06:57:38

|

917人浏览过

|

来源于php中文网

原创

Java自定义校验注解需用@Constraint标记并指定validatedBy,配合ConstraintValidator实现;注解须声明@Retention(RUNTIME)和@Target({FIELD, PARAMETER}),支持默认消息与分组。

java 中自定义校验注解怎么实现才能完成参数合法性检查

Java 中自定义校验注解的核心是结合 javax.validation(或 jakarta.validation)的约束机制,通过定义注解 + 约束校验器(ConstraintValidator)来实现参数合法性检查。关键在于注解要声明约束逻辑,而校验器负责具体执行判断。

定义自定义校验注解

注解需用 @Constraint 标记,并指定对应的校验器类。它通常支持运行时保留(@Retention(RetentionPolicy.RUNTIME))、作用于字段/方法参数(@Target({FIELD, PARAMETER})),并提供默认错误消息和分组支持。

例如,校验手机号是否符合国内 11 位规则:

@Target({FIELD, PARAMETER})
@Retention(RUNTIME)
@Constraint(validatedBy = PhoneNumberValidator.class)
public @interface PhoneNumber {
    String message() default "手机号格式不正确";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

实现 ConstraintValidator 接口

校验器类需实现 ConstraintValidator<PhoneNumber, String>,泛型分别对应注解类型和被校验的数据类型。重写 isValid() 方法,在其中编写具体的合法性判断逻辑。

立即学习“Java免费学习笔记(深入)”;

JavaStoryDevelop
JavaStoryDevelop

你接手一个需求时,是不是经常这样:"改一个小字段 → 结果把不相关的代码也改了"、"需求说得很模糊 → 做着做着发现跑偏了"、"数据库加个字段 → 上线才发现漏了数据兼容"、"做了个新功能 → 一个月后自己都忘了当时怎么设计的"、"写到一半被中断 → 再回来不知道从哪继续";这个 Skill 就是专门解决这些问题的。 它会自动探测你的项目环境(JDK、Spring Boot、ORM、数据库、前端框架),记在

下载

注意:校验器必须有无参构造函数,且不能依赖 Spring Bean 注入(除非显式配置为 Spring 管理的 validator 实例);若需注入服务(如查库去重),应通过 ConstraintValidatorContext 或借助 Spring 的 SpringConstraintValidatorFactory。

示例实现:

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

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (value == null || value.trim().isEmpty()) {
            return true; // 允许空值,由 @NotBlank 控制
        }
        return value.matches(REGEX);
    }
}

在 Controller 或 DTO 中使用

将注解加在需要校验的字段或方法参数上,并确保启用校验(如 Spring MVC 中开启 @Valid 或 @Validated)。

  • 用于 DTO 字段:@PhoneNumber private String phone;
  • 用于接口参数:public ResponseEntity<?> register(@Valid @RequestBody UserDTO dto)
  • 校验失败时,Spring 会自动返回 MethodArgumentNotValidException,可统一捕获并转为友好提示

进阶:支持多语言与动态消息

若需根据上下文动态生成错误信息(如包含字段名、当前值),可在 isValid() 中调用 context.disableDefaultConstraintViolation(),再用 buildConstraintViolationWithTemplate() 自定义提示。

国际化支持则需将 message() 指向资源文件键(如 message = "{validation.phone.number}"),并在 ValidationMessages.properties 中配置对应文本。

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

10897

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

8022

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

6952

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1164

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

948

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1416

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2869

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

20151

2023.08.03

Playwright 测试失败怎么办
Playwright 测试失败怎么办

Playwright测试失败专题汇集超时、定位器匹配、浏览器提前关闭、依赖与插件配置、文件上传、SSL及Docker启动等故障文章,并介绍通过截图、报告和Trace定位错误。

0

2026.10.21

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn