Java 中怎么自定义注解实现手机号或身份证号的组合参数校验器

雨涛吖_7753

雨涛吖_7753

2026-09-23

295人浏览

原创

java中可通过类级自定义注解+constraintvalidator实现手机号与身份证号的组合校验,即“至少填一项”,需在注解中指定validatedby,并在validator中通过getter获取多字段值联合判断。

java 中怎么自定义注解实现手机号或身份证号的组合参数校验器

在 Java 中,可以通过自定义注解 + ConstraintValidator 实现对手机号、身份证号等敏感字段的组合校验(比如“手机号或身份证号至少填一个”),而不是单字段独立校验。关键在于:注解需标注在类/方法上,校验逻辑在 ConstraintValidator 中访问整个对象,从而获取多个字段值进行联合判断。

1. 定义组合校验注解(类级注解)

该注解需作用于类(@Target(ElementType.TYPE)),并指定验证器实现类:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = ContactInfoValidator.class)
public @interface ValidContactInfo {
    String message() default "手机号或身份证号必须填写至少一项";
    Class>[] groups() default {};
    Class extends Payload>[] payload() default {};
}

2. 编写 ConstraintValidator 实现类

继承 ConstraintValidator<validcontactinfo object></validcontactinfo>,在 isValid 方法中强转为具体业务类,读取手机号和身份证号字段(推荐用 getter,避免反射字段名硬编码):

public class ContactInfoValidator implements ConstraintValidator<validcontactinfo object> {

    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {
        if (value == null) return true; // 让 @NotNull 处理空对象

        String phone = null;
        String idCard = null;

        if (value instanceof UserForm) {
            UserForm form = (UserForm) value;
            phone = form.getPhone();
            idCard = form.getIdCard();
        }

        // 去除首尾空格后判断是否非空
        boolean hasPhone = !StringUtils.isBlank(phone);
        boolean hasIdCard = !StringUtils.isBlank(idCard);

        if (!hasPhone && !hasIdCard) {
            // 禁用默认错误信息,自定义路径提示(可选)
            context.disableDefaultConstraintViolation();
            context.buildConstraintViolationWithTemplate(context.getDefaultConstraintMessageTemplate())
                   .addPropertyNode("phone").addConstraintViolation();
            return false;
        }
        return true;
    }
}
</validcontactinfo>

说明:

  • 使用 StringUtils.isBlank()(来自 Apache Commons Lang)兼容 null / 纯空格;若不用第三方库,可用 Objects.toString(x, "").trim().length() == 0
  • 校验失败时,可调用 context.disableDefaultConstraintViolation() 自定义报错字段(如指向 phone),提升前端定位体验
  • 若实体类字段命名固定,也可用反射通用读取(但需处理异常、性能略低,不推荐初学使用)

3. 在 DTO 或表单类上使用注解

@ValidContactInfo 加在类上,并保留字段级基础校验(如格式、长度):

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

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

下载
@ValidContactInfo
public class UserForm {
    private String name;

    @Pattern(regexp = "^1[3-9]\d{9}$", message = "手机号格式不正确")
    private String phone;

    @Pattern(regexp = "^[1-9]\d{5}(18|19|20)\d{2}((0[1-9])|(1[0-2]))(([0-2][1-9])|10|20|30|31)\d{3}[0-9Xx]$", 
             message = "身份证号格式不正确")
    private String idCard;

    // getters & setters...
}

注意:

  • 字段级注解(如 @Pattern)仍需保留,它们负责「格式合法」,而组合注解负责「业务必填逻辑」
  • Spring MVC 中,只需在 Controller 方法参数加 @Valid 即可触发整套校验

4. Controller 中启用校验

配合 Spring 的标准验证流程即可:

@PostMapping("/user")
public Result save(@Valid @RequestBody UserForm form) {
    // 校验通过才执行
    return userService.save(form);
}

若校验失败,Spring 会自动返回 400 Bad Request 并携带错误信息(可通过全局异常处理器统一格式化)。

不复杂但容易忽略的是:组合校验必须是类级注解,且验证器里要主动获取多个字段值——它不是替代单字段校验,而是补足业务规则维度。

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

8917

6

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

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

2023.07.05

6122

9

java自学难吗
java自学难吗

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

2023.07.31

5492

8

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

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

2023.08.01

984

3

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

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

2023.08.02

828

3

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

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

2023.08.02

1156

5

java有什么用
java有什么用

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

2023.08.02

2349

5

java在线网站
java在线网站

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

2023.08.03

19691

3

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

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

2023.08.03

1075

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习