摘要：可能有人認為數據校驗模塊并不是那么的重要，因為硬編碼都可以做。我以數據綁定為引子引出了數據校驗這一塊，是想表明它的重要性。關于數據校驗這塊，最新的是，也就是我們常說的。

吾皇一日不退役，爾等都是臣子

前幾篇文章在講Spring的數據綁定的時候，多次提到過數據校驗。可能有人認為數據校驗模塊并不是那么的重要，因為硬編碼都可以做。若是這么想的話，那就大錯特錯了~
前面講解DataBinder的時候一個小細節，它所在的包是：org.springframework.validation，并且在分析源碼的時候能看到DataBinder它不僅能夠完成數據綁定，也提供了對數據校驗的支持且還保存了校驗結果。

我以數據綁定DataBinder為引子引出了數據校驗這一塊，是想表明它的重要性。連Java都把它抽象成了JSR標準進行提出，so我認為這塊是必修課，有必要了解本章的內容。

數據校驗 是非常常見的工作，在日常的開發中貫穿于代碼的各個層次，從上層的View層到底層的數據層。

在此處有必要再強調一句：前面說了數據綁定并不屬于Spring MVC的專利，同樣的數據校驗也不是只會發生在web層，它可以在任意一層，從后面的示例中你會有更深的理解

在任何時候，當你要處理一個應用程序的業務邏輯，數據校驗是你必須要考慮和面對的事情。應用程序必須通過某種手段來確保輸入進來的數據從語義上來講是正確的（比如生日必須是過去時，年齡必須>0等等~）。

我們知道通常情況下程序肯定是分層的，不同的層一般由不同的人來開發。若你是一個有經驗的程序員， 我相信你肯定見過在不同的層了都出現了相同的校驗代碼，這就是某種意義上的垃圾代碼。

public String queryValueByKey(String parmTemplateCode, String conditionName, String conditionKey, String resultName) {
    checkNotNull(parmTemplateCode, "parmTemplateCode not null");
    checkNotNull(conditionName, "conditionName not null");
    checkNotNull(conditionKey, "conditionKey not null");
    checkNotNull(resultName, "resultName not null");
    ...
}

從這個簡單的方法入參校驗至少能發現如下問題：

需要寫大量的代碼來進行參數驗證。(這種代碼多了就算垃圾代碼)

需要通過注釋來知道每個入參的約束是什么（否則別人咋看得懂）

每個程序員做參數驗證的方式不一樣，參數驗證不通過拋出的異常也不一樣（后期幾乎沒法維護）

如上會導致代碼冗余和一些管理的問題（代碼量越大，管理起來維護起來就越困難），比如說語義的一致性等。為了避免這樣的情況發生，最好是將驗證邏輯與相應的域模型（領域模型的概念）進行綁定，這就是本文提供的一個新思路（其實是JavaEE提供的思路）

為了解決這個問題，Bean Validation 為 JavaBean 驗證定義了相應的元數據模型和 API。默認的元數據是 各種Java Annotations，當然也支持xml方式并且你也可以擴展~
可以說Bean Validation是JavaBean的一個拓展，它可以布局于任意一層代碼，不局限于Web應用還是端應用。

JSR是Java Specification Requests的縮寫，意思是Java 規范提案。關于數據校驗這塊，最新的是JSR380，也就是我們常說的Bean Validation 2.0。

Bean Validation 2.0 是JSR第380號標準。該標準連接如下：https://www.jcp.org/en/egc/vi...
Bean Validation的主頁：http://beanvalidation.org
Bean Validation的參考實現：https://github.com/hibernate/...

Bean Validation是一個通過配置注解來驗證參數的框架，它包含兩部分Bean Validation API（規范）和Hibernate Validator（實現）。
Bean Validation是Java定義的一套基于注解/xml的數據校驗規范，目前已經從JSR 303的1.0版本升級到JSR 349的1.1版本，再到JSR 380的2.0版本（2.0完成于2017.08），已經經歷了三個版本（我截圖如下：）

現在絕大多數coder使用者其實都還在使用Bean Validation 1.1，畢竟一般來說它已經夠用了~
本文會介紹Bean Validation 2.0提供的一些實用的新東西，畢竟Java8現在已成為主流，完全可以使用了~

要想使用它，首先就得導包嘛~根據經驗，和JCache類似Java只提供了規范，并沒有提供實現，所以我們可以先找到它的API包然后導入：

    javax.validation
    validation-api
    
    2.0.1.Final

關于版本之間的差異其實不是本文說明的重點，畢竟2.0做到了很好的向下兼容，使用起來是無縫的。
但是本處還是給個1.1版本和2.0.1的截圖，感官上簡單對比一下區別：

