hibernate-validator改進(jìn)校驗框架validator?v0.4怎么使用

這篇文章主要講解了“hibernate-validator改進(jìn)校驗框架validator v0.4怎么使用”，文中的講解內(nèi)容簡單清晰，易于學(xué)習(xí)與理解，下面請大家跟著小編的思路慢慢深入，一起來研究和學(xué)習(xí)“hibernate-validator改進(jìn)校驗框架validator v0.4怎么使用”吧！

項目介紹

java 開發(fā)中，參數(shù)校驗是非常常見的需求。但是 hibernate-validator 在使用過程中，依然會存在一些問題。

validator 在 hibernate-validator 等校驗工具之上，做了一些改進(jìn)，使其使用更加便捷優(yōu)雅，進(jìn)一步提升工作效率。

變更日志

特性

支持 fluent-validation

支持 jsr-303 注解

支持 i18n

支持用戶自定義策略

支持用戶自定義注解

支持針對屬性的校驗

支持過程式編程與注解式編程

支持指定校驗生效的條件

創(chuàng)作目的

hibernate-validator 無法滿足的場景

如今 java 最流行的 hibernate-validator 框架，但是有些場景是無法滿足的。

比如：

• 驗證新密碼和確認(rèn)密碼是否相同。(同一對象下的不同屬性之間關(guān)系)

• 當(dāng)一個屬性值滿足某個條件時，才進(jìn)行其他值的參數(shù)校驗。

• 多個屬性值，至少有一個不能為 null

其實，在對于多個字段的關(guān)聯(lián)關(guān)系處理時，hibernate-validator 就會比較弱。

本項目結(jié)合原有的優(yōu)點，進(jìn)行這一點的功能強化。

validation-api 過于復(fù)雜

validation-api 提供了豐富的特性定義，也同時帶來了一個問題。

實現(xiàn)起來，特別復(fù)雜。

然而我們實際使用中，常常不需要這么復(fù)雜的實現(xiàn)。

validator-api 提供了一套簡化很多的 api，便于用戶自行實現(xiàn)。

自定義缺乏靈活性

hibernate-validator 在使用中，自定義約束實現(xiàn)是基于注解的，針對單個屬性校驗不夠靈活。

本項目中，將屬性校驗約束和注解約束區(qū)分開，便于復(fù)用和拓展。

過程式編程 vs 注解式編程

hibernate-validator 核心支持的是注解式編程，基于 bean 的校驗。

一個問題是針對屬性校驗不靈活，有時候針對 bean 的校驗，還是要自己寫判斷。

本項目支持 fluent-api 進(jìn)行過程式編程，同時支持注解式編程。

盡可能兼顧靈活性與便利性。

快速開始

準(zhǔn)備工作

JDK1.7+

Maven 3.X+

maven 引入

<dependency>
    <groupId>com.github.houbb</groupId>
    <artifactId>validator-core</artifactId>
    <version>0.4.0</version>
</dependency>

快速入門

定義對象

第一步，我們定義一個常見的 java bean 對象，可以指定內(nèi)置的注解。

支持 jsr-303 注解和 hibernate-validator 的注解。

public class User {
    /**
     * 名稱
     */
    @HasNotNull({"nickName"})
    private String name;
    /**
     * 昵稱
     */
    private String nickName;
    /**
     * 原始密碼
     */
    @AllEquals("password2")
    private String password;
    /**
     * 新密碼
     */
    private String password2;
    /**
     * 性別
     */
    @Ranges({"boy", "girl"})
    private String sex;
    /**
     * 失敗類型枚舉
     */
    @EnumRanges(FailTypeEnum.class)
    private String failType;
    //getter & setter
}

ValidHelper 工具方法

ValidHelper 作為統(tǒng)一封裝的工具類，提供了 java bean 校驗常見的方法。

方法列表：

使用起來很簡單，我們以 failFast 為例：

// 對象定義
User user = new User();
user.sex("what").password("old").password2("new");
// 調(diào)用方法
IResult result = ValidHelper.failFast(user);

結(jié)果：

DefaultResult{pass=false, notPassList=[DefaultConstraintResult{pass=false, message='name: 值 <null> 不是預(yù)期值', value=null, constraint='HasNotNullConstraint', expectValue='', fieldName='name'}], allList=null}

• IResult 方法說明

返回值實現(xiàn)默認(rèn)為 DefaultResult，接口 IResult 屬性如下：

public interface IResult {
    /**
     * 是否全部通過驗證
     * @return 是否
     * @since 0.1.0
     */
    boolean pass();
    /**
     * 未通過的列表信息
     * @return 驗證結(jié)果
     * @since 0.1.0
     */
    List<IConstraintResult> notPassList();
    /**
     * 所有的驗證結(jié)果列表
     * @return 所有的驗證結(jié)果
     * @since 0.1.0
     */
    List<IConstraintResult> allList();
    /**
     * 輸出信息到控臺
     * （1）主要是為了方便調(diào)整
     * （2）該功能其實可以做增強，比如輸出到文件/數(shù)據(jù)庫等等。
     * @return this
     * @since 0.0.6
     */
    IResult print();
    /**
     * 對于未通過的信息，
     * （1）未通過的界定。
     *  {@link IConstraintResult#pass()} 為 false
     *
     * （2）內(nèi)容信息
     * 拋出運行時異常 {@link com.github.houbb.validator.api.exception.ValidRuntimeException}，異常信息為 {@link IConstraintResult#message()} 消息
     * （3）內(nèi)容限定
     *  為了避免異常內(nèi)容過多，只拋出第一條即可。
     *  （4）改方法的增強空間
     *  4.1 可以指定什么情況下拋出異常
     *  4.2 拋出異常的信息和類別
     *
     * @return this
     * @since 0.0.6
     */
    IResult throwsEx();
}

