4.16.2、資料驗證

1、資料繫結失敗：比如需要數字卻輸入了字母；

2、資料不合法：可以認為是業務錯誤，通過自定義驗證器驗證，如使用者名稱長度必須在5-20之間，我們卻輸入了100個字元等；

3、錯誤物件：當我們資料繫結失敗或驗證失敗後，錯誤資訊存放的物件，我們叫錯誤物件，在Spring Web MVC中Errors是具體的代表者；執行緒不安全物件；

4、錯誤訊息：是硬編碼，還是可配置？實際工作應該使用配置方式，我們只是把錯誤碼（errorCode）放入錯誤物件，在展示時讀取相應的錯誤訊息配置檔案來獲取要顯示的錯誤訊息(errorMessage)；

 

4.16.2.1、驗證流程

 

1、首先進行資料繫結驗證，如果驗證失敗會通過MessageCodesResolver生成錯誤碼放入Errors錯誤物件；

2、資料不合法驗證，通過自定義的驗證器驗證，如果失敗需要手動將錯誤碼放入Errors錯誤物件；

4.16.2.2、錯誤物件和錯誤訊息

錯誤物件的代表者是Errors介面，並且提供了幾個實現者，在Spring Web MVC中我們使用的是如下實現：

 

相關的錯誤方法如下：

Errors：儲存和暴露關於資料繫結錯誤和驗證錯誤相關資訊的介面，提供了相關儲存和獲取錯誤訊息的方法：

 

java程式碼： Java程式碼  

1. package org.springframework.validation;  
2. public interface Errors {  
3.   //=========================全域性錯誤訊息（驗證/繫結物件全域性的）=============================  
4.   //註冊一個全域性的錯誤碼（）
     
5.   void reject(String errorCode);  
6.   //註冊一個全域性的錯誤碼，當根據errorCode沒有找到相應錯誤訊息時，使用defaultMessage作為錯誤訊息  
7.   void reject(String errorCode, String defaultMessage);  
8.   //註冊一個全域性的錯誤碼，當根據errorCode沒有找到相應錯誤訊息時（帶錯誤引數的），使用defaultMessage作為錯誤訊息  
9.   void reject(String errorCode, Object[] errorArgs, String defaultMessage);  
10.   //=========================全域性錯誤訊息（驗證/繫結整個物件的）=============================  
11.   //=========================區域性錯誤訊息（驗證/繫結物件欄位的）=============================  
12.   //註冊一個物件欄位的錯誤碼，field指定驗證失敗的欄位名  
13.   void rejectValue(String field, String errorCode);  
14.   void rejectValue(String field, String errorCode, String defaultMessage);  
15.   void rejectValue(String field, String errorCode, Object[] errorArgs, String defaultMessage);  
16.   //=========================區域性錯誤訊息（驗證/繫結物件欄位的）=============================  
17.   boolean hasErrors();      ////是否有錯誤  
18.   boolean hasGlobalErrors(); //是否有全域性錯誤  
19.   boolean hasFieldErrors();  //是否有欄位錯誤  
20.   Object getFieldValue(String field); //返回當前驗證通過的值，或驗證失敗時失敗的值；  
21. }  

 

getFieldValue：可以得到驗證失敗的失敗值，這是其他Web層框架很少支援的，這樣就可以給使用者展示出錯時的值（而不是空或其他的預設值等）。

 

BindingResult：代表資料繫結的結果，繼承了Errors介面。

BindException：代表資料繫結的異常，它繼承Exception，並實現了BindingResult，這是內部使用的錯誤物件。

 

示例：

（1、控制器

 

java程式碼： Java程式碼  

1. package cn.javass.chapter4.web.controller;  
2. //省略import  
3. public class ErrorController extends AbstractCommandController {  
4.        public ErrorController() {  
5.               setCommandClass(DataBinderTestModel.class);  
6.               setCommandName("command");  
7.        }  
8.        @Override  
9.        protected ModelAndView handle(HttpServletRequest req, HttpServletResponse resp, Object command, BindException errors) throws Exception {     
10.               //表示使用者名稱不為空  
11.               errors.reject("username.not.empty");  
12.               //帶有預設錯誤訊息  
13.               errors.reject("username.not.empty1", "使用者名稱不能為空1");  
14.               //帶有引數和預設錯誤訊息          
15.               errors.reject("username.length.error", new Object[]{5, 10});  
16.                
17.               //得到錯誤相關的模型資料  
18.               Map model = errors.getModel();  
19.               return new ModelAndView("bindAndValidate/error", model);  
20.        }  
21. }  

 

errors.reject("username.not.empty")：註冊全域性錯誤碼“username.not.empty”，我們必須提供messageSource來提供錯誤碼“username.not.empty”對應的錯誤資訊（如果沒有會丟擲NoSuchMessageException異常）；

 

