ConstraintValidator 实现自定义注解

在工作中有时需要实现校验,错误信息自定义,这时自定义注解就起作用了 

1、首先需要创建一个注解类:
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(
        validatedBy = {IsMobileValidator.class}
)
public @interface IsMobile {
 
    boolean required() default true;
 
    String message() default "手机格式不正确";      自定义错误消息的内容
 
    Class<?>[] groups() default {};
 
    Class<? extends Payload>[] payload() default {};
    
}

2、验证,需要实现ConstraintValidator<IsMobile ,String>接口, 其中IsMobile 为注解,String为需要验证的类型

public class IsMobileValidator implements ConstraintValidator<IsMobile,String> {
 
    private boolean require = false;
 
    @Override
    public void initialize(IsMobile constraintAnnotation) {                             //初始化
        require = constraintAnnotation.required();
    }
 
    @Override
    public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {
        if(require){
            return ValidatorUtils.isMobile(s);
        }else {
           if (StringUtils.isEmpty(s)) {
               return true;
           }else {
               return ValidatorUtils.isMobile(s);
           }
        }
    }
}

3、校验工具类

public class ValidatorUtils {
 
    private static final Pattern mobile_pattern = Pattern.compile("1\\d{10}");
 
    public static boolean isMobile(String src) {
        if (StringUtils.isEmpty(src)) {
            return false;
        }
        Matcher m = mobile_pattern.matcher(src);
        return m.matches();
    }
}
 

校验类需要实现ConstraintValidator接口。
接口使用了泛型,需要指定两个参数,第一个自定义注解类,第二个为需要校验的数据类型。
实现接口后要override两个方法,分别为initialize方法和isValid方法。其中initialize为初始化方法,可以在里面做一些初始化操作,isValid方法就是我们最终需要的校验方法了。可以在该方法中实现具体的校验步骤。本示例中进行了简单的手机号校验。
 


版权声明:本文为wangc_gogo原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。