ConstraintValidator 使用过程及心得

一、方法介绍

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.总结

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,230评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,261评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,089评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,542评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,542评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,544评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,922评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,578评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,816评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,576评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,658评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,359评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,937评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,920评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,859评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,381评论 2 342