7.4、數(shù)據(jù)驗證

7.4.1、編程式數(shù)據(jù)驗證

Spring 2.x提供了編程式驗證支持，詳見【4.16.2 數(shù)據(jù)驗證】章節(jié)，在此我們重寫【4.16.2.4.1、編程式驗證器】一節(jié)示例。

（1、驗證器實現(xiàn)

復(fù)制cn.javass.chapter4.web.controller.support.validator.UserModelValidator

到cn.javass.chapter7.web.controller.support.validator.UserModelValidator。

（2、控制器實現(xiàn)

Java代碼  

1. @Controller  
2. public class RegisterSimpleFormController {  
3.     private UserModelValidator validator = new UserModelValidator();  
4.   
5.     @ModelAttribute("user")        //① 暴露表單引用對象為模型數(shù)據(jù)  
6.     public UserModel getUser() {  
7.         return new UserModel();  
8.     }  
9.     @RequestMapping(value = "/validator", method = RequestMethod.GET)  
10.     public String showRegisterForm() {   //② 表單展示  
11.         return "validate/registerAndValidator";  
12.     }  
13.     @RequestMapping(value = "/validator", method = RequestMethod.POST)  
14.     public String submitForm(  
15.             @ModelAttribute("user") UserModel user,  
16.             Errors errors) {           //③ 表單提交  
17.         validator.validate(user, errors);  //1 調(diào)用UserModelValidator的validate方法進行驗證  
18.         if(errors.hasErrors()) { //2如果有錯誤再回到表單展示頁面  
19.             return showRegisterForm();  
20.         }  
21.         return "redirect:/success";  
22.     }  
23. }   

在submitForm方法中，我們首先調(diào)用之前寫的UserModelValidator的validate方法進行驗證，當(dāng)然此處可以直接驗證并通過Errors接口來保留錯誤；此處還通過 Errors接口的hasErrors方法來決定當(dāng)驗證失敗時顯示的錯誤頁面。

（3、spring配置文件chapter7-servlet.xml

Java代碼  

1. <bean class="cn.javass.chapter7.web.controller.RegisterSimpleFormController"/>   

（4、錯誤碼配置（messages.properties），需要執(zhí)行NativeToAscii

直接將【springmvc-chapter4】項目中src下的messages.properties復(fù)制到src目錄下。

在spring配置文件chapter7-servlet.xml中添加messageSource：

Java代碼  

1. <bean id="messageSource"   
2. class="org.springframework.context.support.ReloadableResourceBundleMessageSource">  
3.         <property name="basename" value="classpath:messages"/>  
4.         <property name="fileEncodings" value="utf-8"/>  
5.         <property name="cacheSeconds" value="120"/>  
6. </bean>   

（5、視圖頁面（/WEB-INF/jsp/registerAndValidator.jsp）

直接將【springmvc-chapter4】項目中的/WEB-INF/jsp/registerAndValidator.jsp復(fù)制到當(dāng)前項目下的/WEB-INF/jsp/validate/registerAndValidator.jsp。

（6、啟動服務(wù)器測試：

在瀏覽器地址欄輸入http://localhost:9080/springmvc-chapter7/validator進行測試，測試步驟和【4.16.2.4.1、編程式驗證器】一樣。

其他編程式驗證的使用，請參考【4.16.2 數(shù)據(jù)驗證】章節(jié)。

7.4.2、聲明式數(shù)據(jù)驗證

Spring3開始支持JSR-303驗證框架，JSR-303支持XML風(fēng)格的和注解風(fēng)格的驗證，接下來我們首先看一下如何和Spring集成。

7.4.2.1、集成

（1、添加jar包：

此處使用Hibernate-validator實現(xiàn)（版本：hibernate-validator-4.3.0.Final-dist.zip），將如下jar包添加到classpath（WEB-INF/lib下即可）：

（2、在Spring配置總添加對JSR-303驗證框架的支持   

Java代碼  

1. <!-- 以下 validator  ConversionService 在使用 mvc:annotation-driven 會 自動注冊-->  
2. <bean id="validator"   
3. class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">  
4.         <property name="providerClass"  value="org.hibernate.validator.HibernateValidator"/>  
5.         <!-- 如果不加默認(rèn)到 使用classpath下的 ValidationMessages.properties -->  
6.         <property name="validationMessageSource" ref="messageSource"/>  
7. </bean>   

