自定义校验注解，优雅的实现手机号，身份证号的格式校验！

导读（皮一下）

为什么需要自定义校验注解？

系统执行业务逻辑之前，会对输入数据进行校验，检测数据是否有效合法的。所以我们可能会写大量的if else等判断逻辑，特别是在不同方法出现相同的数据时，校验的逻辑代码会反复出现，导致代码冗余，阅读性和可维护性极差。

• 鉴于通用性和普遍性，Spring框架提供了validator组件，通过一些校验器，可以对一些数据进行统一的完整性和有效性等校验，即简单又好用。
• JSR-303是Java为Bean数据合法性校验提供的标准框架，它定义了一整套校验注解，可以标注在成员变量，属性方法等之上。
• 但是这些通用的校验注解，并不能满足我们的所有需求，如电话号格式校验，身份证号格式校验…

常用的校验器

在Java开发中，校验器（validator）是指用于数据验证的工具或库，它们帮助确保应用程序的数据符合预期的格式或规则。以下是一些常用的校验器库和框架：

名称	描述
Bean Validation (JSR 303/349/380)	Java平台的标准数据验证API，提供注解驱动的数据验证机制
Hibernate Validator	Bean Validation的参考实现，提供丰富的预定义注解，如@NotNull, @Size等
Spring Validation	Spring框架中的集成Bean Validation的包，提供额外的校验功能
Apache Commons Validator	提供用于验证不同数据格式的工具，如电子邮件、URL、IP地址等
Google Guava	Guava库中的Strings类，用于简单的字符串校验
AssertJ	一个断言库，用于编写更可读的单元测试，也常用于校验方法参数和对象状态
JSR 303/349/380注解	包括@Null, @NotNull, @AssertTrue等，用于标注验证规则
自定义校验器	开发者可以自定义校验注解和校验器类，满足特定的业务需求
Spring Boot Starter Validation	Spring Boot提供的验证启动器，集成了Hibernate Validator，简化配置
Lombok	自动生成Getter、Setter、构造器等，可配合Bean Validation使用，减少样板代码

自定义校验注解

自定义校验注解通常分为如下几步：

1. 配置验证框架： 确保项目中包含了Bean Validation API的相关依赖（pom依赖，有没有校验器的jar）
2. 创建注解，使用@Constraint元注解来声明这是一个约束注解，使用@Target和@Retention元注解来指定注解的作用目标和保留策略。
3. 实现校验器： 创建一个类实现ConstraintValidator接口，这个类将包含实际的校验逻辑。需要重写initialize方法（初始化，基本不咋用到）和isValid方法，isValid方法用于执行具体的校验逻辑。
4. 使用注解：在需要校验的字段或方法上使用自定义注解。

自定义电话号格式校验注解

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

/**
 * 手机号校验注解
 */
@Documented
@Constraint(validatedBy = PhoneNumberValidator.class)
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ValidPhoneNumber {
    String message() default "手机号格式不正确";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

// 实现校验逻辑的类
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class PhoneNumberValidator implements ConstraintValidator<ValidPhoneNumber, String> {
    @Override
    public void initialize(ValidPhoneNumber constraintAnnotation) {
        // 初始化方法，可以在这里进行一些初始化工作，但通常不需要实现
    }

    @Override
    public boolean isValid(String phoneNumber, ConstraintValidatorContext context) {
        // 正则表达式，用于校验手机号格式
        String regex = "^1[3-9]\\d{9}$";
        return phoneNumber.matches(regex);
    }
}

使用方式：

public class User {
    @ValidPhoneNumber(message = "请输入正确的手机号")
    private String phone;

    // ...
}

自定义身份证号格式校验注解

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

@Documented
@Constraint(validatedBy = IDCardValidator.class)
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ValidIDCard {

    String message() default "身份证号码格式不正确";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class IDCardValidator implements ConstraintValidator<ValidIDCard, String> {

    private static final int ID_CARD_LENGTH_18 = 18;
    private static final String ID_CARD_REGEX_18 = "^[1-9]\\d{5}(18|19|20)\\d{2}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])\\d{3}([0-9]|X)$";
    private static final char[] VERIFY_CODE = {'1', '0', 'X', '9', '8', '7', '6', '5', '4', '3', '2'};
    private static final int[] WEIGHTS = {7, 9, 10, 5, 8, 4, 2, 1, 6, 3, 7, 9, 10, 5, 8, 4, 2};

    @Override
    public void initialize(ValidIDCard constraintAnnotation) {}

    @Override
    public boolean isValid(String idCard, ConstraintValidatorContext context) {
        if (idCard == null || idCard.length() != ID_CARD_LENGTH_18) {
            return false;
        }
        if (!idCard.matches(ID_CARD_REGEX_18)) {
            return false;
        }
        // 验证18位身份证的校验码
        return validate18(idCard);
    }

    private boolean validate18(String idCard) {
        int sum = 0;
        for (int i = 0; i < 17; i++) {
            sum += Character.getNumericValue(idCard.charAt(i)) * WEIGHTS[i];
        }
        int mod = sum % 11;
        char checkCode = VERIFY_CODE[mod];
        return Character.toUpperCase(idCard.charAt(17)) == checkCode;
    }
}

使用方式：

import javax.validation.constraints.NotNull;
import javax.validation.Valid;

public class Person {
    @NotNull(message = "姓名不能为空")
    private String name;

    @ValidIDCard(message = "身份证号码格式不正确")
    private String idCard;

    // ...
}

---