OVAL實(shí)現(xiàn)自定義基于注解的數(shù)據(jù)驗(yàn)證

2i18ns 發(fā)布于2019-08-15 14:20 / 2775人閱讀

摘要：故在介紹一款非常好用的后端驗(yàn)證數(shù)據(jù)有效性的框架已經(jīng)內(nèi)置支持字段非空，數(shù)據(jù)長(zhǎng)度，數(shù)據(jù)范圍，正則匹配等驗(yàn)證，同時(shí)還可以在此框架的基礎(chǔ)上實(shí)現(xiàn)自定義的驗(yàn)證。

介紹

如今開(kāi)發(fā)項(xiàng)目中數(shù)據(jù)的安全驗(yàn)證已經(jīng)是必不可少的一部分，如果只是讓前段做驗(yàn)證，并不能保證整個(gè)系統(tǒng)的安全。故在介紹一款非常好用的后端驗(yàn)證數(shù)據(jù)有效性的框架：oval
oval已經(jīng)內(nèi)置支持字段非空，數(shù)據(jù)長(zhǎng)度，數(shù)據(jù)范圍，正則匹配等驗(yàn)證，同時(shí)還可以在此框架的基礎(chǔ)上實(shí)現(xiàn)自定義的驗(yàn)證。這次我就介紹一下常用的數(shù)據(jù)是否在數(shù)據(jù)庫(kù)重復(fù)的驗(yàn)證。
依賴：

        
            net.sf.oval
            oval
            1.90

簡(jiǎn)單使用

在此我定義一個(gè)User的實(shí)體類，其簡(jiǎn)單的驗(yàn)證代碼如下：

public class User {
    @NotNull(message = "username can not be null",profiles = "username")
    @Length(min = 8,max = 20,message = "username length error.",profiles = "username")
    @MatchPattern(pattern = "(w+)",message = "username have special characters.",profiles = "username")
    private String username;
    private String password;
}

profiles 表示給該字段定義一個(gè)標(biāo)簽，為對(duì)象字段的選擇性驗(yàn)證而存在。

自定義驗(yàn)證注解

上面的列子只是oval自帶的一些驗(yàn)證，當(dāng)然這里也沒(méi)有列舉完全，如果有興趣可以去查詢其api.基本可以滿足大部分項(xiàng)目需求。但如果需要定義一些特殊的驗(yàn)證規(guī)則這需要我們自己實(shí)現(xiàn)一部分代碼。我這里舉一個(gè)數(shù)據(jù)庫(kù)的字段名是否重復(fù)的驗(yàn)證代碼示例。

注解類：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD})
@Constraint(checkWith = UniqueCheck.class)
public @interface Unique {
    ConstraintTarget[] appliesTo() default {ConstraintTarget.VALUES};

    String errorCode() default "unique error";

    String message() default "field duplicate";

    String[] profiles() default {};

    int severity() default 0;

    String target() default "";

    String when() default "";

    String field();

    String tablename();

    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD})
    @Constraints
    public @interface List {
        net.sf.oval.constraint.Length[] value();

        String when() default "";
    }

}

數(shù)據(jù)庫(kù)驗(yàn)重：

public class UniqueCheck extends AbstractAnnotationCheck {

    private String field;
    private String tablename;
    private String message;

    public boolean isSatisfied(Object validatedObject, Object valueToValidate, OValContext context, Validator validator) throws OValException {

        if (validatedObject == null) return true;
        String value = valueToValidate.toString();
        /**
         * 在此處將表名，字段，值做數(shù)據(jù)庫(kù)操作
         *
         * if exist ,return false
         */

        return true;
    }

    @Override
    protected Map createMessageVariables() {
        Map re = Validator.getCollectionFactory().createMap(2);
        re.put("message", this.message);
        return re;
    }

    @Override
    public void configure(Unique unique) {
        super.configure(unique);
        field = unique.field();
        tablename = unique.tablename();
        message = unique.message();
    }
}

至此，你只需要在username上面加上如下注解即可支持字段唯一性驗(yàn)證：

 @Unique(field="username",tablename="tb_user",profiles="username",message="數(shù)據(jù)庫(kù)已存在")

執(zhí)行代碼

public static void main(String[] args) {
        User user = new User("zhangsna");
        MyValidator.validator(person, "username");
    }

    static class MyValidator {
        public static  void validator(T t, String... profiles) {
            Validator v = new Validator();
            List message = v.validate(t, profiles);
            for (ConstraintViolation var : message) {
                System.out.println(var.getMessage());
            }
        }
    }