此處使用Hibernate validator實現(xiàn)：

validationMessageSource屬性：指定國際化錯誤消息從哪里取，此處使用之前定義的messageSource來獲取國際化消息；如果此處不指定該屬性，則默認(rèn)到classpath下的ValidationMessages.properties取國際化錯誤消息。

通過ConfigurableWebBindingInitializer注冊validator：

Java代碼  

1. <bean id="webBindingInitializer"   
2. class="org.springframework.web.bind.support.ConfigurableWebBindingInitializer">  
3.         <property name="conversionService" ref="conversionService"/>  
4.         <property name="validator" ref="validator"/>  
5. </bean>   

其他配置和之前學(xué)習(xí)7.2.2.4一節(jié)一樣。

如上集成過程看起來比較麻煩，后邊我們會介紹<mvc:annotation-driven>和@EnableWebMvc，ConversionService會自動注冊，后續(xù)章節(jié)再詳細(xì)介紹。

（3、使用JSR-303驗證框架注解為模型對象指定驗證信息

Java代碼  

1. package cn.javass.chapter7.model;  
2. import javax.validation.constraints.NotNull;  
3. public class UserModel {  
4.     @NotNull(message="{username.not.empty}")  
5.     private String username;  
6. }   

通過@NotNull指定此username字段不允許為空，當(dāng)驗證失敗時將從之前指定的messageSource中獲取“username.not.empty”對于的錯誤信息，此處只有通過“{錯誤消息鍵值}”格式指定的才能從messageSource獲取。

（4、控制器

Java代碼  

1. package cn.javass.chapter7.web.controller.validate;  
2. //省略import  
3. @Controller  
4. public class HelloWorldController {  
5.     @RequestMapping("/validate/hello")  
6.     public String validate(@Valid @ModelAttribute("user") UserModel user, Errors errors) {  
7.           
8.         if(errors.hasErrors()) {  
9.             return "validate/error";  
10.         }  
11.         return "redirect:/success";  
12.     }  
13. }   

通過在命令對象上注解@Valid來告訴Spring MVC此命令對象在綁定完畢后需要進行JSR-303驗證，如果驗證失敗會將錯誤信息添加到errors錯誤對象中。

（5、驗證失敗后需要展示的頁面（/WEB-INF/jsp/validate/error.jsp）

Java代碼  

1. <%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>  
2. <%@taglib prefix="form" uri="http://www./tags/form" %>  
3.   
4. <form:form commandName="user">  
5.     <form:errors path="*" cssStyle="color:red"></form:errors><br/>  
6. </form:form>   

（6、測試

在瀏覽器地址欄中輸入http://localhost:9080/springmvc-chapter7/validate/hello，即沒有username數(shù)據(jù)，請求后將直接到驗證失敗界面并顯示錯誤消息“用戶名不能為空”，如果請求時帶上“?username=zhang”將重定向到成功頁面。

到此集成就完成，接下來我們詳細(xì)學(xué)習(xí)下有哪些驗證約束注解吧。

7.4.2.2、內(nèi)置的驗證約束注解

內(nèi)置的驗證約束注解如下表所示（摘自hibernate validator reference）：

此處只列出Hibernate Validator提供的大部分驗證約束注解，請參考hibernate validator官方文檔了解其他驗證約束注解和進行自定義的驗證約束注解定義。

具體演示實例請參考cn.javass.chapter7.web.controller.validate.ValidatorAnnotationTestController。

7.4.2.3、錯誤消息

當(dāng)驗證出錯時，我們需要給用戶展示錯誤消息告訴用戶出錯的原因，因此我們要為驗證約束注解指定錯誤消息。錯誤消息是通過在驗證約束注解的message屬性指定。驗證約束注解指定錯誤消息有如下兩種方式：

1、硬編碼錯誤消息；

2、從資源消息文件中根據(jù)消息鍵讀取錯誤消息。

一、硬編碼錯誤消息

直接在驗證約束注解上指定錯誤消息，如下所示：

Java代碼  

