Springboot集成BeanValidation擴展一：錯誤提示信息加公共模板

Bean Validator擴展

1、需求

​ 在使用validator時，有個需求就是公用錯誤提示信息，什么意思？

舉個例子：

​ @NotEmpty非空判斷，在資源文件中我不想每個非空判斷都寫”不能為空“，只需要寫”###“，然后提示信息自動會變成”###不能為空“

代碼：

public class User{
    //資源文件中user.name.empty=用戶名
    @NotEmpty(key={user.name.empty})
    private String name;
    '''
}

//加入name為空，則最終的錯誤提示為“用戶名不能為空”（會自動加上“不能為空”信息）

2、實現方式

有兩種實現方式

方式一：手動調用驗證方法

注解

@Target({FIELD, ANNOTATION_TYPE})
@Retention(RUNTIME)
@ReportAsSingleViolation
@Constraint(validatedBy = {})
@NotNull
@Size(min = 1)
public @interface NotEmpty {
    
    String message() default "{key}{com.chyjr.hyb.validator.constraints.empty.message}";
​
    Class<?>[] groups() default { };
​
    Class<? extends Payload>[] payload() default { };
    
    String key() default "";
}

驗證器

//驗證器

public class MyValidator {
    
    private static final Logger log = LoggerFactory.getLogger(HybValidator.class);
    
    private static Validator validator = null;
    private static MessageInterpolator msgInterpolator = null;
    
    static {
        if (validator == null) {
            LocalValidatorFactoryBean factory = 
                (LocalValidatorFactoryBean) ApplicationContextUtil.getBean("validator");
            validator = factory.getValidator();
            msgInterpolator = factory.getMessageInterpolator();
        }
    }
​
    public static HybValidatorResult validate(Object object, Class<?>... groups) {
        HybValidatorResult result = new HybValidatorResult();
        Set<ConstraintViolation<Object>> violations = validator.validate(object, groups);
        Map<String, String> map = new HashMap<>();
        if (CollectionUtils.isEmpty(violations)) {
            result.setErrors(false);
        } else {
            result.setErrors(true);
            for (ConstraintViolation<Object> violation : violations) {
                String path = violation.getPropertyPath().toString();
                String message = violation.getMessage();
                if (StringUtils.isBlank(path) || StringUtils.isBlank(message) || map.containsKey(path))
                    continue;
                message = resolveMessage(message);
                map.put(path, message);
            }
            result.setItems(map);
        }
        return result;
    }
    
    private static final Pattern elpattern = Pattern.compile("\\{[^{}]+\\}");
    
    private static String resolveMessage(String message) {
        Matcher matcher = elpattern.matcher(message);
        try {
            while (matcher.find()) {
                String el = matcher.group();
                //用資源文件信息替換message = {key}{my.empty.message}
                //注解這里的key會替換成注解NotEmpty定義的key，即
                //message = {user.name.empty}{my.empty.message}
            String val = msgInterpolator.interpolate(el, null);
            if (StringUtils.isBlank(val))
                continue;
            message = message.replace(el, val);
            }
        } catch (Exception e) {
            log.error("驗證引擎進行數據校驗時出現異常, message:{}", message, e);
        }
        return message;
    }
}

使用

//調用驗證方法獲得驗證結果

 HybValidatorResult bvr = HybValidator.validate(emp, CreateValidator.class);
    //表示有錯誤
    if (bvr.isErrors()) {
    } 
//資源文件內容
//my.empty.message=不能為空
//user.name.empty=用戶名

方式二：用spring自帶的@Validated，無需調用驗證方法

這里有個問題：@Validated注解不認注解@NotEmpty中的key，如何解決呢？

最終的實現方案：自定義驗證器

代碼：

注解

@Documented
@Target({FIELD, ANNOTATION_TYPE})
@Retention(RUNTIME)
@ReportAsSingleViolation
//指定驗證器
@Constraint(validatedBy = NotEmptyValidator.class)
public @interface NotEmpty {
    
    String message() default "{my.empty.message}";
​
    Class<?>[] groups() default { };
​
    Class<? extends Payload>[] payload() default { };
    
    String key() default "";
}

驗證器：自定義

public class NotEmptyValidator extends AbstractValidator<NotEmpty,Object>{
​
    @Override
    public void initialize(NotEmpty notEmpty) {
​
    }
​
    @Override
    public boolean doIsValid(Object value, ConstraintValidatorContext cc) {
       
        return value != null;
    }
}
​
/**
* 這里采用模板的設計模式
* @param constraintAnnotation
*/
public abstract class AbstractValidator<A extends Annotation,T> implements ConstraintValidator<A,T>{
​
    /**
     * 初始化由具體類實現
     * @param constraintAnnotation
     */
    @Override
    public abstract void initialize(A constraintAnnotation);
​
    /**
     * 初始化具體由實現類實現
     * @param value
     * @param context
     * @return
     */
    @Override
    public boolean isValid(T value, ConstraintValidatorContext context){
        //獲取驗證結果,采用模板方法
        boolean result = doIsValid(value,context);
        //當驗證錯誤時修改默認信息
        if(!result){
            //改變默認提示信息
            if(ConstraintValidatorContextImpl.class.isAssignableFrom(context.getClass())){
                ConstraintValidatorContextImpl constraintValidatorContext = 
                    (ConstraintValidatorContextImpl)context;
                //獲取默認提示信息
                String defaultConstraintMessageTemplate = 
                    context.getDefaultConstraintMessageTemplate();
                Object key = 
                constraintValidatorContext.getConstraintDescriptor().getAttributes().get("key");
                //禁用默認提示信息
                context.disableDefaultConstraintViolation();
                //設置提示語（在message前面加上key）
                context.buildConstraintViolationWithTemplate(key +                                          defaultConstraintMessageTemplate).addConstraintViolation();
            }
        }
​
        return result;
    }
     /**
     * 真正驗證方法
     * @param value
     * @param context
     * @return
     */
    public abstract boolean doIsValid(T value, ConstraintValidatorContext context);
}

使用：

調用的時候只要在JavaBean前加上@Validated注解即可

總結：上述就是在工作中遇到的問題，並擴展了Validator