Java 中怎么编写自定义校验器类实现 ConstraintValidator

大伟小哥_8977

大伟小哥_8977

2026-10-15

451人浏览

原创

java中可通过实现constraintvalidator接口编写自定义校验器,核心步骤为:定义@constraint注解、实现校验逻辑类、在字段或参数上使用注解;支持动态参数、多类型校验及国际化提示。

java 中怎么编写自定义校验器类实现 constraintvalidator

在 Java 中,通过实现 ConstraintValidator 接口可以编写自定义校验器类,用于配合自定义注解对字段或参数进行校验。核心是定义注解 + 实现校验逻辑 + 在目标位置使用注解。

定义自定义约束注解

先创建一个注解,标注 @Constraint 并指定对应的校验器实现类:

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = PhoneValidator.class) // 指向校验器
public @interface ValidPhone {
    String message() default "手机号格式不正确";
    Class>[] groups() default {};
    Class extends Payload>[] payload() default {};
}

实现 ConstraintValidator 接口

编写校验器类,泛型指定为注解类型和被校验的数据类型(如 String):

OpenJDK 24
OpenJDK 24

OpenJDK 24 Windows x64 官方参考实现(24+36),适合 Windows 环境进行 Java 开发、编译、运行和版本兼容性验证。

下载
public class PhoneValidator implements ConstraintValidator<validphone string> {

    private static final String PHONE_REGEX = "^1[3-9]\d{9}$";

    @Override
    public void initialize(ValidPhone constraintAnnotation) {
        // 可在此初始化配置,如从注解中读取额外参数
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (value == null || value.trim().isEmpty()) {
            return true; // 允许空值(由 @NotBlank 等控制),也可改为 false
        }
        return value.matches(PHONE_REGEX);
    }
}</validphone>
  • initialize():可选,用于读取注解上的配置属性(比如支持多地区号码时传入国家码)
  • isValid():核心逻辑,返回 true 表示校验通过;注意处理 null 值的语义(通常让其他注解负责非空检查)
  • 校验失败时,框架会自动使用注解中的 message() 提示,默认支持占位符如 {value}(需在 message 中定义并传入)

在实体或方法参数上使用

将自定义注解加在需要校验的位置即可:

public class User {
    @ValidPhone
    private String phone;
    
    // getter/setter...
}

// 或用于 Controller 方法参数
@PostMapping("/register")
public Result register(@Valid @RequestBody User user) { ... }
  • 确保类路径下有 spring-boot-starter-validation(Spring Boot)或 hibernate-validator(普通 Java SE)依赖
  • 使用 @Valid 或 @Validated 触发级联校验(对嵌套对象也生效)
  • 若需国际化提示,把 message 改为键名(如 phone.invalid),并在 messages.properties 中配置对应文案

进阶:支持运行时参数与多类型校验

如果希望注解支持动态参数(如最小长度、允许前缀等),可在注解中添加属性,并在 initialize() 中读取:

public @interface ValidPhone {
    String message() default "手机号格式不正确";
    String[] prefixes() default {"13", "15", "18", "17"}; // 可配置号段
    Class>[] groups() default {};
    Class extends Payload>[] payload() default {};
}

// 在 PhoneValidator.initialize() 中:
@Override
public void initialize(ValidPhone constraintAnnotation) {
    this.prefixes = constraintAnnotation.prefixes();
}
  • 校验逻辑中根据 prefixes 构建正则或做前缀匹配
  • 若要支持多种数据类型(如同时校验 String 和 PhoneNumber 对象),需单独为每种类型写一个 ConstraintValidator 实现,或统一转为字符串处理

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

相关专题

更多
java
java

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

2023.06.15

10477

6

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

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

2023.07.05

7602

9

java自学难吗
java自学难吗

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

2023.07.31

6632

8

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

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

2023.08.01

1144

3

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

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

2023.08.02

928

3

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

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

2023.08.02

1376

5

java有什么用
java有什么用

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

2023.08.02

2749

5

java在线网站
java在线网站

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

2023.08.03

20071

3

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

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

2023.08.03

1215

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习