Java验证身份证号入参还能这样操作？雅，太优雅了

大风写全栈

发布于 2024-11-21 19:41:37

11500

代码可运行

文章被收录于专栏：锤子代码锤子代码

运行总次数：0

代码可运行

很常见的需求

验证身份证号算是比较常见的一类需求，平时开发中经常会涉及到。

之前我一般是在Controller验证，自己编写正则表达式，提示和返回错误提示信息。

这种方式有个弊端，会有很多重复代码，堆在一起，不优雅。

看着一大堆的if，头大，特别是当需要验证的字段达到几十个。能把人都整疯。

就想着不能这么一直摆烂下去，就找各种解决方案。

最终选择了jakarta（Java EE的继承）来实现验证。

整体实现逻辑一下就清晰了。

以Spring Boot作为基础，叠spring-boot-starter-validation。

再叠jakarta.validation-api,再叠hutool-all（hutool可叠可不叠，随心选）。

处理流程也变成了：

实体类定义属性，并添加验证注解；
Controller里面用@Valid验证POST入参，或者手动写代码验证；
返回字段验证结果。

🌰来了

说了这么多，不如来个🌰。

下面一一给出例子：

1. maven依赖

提示：Lombok用于简化实体类中的模板代码（比如: set,get等）。

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.8.26</version>
</dependency>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>
<dependency>
    <groupId>jakarta.validation</groupId>
    <artifactId>jakarta.validation-api</artifactId>
</dependency>

2. 实体类

import jakarta.validation.constraints.*;
import lombok.Data;
/**
 * 用户
 *
 * @author 
 * @since 2024/11/20
 */
@Data
public class User {
  @Size(min = 14, max = 18, message = "患者身份证号长度不能超过18位及小于15位")
  @NotEmpty(message = "患者身份证号不能为空")
  @IdCardValid(message = "无效的患者身份证号")
  private String idCard;
  @NotEmpty(message = "患者姓名不能为空")
  @Size(min = 2, max = 64, message = "患者姓名长度不能超过64位及小于2位")
  private String name;
  private Integer sex;
  @Size(min = 14, max = 18, message = "患者身份证号长度不能超过18位及小于15位")
  @Null
  @IdCardValid(message = "无效的亲属身份证号")
  private String childIdCard;
}

3. 自定义身份证验证注解

3.1 注解

import jakarta.validation.Constraint;
import jakarta.validation.Payload;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
 * 身份证验证
 *
 * @author 
 * @since 2024/11/20
 */
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = IDCardValidator.class)
public @interface IdCardValid {
  String message() default "Invalid ID card number";
  Class<?>[] groups() default {};
  Class<? extends Payload>[] payload() default {};
}

3.2 实现

import cn.hutool.core.util.IdcardUtil;
import jakarta.validation.ConstraintValidator;
import jakarta.validation.ConstraintValidatorContext;
/**
 * 身份证验证实现.
 *
 * @author 
 * @since 2024/11/20
 */
public class IDCardValidator implements ConstraintValidator<IdCardValid, String> {
  @Override
  public boolean isValid(String value, ConstraintValidatorContext context) {
    // 兼容可空参数.
    if (value == null || value.isEmpty()) {
      return true;
    }
    return IdcardUtil.isValidCard(value);
  }
}

4. 测试一下

import jakarta.validation.ConstraintViolation;
import jakarta.validation.Validation;
import jakarta.validation.Validator;
import jakarta.validation.ValidatorFactory;
import java.util.*;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.util.StringUtils;

@SpringBootApplication
public class TestDemoApplication implements CommandLineRunner {

  public static void main(String[] args) {
    SpringApplication springApplication = new SpringApplication(TestDemoApplication.class);
    // ... 添加其它启动参数.
    springApplication.run(args);
  }
  
  private void printMessage(Set<ConstraintViolation<User>> violations) {
    for (ConstraintViolation<User> violation : violations) {
      if (StringUtils.hasLength(violation.getMessage())) {
        System.out.println(violation.getMessage());
        break;
      }
    }
  }
  
  @Override
  public void run(String... args) throws Exception {
    ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
    Validator validator = factory.getValidator();
    User user1 = new User();
    user1.setName("user1");
    user1.setIdCard(null);
    User user2 = new User();
    user2.setIdCard("");
    user2.setName("user2");
    user2.setChildIdCard("fdsafdsafdsafdsa6256");
    User user3 = new User();
    user3.setName("user3");
    user3.setIdCard("12345678901234567890");
    Set<ConstraintViolation<User>> check1 = validator.validate(user1);
    Set<ConstraintViolation<User>> check2 = validator.validate(user2);
    Set<ConstraintViolation<User>> check3 = validator.validate(user3);
    printMessage(check1);
    System.out.println("------------------");
    printMessage(check2);
    System.out.println("------------------");
    printMessage(check3);
  }
}

可用。大功告成！学会了吗？

本文参与腾讯云自媒体同步曝光计划，分享自微信公众号。

原始发表：2024-11-21，如有侵权请联系 cloudcommunity@tencent.com 删除

validation