errors.reject("username.not.empty1", "使用者名稱不能為空1")：註冊全域性錯誤碼“username.not.empty1”，如果從messageSource沒沒有找到錯誤碼“username.not.empty1”對應的錯誤資訊，則將顯示預設訊息“使用者名稱不能為空1”；

 

errors.reject("username.length.error", new Object[]{5, 10})：錯誤碼為“username.length.error”，而且錯誤資訊需要兩個引數，如我們在我們的配置檔案中定義“使用者名稱長度不合法，長度必須在{0}到{1}之間”，則實際的錯誤訊息為“使用者名稱長度不合法，長度必須在5到10之間”

errors.getModel()：當有錯誤資訊時，一定將errors.getModel()放入我們要返回的ModelAndView中，以便使用裡邊的錯誤物件來顯示錯誤資訊。

 

（2、spring配置檔案chapter4-servlet.xml

 

java程式碼： 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>  
7.    
8. <bean name="/error" class="cn.javass.chapter4.web.controller.ErrorController"/>  

 

messageSource：用於獲取錯誤碼對應的錯誤訊息的，而且bean名字預設必須是messageSource。

 

messages.properties（需要執行NativeToAscii）

 

java程式碼： Java程式碼  

1. username.not.empty=使用者名稱不能為空  
2. username.length.error=使用者名稱長度不合法，長度必須在{0}到{1}之間  

 

（3、檢視頁面（WEB-INF/jsp/bindAndValidate/error.jsp）

 

java程式碼： Java程式碼  

1. <%@taglib prefix="form" uri="http://www.springframework.org/tags/form" %>  
2. <!-- 表單的預設命令物件名為command -->  
3. <form:form commandName="command">  
4.     <form:errors path="*"></form:errors>  
5. </form:form>  

 

form標籤庫：此處我們使用了spring的form標籤庫；

<form:form commandName="command">:表示我們的表單標籤，commandName表示繫結的命令物件名字，預設為command；

<form:errors path="*"></form:errors>：表示顯示錯誤資訊的標籤，如果path為“*”表示顯示所有錯誤資訊。

 

接下來我們來看一下 資料繫結失敗和資料不合法時，如何處理。

4.16.2.3、資料繫結失敗

如我們的DataBinderTestModel類：

bool：boolean型別，此時如果我們前臺傳入非相容的資料，則會資料繫結失敗；

date：Date型別，此時如果我們前臺傳入非相容的資料，同樣會資料繫結失敗；

phoneNumber：自定義的PhoneNumberModel型別，如果如果我們前臺傳入非相容的資料，同樣會資料繫結失敗。

 

示例：

（1、控制器，DataBinderErrorTestController。

 

 

java程式碼： Java程式碼  

1. package cn.javass.chapter4.web.controller;  
2. //省略import  
3. public class DataBinderErrorTestController extends SimpleFormController {  
4.        public DataBinderErrorTestController() {  
5.               setCommandClass(DataBinderTestModel.class);  
6.               setCommandName("dataBinderTest");  
7.        }  
8.        @Override  
9.        protected ModelAndView showForm(HttpServletRequest request, HttpServletResponse response, BindException errors) throws Exception {  
10.               //如果表單提交有任何錯誤都會再回到表單展示頁面  
11.               System.out.println(errors);  
12.               return super.showForm(request, response, errors);  
13.        }  
14.        @Override  
15.        protected void doSubmitAction(Object command) throws Exception {  
16.               System.out.println(command); //表單提交成功（資料繫結成功）進行功能處理  
17.     }  
18.        @Override  
19.        protected void initBinder(HttpServletRequest request, ServletRequestDataBinder binder) throws Exception {  
20.               super.initBinder(request, binder);  
21.               //註冊自定義的屬性編輯器  
22.               //1、日期  
23.               DateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");  
24.               CustomDateEditor dateEditor = new CustomDateEditor(df, true);  
25.               //表示如果命令物件有Date型別的屬性，將使用該屬性編輯器進行型別轉換  
26.               binder.registerCustomEditor(Date.class, dateEditor);  
27.                
28.               //自定義的電話號碼編輯器  
29.               binder.registerCustomEditor(PhoneNumberModel.class, new PhoneNumberEditor());  
30.        }  
31. }  

此處我們使用SimpleFormController；

showForm：展示表單，當提交表單有任何資料繫結錯誤會再回到該方法進行表單輸入（在此處我們列印錯誤物件）；

doSubmitAction：表單提交成功，只要當表單的資料到命令物件繫結成功時，才會執行；

 

（2、spring配置檔案chapter4-servlet.xml

 

java程式碼： Java程式碼  

1. <bean name="/dataBindError"  
2. class="cn.javass.chapter4.web.controller.DataBinderErrorTestController">  
3.    <property name="formView" value="bindAndValidate/input"/>  
4.    <property name="successView" value="bindAndValidate/success"/>  
5. </bean>  

 

（3、檢視頁面（WEB-INF/jsp/bindAndValidate/ input.jsp）

 

java程式碼：