1. @NotNull(message = "用戶名不能為空")  
2. @Length(min=5, max=20, message="用戶名長度必須在5-20之間")  
3. @Pattern(regexp = "^[a-zA-Z_]\\w{4,19}$", message = "用戶名必須以字母下劃線開頭，可由字母數(shù)字下劃線組成")  
4. private String username;   

如上所示，錯誤消息使用硬編碼指定，這種方式是不推薦使用的，因為在如下場景是不適用的：

1、在國際化場景下，需要對不同的國家顯示不同的錯誤消息；

2、需要更換錯誤消息時是比較麻煩的，需要找到相應(yīng)的類進行更換，并重新編譯發(fā)布。

二、從資源消息文件中根據(jù)消息鍵讀取錯誤消息

2.1、默認(rèn)的錯誤消息文件及默認(rèn)錯誤消息鍵值

默認(rèn)的錯誤消息文件是/org/hibernate/validator/ValidationMessages.properties，如下圖所示：

 默認(rèn)的錯誤消息鍵值如下圖所示：

 消息鍵默認(rèn)為：驗證約束注解的全限定類名.message

在我們之前的測試文件中，錯誤消息鍵值是使用默認(rèn)的，如何自定義錯誤消息文件和錯誤消息鍵值呢？

2.2、自定義的錯誤消息文件和錯誤消息鍵值

自定義的錯誤消息文件里的錯誤消息鍵值將覆蓋默認(rèn)的錯誤消息文件中的錯誤消息鍵值。我們自定義的錯誤消息文件是具有國際化功能的。

（1、定義錯誤消息文件

在類裝載路徑的根下創(chuàng)建ValidationMessages.properties文件，如在src目錄下創(chuàng)建會自動復(fù)制到類裝載路徑的根下，并添加如下消息鍵值（需要native2ascii，可以在eclipse里裝Properties Editor，自動保存為ASCII碼）：

Java代碼  

1. javax.validation.constraints.Pattern.message=用戶名必須以字母或下劃線開頭，后邊可以跟字母數(shù)字下劃線，長度在5-20之間  

需要在你的spring配置文件WEB-INF/chapter7-servlet.xml修改之前的validator Bean：

Java代碼  

1. <bean id="validator"   
2. class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">  
3.         <property name="providerClass"   
4. value="org.hibernate.validator.HibernateValidator"/>  
5. </bean>   

此時錯誤消息鍵值的查找會先到classpath下ValidationMessages.properties中找，找不到再到默認(rèn)的錯誤消息文件中找。

輸入測試地址：http://localhost:9080/springmvc-chapter7/validate/pattern?value=zhan，將看到我們自定義的錯誤消息顯示出來了。

（2、使用Spring的MessageSource Bean進行消息鍵值的查找

如果我們的環(huán)境是與spring集成，還是應(yīng)該使用Spring提供的消息支持，具體配置如下：

在spring配置文件WEB-INF/chapter7-servlet.xml定義MessageSource Bean：

Java代碼  

1. <bean id="messageSource"   
2. class="org.springframework.context.support.ReloadableResourceBundleMessageSource">  
3.         <property name="basename" value="classpath:messages"/>  
4.         <property name="fileEncodings" value="utf-8"/>  
5.         <property name="cacheSeconds" value="120"/>  
6. </bean>   

之前我們已經(jīng)配置過了，在此就不詳述了。

在spring配置文件WEB-INF/chapter7-servlet.xml定義的validator Bean，添加如下屬性：

Java代碼  

1. <property name="validationMessageSource" ref="messageSource"/>  

 驗證失敗的錯誤消息鍵值的查找將使用messageSource Bean進行。

在消息文件src/messages.properties中添加如下錯誤消息：

Java代碼  

1. javax.validation.constraints.Pattern.message=用戶名必須以字母或下劃線開頭，后邊可以跟字母數(shù)字下劃線，長度在5-20之間  

輸入測試地址：http://localhost:9080/springmvc-chapter7/validate/pattern?value=zhan，將看到我們自定義的錯誤消息顯示出來了。

當(dāng)我們配置了messageSource Bean時，默認(rèn)將為驗證的對象自動生成如下錯誤消息鍵：

驗證錯誤注解簡單類名.驗證對象名.字段名

驗證錯誤注解簡單類名.字段名

驗證錯誤注解簡單類名.字段類型全限定類名

驗證錯誤注解簡單類名