因為2.0推出的時間確實不算長，so此處我把一些重要的關注點列舉如下：

對Java的最低版本要求是Java 8

支持容器的校驗，通過TYPE_USE類型的注解實現對容器內容的約束：List<@Email String>

支持日期/時間的校驗，@Past和@Future

拓展元數據（新增注解）：@Email，@NotEmpty，@NotBlank，@Positive， @PositiveOrZero，@Negative，@NegativeOrZero，@PastOrPresent和@FutureOrPresent

    1. 像`@Email、@NotEmpty、@NotBlank`之前是Hibernate額外提供的，2.0標準后hibernate自動退位讓賢并且標注為過期了

Bean Validation 2.0的唯一實現為Hibernate Validator。（其實還有Apache BVal，但是你懂的，forget it）

對于Hibernate Validator，它自己也擴展了一些注解支持。

    1. **6.0以上**版本新增(對應標準2.0版本)：`@UniqueElements、@ISBN、@CodePointLength`
    2. **6.0以下**版本可以使用的： `@URL、@ScriptAssert、@SafeHtml、@Range、@ParameterScriptAssert、@Mod11Check、@Mod10Check、@LuhnCheck、@Length、@EAN、@Currency、@CreditCardNumber、@ConstraintComposition、`
    3. `Hibernate Validator`默認會校驗完所有的屬性，然后**返回所有的**驗證`失敗信息`。開啟fail fast mode后，只要有一個驗證失敗，則返回驗證失敗信息。

so，對于Java Bean Validation的實現落地產品就沒啥好選的，導入Hibernate Validator(最新版本)吧：

    org.hibernate.validator
    hibernate-validator
    6.0.17.Final

==小細節：==

可以看到，導入了hibernate-validator就必要再自己導入Java Bean ValidationAPI了，因此建議不用再手動導入API，交給內部來管理依賴。

定義一個待校驗的普通JavaBean：

@Getter
@Setter
@ToString
public class Person {

    // 錯誤消息message是可以自定義的
    @NotNull(message = "名字不能為null")
    public String name;
    @Positive
    public Integer age;

    @NotNull
    @NotEmpty
    private List<@Email String> emails;
    @Future
    private Date start;

}

書寫測試用例：

    public static void main(String[] args) {
        Person person = new Person();
        //person.setName("fsx");
        person.setAge(-1);
        // email校驗：雖然是List都可以校驗哦
        person.setEmails(Arrays.asList("fsx@gmail.com", "baidu@baidu.com", "aaa.com"));
        //person.setStart(new Date()); //start 需要是一個將來的時間: Sun Jul 21 10:45:03 CST 2019
        //person.setStart(new Date(System.currentTimeMillis() + 10000)); //校驗通過

        // 對person進行校驗然后拿到結果（顯然使用時默認的校驗器）   會保留下校驗失敗的消息
        Set> result = Validation.buildDefaultValidatorFactory().getValidator().validate(person);
        // 對結果進行遍歷輸出
        result.stream().map(v -> v.getPropertyPath() + " " + v.getMessage() + ": " + v.getInvalidValue())
                .forEach(System.out::println);
    }

運行，報錯啦：

Caused by: java.lang.ClassNotFoundException: javax.el.ELManager
    at java.net.URLClassLoader.findClass(URLClassLoader.java:382)
...

可以看到運行必須依賴于javax.el這個包。（其實我是比較費解的，為何校驗框架非得依賴它呢？有小伙伴可以幫忙解釋一下嗎？）

那行，導入依賴javax.el以及它的實現：

    javax.el
    javax.el-api
    3.0.1-b06



    org.glassfish.web
    javax.el
    2.2.6

需要注意的是，網上大都建議導入org.glassfish.web包。但是EL3.0后它并沒有再提供支持了，因此我個人是不建議使用它，而是使用下面tomcat的實現的~

關于EL的實現此處啰嗦一句：JavaEE并沒有提供el的實現，需要容器自行提供，比如上面你想要導入最為流行的tomcat，你可以導入如下jar即可：

    org.apache.tomcat.embed
    tomcat-embed-el
    9.0.22



    org.apache.tomcat
    tomcat-jasper-el
    9.0.22
    provided

此處還需要說明一點的是：嵌入式tomcat（比如SpringBoot環境）若要使用時需要顯示導入的。但是傳統tomcat中你若要使用是不用自己導入的（tomcat自帶此jar）。

但是，但是，但是自從tomcat8.5后不再自帶jsper-el的包了，需要手動導入。（tomcat7還是有的~）

