美文网首页Springboot
ConstraintValidator 使用过程及心得

ConstraintValidator 使用过程及心得

作者: Gino_4bd4 | 来源:发表于2021-09-07 19:51 被阅读0次

一、方法介绍

1.initialize方法

会在校验实例化后被调用,一般用于做些初始化工作。

    private String format;
    private String max;
    private String min;

    @Override
    public void initialize(PhcDataStandard phcDataStandard) {
        if (StringUtils.isNotBlank(phcDataStandard.format())) {
            this.format = phcDataStandard.format();
        } else {
            assert StringUtils.isNotBlank(phcDataStandard.value());
            this.format = phcDataStandard.value();
        }
        if (StringUtils.isNotBlank(phcDataStandard.max())) {
            this.max = phcDataStandard.max();
        }
        if (StringUtils.isNotBlank(phcDataStandard.max())) {
            this.min = phcDataStandard.min();
        }
        StandardUtil.validateDoubleFormatStr(this.format);
    }

2.isValid方法

实际执行验证的方法,第一个参数获取的是字段或对象实际对应的值,取决于类的枚举限定类型。第二个参数是ConstraintValidatorContext,上下文可以做些默认的设置。

class StandardDoubleValidator implements ConstraintValidator<PhcDataStandard, Double>
    @Override
    public boolean isValid(Double d, ConstraintValidatorContext constraintValidatorContext) {
        if (d == null) {
            return true;
        }
        constraintValidatorContext.disableDefaultConstraintViolation();//禁用默认的message的值
        //重新添加错误提示语句
        String extMax = this.max == null ? "" : "最大值(%s) ";
        String extMin = this.min == null ? "" : "最小值(%s) ";
        constraintValidatorContext
                .buildConstraintViolationWithTemplate(String.format("%s 不符合(%s) " + extMin + extMax + "格式要求", d, this.format, this.min, this.max)).addConstraintViolation();
        return StandardUtil.validateDoubleFormat(this.format, this.max, this.min, d);
    }

二、ElementType.TYPE使用心得

1.用于对整个对象进行校验

个人使用场景:多个字段组合校验,ElementType.FIELD无法满足要求。

2.使用实例

@Target({ElementType.TYPE,ElementType.FIELD,ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@ReportAsSingleViolation
@Constraint(validatedBy = {})
public @interface PhcObjDataStandard {

    String message() default "不符合格式规范或值域范围";


    /**
     * 正则表达式验证
     *
     * @return
     */
    String regex() default "";

}

@PhcObjDataStandard
public abstract class BasicDTO  {
    /**
     * 证件类型 CV02.01.101
     */
    @PhcDataStandard(rangeName = "CV02.01.101")
    String certType;
    /**
     * 证件号 AN..100
     */
    @PhcDataStandard("AN..100")
    String certNo;
}
class StandardIDCardValidator implements ConstraintValidator<PhcObjDataStandard, Object>{
@Override
    public void initialize(PhcObjDataStandard phcDataStandard) {
    }

    @Override
    public boolean isValid(Object obj, ConstraintValidatorContext constraintValidatorContext) {
        //禁用默认的message的值
        constraintValidatorContext.disableDefaultConstraintViolation();
        //获取字段值
        Map<String, String> valMap = getFieldValMap(obj);
        //如果前置条件匹配通过,则不必进行身份证验证
        if (preRequirementValid(valMap)) {
            return true;
        }
        //重新添加错误提示语句
        constraintValidatorContext
                .buildConstraintViolationWithTemplate(String.format("%s 不符合(%s)格式要求", valMap.get("certNo"), "身份证")).addPropertyNode("certNo").addConstraintViolation();
        return StandardUtil.validateRegexFormatIDCardStr(valMap.get("certNo"));
    }

    /**
     * 前置条件验证,
     *
     * @param valMap
     * @return
     */
    private boolean preRequirementValid(Map<String, String> valMap) {
        return
                //没有证件号
                StringUtils.isBlank(valMap.get("certNo"))
                        //没有证件类型
                        || StringUtils.isBlank(valMap.get("certType"))
                        //证件类型不是身份证
                        || !StringUtils.equals(valMap.get("certType"), CertTypeEnum.IDENTIFICATION_CARD.getCode());
    }

    /**
     * 获取自定义类型字段
     *
     * @param obj
     * @return
     */
    private Map<String, String> getFieldValMap(Object obj) {
        HashMap<String, String> fieldValMap = Maps.newHashMap();
        Class<?> clz = obj.getClass();
        try {
            PropertyDescriptor certNo = new PropertyDescriptor("certNo", clz);
            PropertyDescriptor certType = new PropertyDescriptor("certType", clz);
            fieldValMap.put("certNo", certNo.getReadMethod().invoke(obj).toString());
            fieldValMap.put("certType", certType.getReadMethod().invoke(obj).toString());
        } catch (IllegalAccessException e) {
        } catch (InvocationTargetException e) {
        } catch (IntrospectionException e) {
        }
        return fieldValMap;
    }
}

三、使用过程中问题总结

1.无法使用FieldError接收错误信息

由于ElementType.TYPE类型作用于整个对象,故而默认情况下,返回的是ObjectError。如果不想接收这个类型,则可以通过ConstraintViolationBuilder.addPropertyNode方法,额外添加字段,返回错误类型即为FieldError。

2.总结

前期设计时最好考虑好后边如何扩展。否则代码会冗余,也会写死很多内容。

相关文章

网友评论

    本文标题:ConstraintValidator 使用过程及心得

    本文链接:https://www.haomeiwen.com/subject/uzppwltx.html