使用的優(yōu)先級是：從高到低，即最前邊的具有最高的優(yōu)先級，而且以上所有默認(rèn)的錯誤消息鍵優(yōu)先級高于自定義的錯誤消息鍵。

如測試用例cn.javass.chapter7.web.controller.validate.ValidatorAnnotationTestController中的public String pattern(@Valid @ModelAttribute("model") PatternModel model, Errors errors)將自動產(chǎn)生如下錯誤消息鍵：

Pattern.model.value=驗證錯誤注解簡單類名.驗證對象名.字段名

Pattern.value=驗證錯誤注解簡單類名.字段名

Pattern.java.lang.String=驗證錯誤注解簡單類名.字段類型全限定類名

Pattern=驗證錯誤注解簡單類名

（3、自定義錯誤消息鍵值

之前我們已經(jīng)學(xué)習(xí)了硬編碼錯誤消息，及默認(rèn)的錯誤消息，在大部分場景下，以上兩種方式無法滿足我們的需求，因此我們需要自定義錯誤消息鍵值。

在驗證約束注解上指定錯誤消息鍵：

Java代碼  

1. package cn.javass.chapter7.web.controller.validate.model;  
2. public class PatternModel {   
3.     @Pattern(regexp = "^[a-zA-Z_][\\w]{4,19}$", message="{user.name.error}")  
4.     private String value;  
5. }   

我們可以通過驗證約束注解的message屬性指定錯誤消息鍵，格式如“{消息鍵}”。

在消息文件src/messages.properties中添加如下錯誤消息：

Java代碼  

1. user.name.error=用戶名格式不合法  

輸入測試地址：http://localhost:9080/springmvc-chapter7/validate/pattern?value=zhan，將看到我們自定義的錯誤消息顯示出來了。

接下來我們看下如下場景

Java代碼  

1. @Length(min=5, max=20, message="{user.name.length.error}")  

Java代碼  

1. user.name.error=用戶名長度必須在5-20之間  

錯誤消息中的5-20應(yīng)該是從@Length驗證約束注解中獲取的，而不是在錯誤消息中硬編碼，因此我們需要占位符的支持：

●如@Length(min=5, max=20, message="{user.name.length.error}")，錯誤消息可以這樣寫：用戶名長度必須在{min}-{max}之間

錯誤消息占位符規(guī)則：

{驗證注解屬性名}，如@Length有min和max屬性，則在錯誤消息文件中可以通過{min}和{max}來獲??；如@Max有value屬性，則在錯誤消息文件中可以通過{value}來獲取。

Java代碼  

1. user.name.length.error=用戶名長度必須在{min}-{max}之間  

輸入測試地址：http://localhost:9080/springmvc-chapter7/validate/length?value=1，將看到我們自定義的錯誤消息顯示出來了。

7.4.2.4、功能處理方法上多個驗證參數(shù)的處理

當(dāng)我們在一個功能處理方法上需要驗證多個模型對象時，需要通過如下形式來獲取驗證結(jié)果：

Java代碼  

1. @RequestMapping("/validate/multi")  
2. public String multi(  
3.             @Valid @ModelAttribute("a") A a, BindingResult aErrors,  
4.             @Valid @ModelAttribute("b") B b, BindingResult bErrors) {  
5.           
6.         if(aErrors.hasErrors()) { //如果a模型對象驗證失敗  
7.             return "validate/error";  
8.         }  
9.         if(bErrors.hasErrors()) { //如果a模型對象驗證失敗  
10.             return "validate/error";  
11.         }  
12.         return "redirect:/success";  
13. }   

每一個模型對象后邊都需要跟一個Errors或BindingResult對象來保存驗證結(jié)果，其方法體內(nèi)部可以使用這兩個驗證結(jié)果對象來選擇出錯時跳轉(zhuǎn)的頁面。詳見cn.javass.chapter7.web.controller.validate.MultiModelController。

在錯誤頁面，需要針對不同的模型來顯示錯誤消息：

Java代碼  

1. <form:form commandName="a">  
2.     <form:errors path="*" cssStyle="color:red"></form:errors><br/>  
3. </form:form>  
4. <form:form commandName="b">  
5.     <form:errors path="*" cssStyle="color:red"></form:errors><br/>  
6. </form:form>