==最佳實踐：==
一般來說，javax.el-api以及validation-api都是沒有必要多帶帶導入的，第三方包都會自帶。所以絕大數情況下，我們只需要這么導入即可正常work，形如下面這樣非常趕緊整潔：

    org.hibernate.validator
    hibernate-validator
    6.0.17.Final


    org.apache.tomcat.embed
    tomcat-embed-el
    9.0.22

此處可能有伙伴會問：為何自己在使用的時候從來都沒有導入過EL相關Jar包，也能正常數據校驗呢？

答：那是因為絕大多數情況下你使用@Valid是使用在Spring MVC上，它是不依賴于EL方式的，下篇文章會詳細說明關于數據校驗在Spring上的使用。而本文主要還是講解API的方式~

經過一番導包后，再次運行打印如下（方式一、方式二結果一致）：

name名字不能為null: null //  此處錯誤消息是自己的自定義內容
age必須是正數: -1
emails[2].不是一個合法的電子郵件地址: aaa.com

這樣通過API調用的方式就完成了對這個JavaBean的屬性校驗~

官方給它的定義為：This class is the entry point for Bean Validation.它作為校驗的入口，有三種方式來啟動它：

最簡單方式：使用默認的ValidatorFactory factory = Validation.buildDefaultValidatorFactory(); 雖然是默認的單也會有如下2種情況：

    1. 若使用了xml配置了一個provider，那就會使用這個provider來提供Factory 
    2. 若沒有xml或者xml力沒有配置provider，那就是用默認的`ValidationProviderResolver`實現類來處理

方式二：選擇自定義的ValidationProviderResolver來跟XML配置邏輯選出一個ValidationProvider來。大致代碼如下：

Configuration configuration = Validation.byDefaultProvider()
        .providerResolver(new MyResolverStrategy()) // 自定義一個ValidationProviderResolver的實現類
        .configure();
ValidatorFactory factory = configuration.buildValidatorFactory();

第三種方式就更加自由了：你可以直接提供一個類型安全的ValidationProvider實現。比如HibernateValidator就是一個ValidationProvider的實現：

HibernateValidatorConfiguration configuration = Validation.byProvider(HibernateValidator.class)
        // .providerResolver( ... ) // 因為制定了Provider，這個參數就可選了
        .configure()
        .failFast(false);
ValidatorFactory validatorFactory = configuration.buildValidatorFactory();

這三種初始化方式，在源碼處就是對應提供的三個public static方法：

public class Validation {

    // 方式一
    public static ValidatorFactory buildDefaultValidatorFactory() {
        return byDefaultProvider().configure().buildValidatorFactory();
    }
    // 方式二
    public static GenericBootstrap byDefaultProvider() {
        return new GenericBootstrapImpl();
    }
    // 方式三
    public static , U extends ValidationProvider> ProviderSpecificBootstrap byProvider(Class providerType) {
        return new ProviderSpecificBootstrapImpl<>( providerType );
    }
    ...
}

public interface Configuration> {
    // 該方法調用后就不會再去找META-INF/validation.xml了
    T ignoreXmlConfiguration();
    // 消息內插器  它是個狠角色，關于它的使用場景，后續會有詳解（包括Spring都實現了它來做事）
    // 它的作用是：插入給定的約束沖突消息
    T messageInterpolator(MessageInterpolator interpolator);
    // 確定bean驗證提供程序是否可以訪問屬性的協定。對每個正在驗證或級聯的屬性調用此約定。（Spring木有實現它）
    // 對每個正在驗證或級聯的屬性都會調用此約定
    // Traversable： 可移動的
    T traversableResolver(TraversableResolver resolver);
    // 創建ConstraintValidator的工廠
    // ConstraintValidator：定義邏輯以驗證給定對象類型T的給定約束A。(A是個注解類型)
    T constraintValidatorFactory(ConstraintValidatorFactory constraintValidatorFactory);
    // ParameterNameProvider：提供Constructor/Method的方法名們
    T parameterNameProvider(ParameterNameProvider parameterNameProvider);
    // java.time.Clock 用作判定@Future和@Past（默認取值當前時間）
    // 若你希望他是個邏輯實現，提供一個它即可
    // @since 2.0
    T clockProvider(ClockProvider clockProvider);
    // 值提取器。這是add哦~ 負責從Optional、List等這種容器里提取值~
    // @since 2.0
    T addValueExtractor(ValueExtractor extractor);
    // 加載xml文件
    T addMapping(InputStream stream);
    // 添加特定的屬性給Provider用的。此屬性等效于XML配置屬性。
    // 此方法通常是框架自己分析xml文件得到屬性值然后放進去，調用者一般不使用（當然也可以用）
    T addProperty(String name, String value);
    