注解說明

java bean 的校驗，基于注解是比較方便的。和 hibernate-validator 使用類似，這里介紹下常見的注解。

內(nèi)置約束注解

內(nèi)置注解如下：

JSR-303 + hibernate-validator 約束注解支持

條件注解

說明

有時候我們需要根據(jù)不同的參數(shù)，進(jìn)行不同的限制條件。

比如新建時用戶 id 不需要傳入，但是修改時 id 必填。

如果是傳統(tǒng)的 hibernate-validator 處理就會比較麻煩，此處引入條件注解。

內(nèi)置注解

使用

使用起來也不難，下面的效果如下：

• operType == 'create' 時，name 的校驗才會生效。

• operType != 'create' 時，id 的校驗才會生效。

其他使用方式保持不變。

public class ConditionUser {
    /**
     * 操作類型
     */
    @Ranges({"create", "edit"})
    private String operType;
    /**
     * 新建時，name 必填
     */
    @EqualsCondition(value = "create", fieldName = "operType")
    @Size(min = 3)
    @NotNull
    private String name;
    /**
     * 不是新建時, id 字段必填
     */
    @NotEqualsCondition(value = "create", fieldName = "operType")
    @Size(min = 16)
    private String id;
    //getter & setter
}

過程式接口

說明

日常開發(fā)中，我們都很喜歡使用注解對 java bean 進(jìn)行校驗。

但是這回導(dǎo)致我們定義的單個屬性校驗無法復(fù)用。

所以項目中的單個屬性校驗和注解是一一對應(yīng)的，為了便于復(fù)用。

ValidHelper 方法

ValidHelper 作為統(tǒng)一封裝的工具類，提供單個方法校驗常見的方法。

和 java bean 類似，方法列表：

使用例子

用法和 bean 的類似，只是入?yún)⒍嗔说诙€約束條件。

IResult result = ValidHelper.failFast("", Constraints.notEmptyConstraint());

IConstraint 對應(yīng)關(guān)系

注解和常見的接口方法一一對應(yīng)，所有的約束方法在 Constraints 工具類中。

條件注解

注解和常見的接口方法一一對應(yīng)，所有的約束方法在 Conditions 工具類中。

注解自定義

說明

內(nèi)置的注解，自然無法滿足所有的場景。

本項目中，約束和條件注解都是支持自定義的。

約束注解 @Constraint

所有系統(tǒng)的內(nèi)置注解都可以作為學(xué)習(xí)的例子。

定義注解

以 @AllEquals 為例，核心的部分在 @Constraint(AtAllEqualsConstraint.class)。

我們在 AtAllEqualsConstraint 中實現(xiàn)具體的約束邏輯。

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Constraint(AtAllEqualsConstraint.class)
public @interface AllEquals {
    /**
     * 當(dāng)前字段及其指定的字段 全部相等
     * 1. 字段類型及其他字段相同
     * @return 指定的字段列表
     */
    String[] value();
    /**
     * 提示消息
     * @return 錯誤提示
     */
    String message() default "";
    /**
     * 分組信息
     * @return 分組類
     * @since 0.1.2
     */
    Class[] group() default {};
}

實現(xiàn)邏輯

推薦直接繼承 AbstractAnnotationConstraint<A>，實現(xiàn)對應(yīng)的邏輯即可。

public class AtAllEqualsConstraint extends AbstractAnnotationConstraint<AllEquals> {
    @Override
    protected IConstraint buildConstraint(AllEquals annotation) {
        return Constraints.allEqualsConstraint(annotation.value());
    }
}

條件注解 @Condition

所有系統(tǒng)的內(nèi)置注解都可以作為學(xué)習(xí)的例子。

定義注解

以 @AlwaysTrueCondition 為例，核心的部分在 @Condition(AtAlwaysTrueCondition.class)。

我們在 AtAlwaysTrueCondition 中實現(xiàn)具體的約束邏輯。

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Condition(AtAlwaysTrueCondition.class)
public @interface AlwaysTrueCondition {
}

實現(xiàn)邏輯

推薦直接繼承 AbstractAnnotationCondition<A>，實現(xiàn)對應(yīng)的邏輯即可。

public class AtAlwaysTrueCondition extends AbstractAnnotationCondition<AlwaysTrueCondition> {
    @Override
    protected ICondition buildCondition(AlwaysTrueCondition annotation) {
        return Conditions.alwaysTrueCondition();
    }
}

感謝各位的閱讀，以上就是“hibernate-validator改進(jìn)校驗框架validator v0.4怎么使用”的內(nèi)容了，經(jīng)過本文的學(xué)習(xí)后，相信大家對hibernate-validator改進(jìn)校驗框架validator v0.4怎么使用這一問題有了更深刻的體會，具體使用情況還需要大家實踐驗證。這里是億速云，小編將為大家推送更多相關(guān)知識點的文章，歡迎關(guān)注！