Java 对象属性怎么实现自定义注解校验规则

星晨姑娘_6267

星晨姑娘_6267

2026-09-20

972人浏览

原创

java自定义注解校验核心是三步:定义注解(含@constraint指向验证器)、实现constraintvalidator接口编写isvalid逻辑、在字段上使用注解并配合@valid触发校验。

java 对象属性怎么实现自定义注解校验规则

Java 对象属性的自定义注解校验,核心是结合 javax.validation(Jakarta Bean Validation)规范,通过自定义约束注解 + 对应的约束验证器(ConstraintValidator)来实现。它不是简单加个注解就生效,而是需要三步:定义注解、实现校验逻辑、在字段上使用。

1. 定义自定义约束注解

@Target@Retention@Constraint 等元注解声明一个运行时可用的校验注解。例如,校验手机号是否符合国内 11 位规则:

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

注意:validatedBy 指向你后续要写的验证器类;message() 支持占位符(如 {value}),也可配合资源文件国际化。

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载

2. 实现 ConstraintValidator 接口

创建一个类实现 ConstraintValidator<phonenumber string></phonenumber>,泛型分别表示注解类型和被校验的字段类型:

public class PhoneNumberValidator implements ConstraintValidator<phonenumber string> {
    @Override
    public void initialize(PhoneNumber constraintAnnotation) {
        // 可选:读取注解参数,比如支持多国号段配置
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (value == null || value.trim().isEmpty()) {
            return true; // 允许空值(由 @NotBlank 或 @NotNull 控制)
        }
        return value.matches("1[3-9]\d{9}");
    }
}
</phonenumber>
  • 返回 true 表示校验通过;false 表示失败
  • initialize() 方法可用于初始化校验器(如读取注解上的额外属性)
  • 若需动态修改错误消息,可通过 context.buildConstraintViolationWithTemplate() 自定义提示

3. 在实体类中使用注解

把自定义注解加到目标字段上,并确保开启校验(如 Spring MVC 中 Controller 参数加 @Valid):

public class User {
    @PhoneNumber
    private String phone;

    @NotBlank
    private String name;
    // getter/setter...
}

在 Spring Boot 项目中,Controller 方法接收该对象时加上 @Valid 即可触发校验:

@PostMapping("/user")
public ResponseEntity> createUser(@Valid @RequestBody User user, BindingResult result) {
    if (result.hasErrors()) {
        // 处理错误
    }
    return ResponseEntity.ok().build();
}

4. 进阶技巧(可选但实用)

  • 支持多种字段类型:验证器可实现 ConstraintValidator<phonenumber object></phonenumber>,内部用 instanceof 分支判断
  • 组合注解:用 @ConstraintComposition(Jakarta EE 9+)或嵌套多个标准注解(如 @Size + @Pattern)封装常用规则
  • 运行时参数化:在注解中定义 String region() default "CN",验证器中读取并切换正则表达式
  • 集成 Lombok:配合 @Data@NoArgsConstructor,不影响校验生效

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

8657

6

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

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

2023.07.05

5862

9

java自学难吗
java自学难吗

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

2023.07.31

5272

8

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

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

2023.08.01

964

3

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

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

2023.08.02

808

3

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

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

2023.08.02

1136

5

java有什么用
java有什么用

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

2023.08.02

2289

5

java在线网站
java在线网站

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

2023.08.03

19631

3

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

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

2023.08.03

1035

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习