    // 下面都是get方法嘍
    MessageInterpolator getDefaultMessageInterpolator();
    TraversableResolver getDefaultTraversableResolver();
    ConstraintValidatorFactory getDefaultConstraintValidatorFactory();
    ParameterNameProvider getDefaultParameterNameProvider();
    ClockProvider getDefaultClockProvider();
    BootstrapConfiguration getBootstrapConfiguration(); // 整個配置也可返回出去

    // 上面都是工作，這個方法才是最終需要調用的：得到一個ValidatorFactory
    ValidatorFactory buildValidatorFactory();
}

public interface HibernateValidatorConfiguration extends Configuration {

    // 這批屬性，證明直接可以通過System屬性值來控制，大大地方便~
    // 這個機制快速失敗機制：true檢查完一個有錯誤就返回，false全部檢查完把錯誤消息一起返回   默認false
    String FAIL_FAST = "hibernate.validator.fail_fast"; 
    String ALLOW_PARAMETER_CONSTRAINT_OVERRIDE = "hibernate.validator.allow_parameter_constraint_override";
    String ALLOW_MULTIPLE_CASCADED_VALIDATION_ON_RESULT = "hibernate.validator.allow_multiple_cascaded_validation_on_result";
    String ALLOW_PARALLEL_METHODS_DEFINE_PARAMETER_CONSTRAINTS = "hibernate.validator.allow_parallel_method_parameter_constraint";
    // @since 5.2
    @Deprecated
    String CONSTRAINT_MAPPING_CONTRIBUTOR = "hibernate.validator.constraint_mapping_contributor";
    // @since 5.3
    String CONSTRAINT_MAPPING_CONTRIBUTORS = "hibernate.validator.constraint_mapping_contributors";
    // @since 6.0.3
    String ENABLE_TRAVERSABLE_RESOLVER_RESULT_CACHE = "hibernate.validator.enable_traversable_resolver_result_cache";
    // @since 6.0.3  ScriptEvaluatorFactory：執行腳本
    @Incubating
    String SCRIPT_EVALUATOR_FACTORY_CLASSNAME = "hibernate.validator.script_evaluator_factory";
    // @since 6.0.5 comparing date/time in temporal constraints. In milliseconds.
    @Incubating
    String TEMPORAL_VALIDATION_TOLERANCE = "hibernate.validator.temporal_validation_tolerance";

    // ResourceBundleMessageInterpolator用于 load resource bundles
    ResourceBundleLocator getDefaultResourceBundleLocator();
    // 創建一個ConstraintMapping：通過編程API配置的約束映射
    // 設置映射后，必須通過addMapping（constraintmapping）將其添加到此配置中。
    ConstraintMapping createConstraintMapping();
    // 拿到所有的值提取器  @since 6.0
    @Incubating
    Set> getDefaultValueExtractors();

    // 往下就開始配置了~~~~~~~~~~
    HibernateValidatorConfiguration addMapping(ConstraintMapping mapping);
    HibernateValidatorConfiguration failFast(boolean failFast);
    // used for loading user-provided resources:
    HibernateValidatorConfiguration externalClassLoader(ClassLoader externalClassLoader);
    // true：表示允許覆蓋約束的方法。false表示不予許（拋出異常）  默認值是false
    HibernateValidatorConfiguration allowOverridingMethodAlterParameterConstraint(boolean allow);
    // 定義是否允許對返回值標記多個約束以進行級聯驗證。  默認是false
    HibernateValidatorConfiguration allowMultipleCascadedValidationOnReturnValues(boolean allow);
    // 定義約束的**并行方法**是否應引發ConstraintDefinitionException
    HibernateValidatorConfiguration allowParallelMethodsDefineParameterConstraints(boolean allow);
    // 是否允許緩存TraversableResolver  默認值是true
    HibernateValidatorConfiguration enableTraversableResolverResultCache(boolean enabled);
    // 設置一個腳本執行器
    @Incubating
    HibernateValidatorConfiguration scriptEvaluatorFactory(ScriptEvaluatorFactory scriptEvaluatorFactory);
    // 允許在時間約束中比較日期/時間時設置可接受的誤差范圍
    // 比如@Past @PastOrPresent @Future @FutureOrPresent
    @Incubating
    HibernateValidatorConfiguration temporalValidationTolerance(Duration temporalValidationTolerance);
    // 允許設置將傳遞給約束驗證器的有效負載。如果多次調用該方法，則只傳播最后傳遞的有效負載。
    @Incubating
    HibernateValidatorConfiguration constraintValidatorPayload(Object constraintValidatorPayload);
}

若文章格式混亂，可點擊：原文鏈接-原文鏈接-原文鏈接-原文鏈接-原文鏈接