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

阿伟大大_4069

阿伟大大_4069

2026-10-20

917人浏览

原创

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></phonenumber>,泛型分别对应注解类型和被校验的数据类型。重写 isValid() 方法,在其中编写具体的合法性判断逻辑。

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

JavaStoryDevelop
JavaStoryDevelop

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

下载

示例实现:

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);
    }
}</phonenumber>

在 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 中配置对应文本。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

10777

6

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

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

2023.07.05

7902

9

java自学难吗
java自学难吗

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

2023.07.31

6872

8

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

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

2023.08.01

1164

3

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

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

2023.08.02

948

3

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

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

2023.08.02

1396

5

java有什么用
java有什么用

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

2023.08.02

2849

5

java在线网站
java在线网站

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

2023.08.03

20131

3

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

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1255

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习