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

在 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):
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 大师之旅:从入门到精通的终极指南











