java自定义注解验证手机格式的实现示例

/**
 * 手机号验证正则
 */
@Target({ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {PhoneValidator.class})// 指定约束处理器，也就是手机号格式验证是哪个类来做校验
public @interface Phone {

  String pattern() default "^(?:(?:\\+|00)86)?1\\d{10}$";

  String message() default "手机号格式非法";

  Class<?>[] groups() default { }; // groups用来指定分组，可以让校验采取不同的机制，当前默认未指定任何分组机制，默认每次都要进行校验

  Class<? extends Payload>[] payload() default { };
  
  // 默认分组
  interface Default{

  }

  // 分组A
  interface A{

  }
}

/**
 * 校验处理器：做手机号码格式验证的核心类
 */
public class PhoneValidator implements ConstraintValidator<Phone, String> {

  // 注解对象
  private Phone phone;

  // 初始化【Phone】对象
  @Override
  public void initialize(Phone constraintAnnotation) {
    phone = constraintAnnotation;
  }

  @Override
  public boolean isValid(String value, ConstraintValidatorContext context) {
    // 获取【Phone】对象的手机格式验证表达式
    String pattern = phone.pattern();
    Pattern compile = Pattern.compile(pattern);
    Matcher matcher = compile.matcher(value);
    return matcher.matches();
  }

@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
public class Person implements Serializable {
  
  @Phone
  private String phone;
}

@RestController
@RequestMapping("/admin/")
public class PersonController {

  @Autowired
  private PersonService personService;

  @PostMapping("/query")
  public Person query(@RequestBody @Validated Person params) {
    return JsonResult.success(personService.queryByPhone(params));
  }
}

@Target({ElementType.TYPE, ElementType.METHOD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Validated {

 /**
 * Specify one or more validation groups to apply to the validation step
 * kicked off by this annotation.
 * <p>JSR-303 defines validation groups as custom annotations which an application declares
 * for the sole purpose of using them as type-safe group arguments, as implemented in
 * {@link org.springframework.validation.beanvalidation.SpringValidatorAdapter}.
 * <p>Other {@link org.springframework.validation.SmartValidator} implementations may
 * support class arguments in other ways as well.
 */
 Class<?>[] value() default {};

}

@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
public class Person implements Serializable {
  
  // 指定groups属性
  @Phone(groups = {Phone.A.class})
  private String phone;

}

@RestController
@RequestMapping("/admin/")
public class PersonController {

  @Autowired
  private PersonService personService;

  @PostMapping("/query")
  public Person query(@RequestBody @Validated(Phone.A.class) Person params) {
    return JsonResult.success(personService.queryByPhone(params));
  }
}