第四章 Controller介面控制器詳解(3)
4.11、AbstractWizardFormController
嚮導控制器類提供了多步驟(嚮導)表單的支援(如完善個人資料時分步驟填寫基本資訊、工作資訊、學校資訊等)
假設現在做一個完善個人資訊的功能,分三個頁面展示:
1、頁面1完善基本資訊;
2、頁面2完善學校資訊;
3、頁面3完善工作資訊。
這裡我們要注意的是當用戶跳轉到頁面2時頁面1的資訊是需要儲存起來的,還記得AbstractFormController中的sessionForm嗎? 如果為true則表單資料存放到session中,哈哈,AbstractWizardFormController就是使用了這個特性。
嚮導中的頁碼從0開始;
PARAM_TARGET = "_target":
用於選擇嚮導中的要使用的頁面引數名字首,如“_target0”則選擇第0個頁面顯示,即圖中的“wizard/baseInfo”,以此類推,如“_target1”將選擇第1頁面,要得到的頁碼為去除字首“_target”後的數字即是;
PARAM_FINISH = "_finish":
如果請求引數中有名為“_finish”的引數,表示嚮導成功結束,將會呼叫processFinish方法進行完成時的功能處理;
PARAM_CANCEL = "_cancel":
如果請求引數中有名為“_cancel”的引數,表示嚮導被取消,將會呼叫processCancel方法進行取消時的功能處理;
嚮導中的命令物件:
嚮導中的每一個步驟都會把相關的引數繫結到命令物件,該表單物件預設放置在session中,從而可以跨越多次請求得到該命令物件。
接下來具體看一下如何使用吧。
(1、修改我們的模型資料以支援多步驟提交:
Java程式碼
- public class UserModel {
- private String username;
- private String password;
- private String realname; //真實姓名
- private WorkInfoModel workInfo;
- private SchoolInfoModel schoolInfo;
- //省略getter/setter
- }
Java程式碼
- public class SchoolInfoModel {
- private String schoolType; //學校型別:高中、中專、大學
- private String schoolName; //學校名稱
- private String specialty; //專業
- //省略getter/setter
- }
Java程式碼
- public class WorkInfoModel {
- private String city; //所在城市
- private String job; //職位
- private String year; //工作年限
- //省略getter/setter
- }
(2、控制器
Java程式碼
- package cn.javass.chapter4.web.controller;
- //省略import
- public class InfoFillWizardFormController extends AbstractWizardFormController {
- public InfoFillWizardFormController() {
- setCommandClass(UserModel.class);
- setCommandName("user");
- }
- protected Map referenceData(HttpServletRequest request, int page) throws Exception {
- Map map = new HashMap();
- if(page==1) { //如果是填寫學校資訊頁 需要學校型別資訊
- map.put("schoolTypeList", Arrays.asList("高中", "中專", "大學"));
- }
- if(page==2) {//如果是填寫工作資訊頁 需要工作城市資訊
- map.put("cityList", Arrays.asList("濟南", "北京", "上海"));
- }
- return map;
- }
- protected void validatePage(Object command, Errors errors, int page) {
- //提供每一頁資料的驗證處理方法
- }
- protected void postProcessPage(HttpServletRequest request, Object command, Errors errors, int page) throws Exception {
- //提供給每一頁完成時的後處理方法
- }
- protected ModelAndView processFinish(HttpServletRequest req, HttpServletResponse resp, Object command, BindException errors) throws Exception {
- //成功後的處理方法
- System.out.println(command);
- return new ModelAndView("redirect:/success");
- }
- protected ModelAndView processCancel(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors) throws Exception {
- //取消後的處理方法
- System.out.println(command);
- return new ModelAndView("redirect:/cancel");
- }
- }
page頁碼:是根據請求中以“_target”開頭的引數名來確定的,如“_target0”,則頁碼為0;
referenceData:提供每一頁需要的表單支援物件,如完善學校資訊需要學校型別,page頁碼從0開始(而且根據請求引數中以“_target”開頭的引數來確定當前頁碼,如_target1,則page=1);
validatePage:驗證當前頁的命令物件資料,驗證應根據page頁碼來分步驟驗證;
postProcessPage:驗證成功後的後處理;
processFinish:成功時執行的方法,此處直接重定向到/success控制器(詳見CancelController);
processCancel:取消時執行的方法,此處直接重定向到/cancel控制器(詳見SuccessController);
其他需要了解:
allowDirtyBack和allowDirtyForward:決定在當前頁面驗證失敗時,是否允許嚮導前移和後退,預設false不允許;
onBindAndValidate(HttpServletRequest request, Object command, BindException errors, int page):允許覆蓋預設的繫結引數到命令物件和驗證流程。
(3、spring配置檔案(chapter4-servlet.xml)
Java程式碼
- <bean name="/infoFillWizard"
- class="cn.javass.chapter4.web.controller.InfoFillWizardFormController">
- <property name="pages">
- <list>
- <value>wizard/baseInfo</value>
- <value>wizard/schoolInfo</value>
- <value>wizard/workInfo</value>
- </list>
- </property>
- </bean>
pages:表示嚮導中每一個步驟的邏輯檢視名,當InfoFillWizardFormController的page=0,則將會選擇“wizard/baseInfo”,以此類推,從而可以按步驟選擇要展示的檢視。
(4、嚮導中的每一步檢視
(4.1、基本資訊頁面(第一步) baseInfo.jsp:
Java程式碼
- <form method="post">
- 真實姓名:<input type="text" name="realname" value="${user.realname}"><br/>
- <input type="submit" name="_target1" value="下一步"/>
- </form>
當前頁碼為0;
name="_target1":表示嚮導下一步要顯示的頁面的頁碼為1;
(4.2、學校資訊頁面(第二步) schoolInfo.jsp:
Java程式碼
- <form method="post">
- 學校型別:<select name="schoolInfo.schoolType">
- <c:forEach items="${schoolTypeList }" var="schoolType">
- <option value="${schoolType }"
- <c:if test="${user.schoolInfo.schoolType eq schoolType}">
- selected="selected"
- </c:if>
- >
- ${schoolType}
- </option>
- </c:forEach>
- </select><br/>
- 學校名稱:<input type="text" name="schoolInfo.schoolName" value="${user.schoolInfo.schoolName}"/><br/>
- 專業:<input type="text" name="schoolInfo.specialty" value="${user.schoolInfo.specialty}"/><br/>
- <input type="submit" name="_target0" value="上一步"/>
- <input type="submit" name="_target2" value="下一步"/>
- </form>
(4.3、工作資訊頁面(第三步) workInfo.jsp:
Java程式碼
- <form method="post">
- 所在城市:<select name="workInfo.city">
- <c:forEach items="${cityList }" var="city">
- <option value="${city }"
- <c:if test="${user.workInfo.city eq city}">selected="selected"</c:if>
- >
- ${city}
- </option>
- </c:forEach>
- </select><br/>
- 職位:<input type="text" name="workInfo.job" value="${user.workInfo.job}"/><br/>
- 工作年限:<input type="text" name="workInfo.year" value="${user.workInfo.year}"/><br/>
- <input type="submit" name="_target1" value="上一步"/>
- <input type="submit" name="_finish" value="完成"/>
- <input type="submit" name="_cancel" value="取消"/>
- </form>
當前頁碼為2;
name="_target1":上一步,表示嚮導上一步要顯示的頁面的頁碼為1;
name="_finish":嚮導完成,表示嚮導成功,將會呼叫嚮導控制器的processFinish方法;
name="_cancel":嚮導取消,表示嚮導被取消,將會呼叫嚮導控制器的processCancel方法;
到此嚮導控制器完成,此處的嚮導流程比較簡單,如果需要更復雜的頁面流程控制,可以選擇使用Spring Web Flow框架。
4.12、ParameterizableViewController
引數化檢視控制器,不進行功能處理(即靜態檢視),根據引數的邏輯檢視名直接選擇需要展示的檢視。
Java程式碼
- <bean name="/parameterizableView"
- class="org.springframework.web.servlet.mvc.ParameterizableViewController">
- <property name="viewName" value="success"/>
- </bean>
該控制器接收到請求後直接選擇引數化的檢視,這樣的好處是在配置檔案中配置,從而避免程式的硬編碼,比如像幫助頁面等不需要進行功能處理,因此直接使用該控制器對映到檢視。
4.13、AbstractUrlViewController
提供根據請求URL路徑直接轉化為邏輯檢視名的支援基類,即不需要功能處理,直接根據URL計算出邏輯檢視名,並選擇具體檢視進行展示:
urlDecode:是否進行url解碼,不指定則預設使用伺服器編碼進行解碼(如Tomcat預設ISO-8859-1);
urlPathHelper:用於解析請求路徑的工具類,預設為org.springframework.web.util.UrlPathHelper。
UrlFilenameViewController是它的一個實現者,因此我們應該使用UrlFilenameViewController。
4.14、UrlFilenameViewController
將請求的URL路徑轉換為邏輯檢視名並返回的轉換控制器,即不需要功能處理,直接根據URL計算出邏輯檢視名,並選擇具體檢視進行展示:
根據請求URL路徑計算邏輯檢視名;
Java程式碼
- <bean name="/index1/*"
- class="org.springframework.web.servlet.mvc.UrlFilenameViewController"/>
- <bean name="/index2/**"
- class="org.springframework.web.servlet.mvc.UrlFilenameViewController"/>
- <bean name="/*.html"
- class="org.springframework.web.servlet.mvc.UrlFilenameViewController"/>
- <bean name="/index3/*.html"
- class="org.springframework.web.servlet.mvc.UrlFilenameViewController"/>
/index1/*:可以匹配/index1/demo,但不匹配/index1/demo/demo,如/index1/demo邏輯檢視名為demo;
/index2/**:可以匹配/index2路徑下的所有子路徑,如匹配/index2/demo,或/index2/demo/demo,“/index2/demo”的邏輯檢視名為demo,而“/index2/demo/demo”邏輯檢視名為demo/demo;
/*.html:可以匹配如/abc.html,邏輯檢視名為abc,字尾會被刪除(不僅僅可以是html);
/index3/*.html:可以匹配/index3/abc.html,邏輯檢視名也是abc;
上述模式為Spring Web MVC使用的Ant-style 模式進行匹配的:
Java程式碼
- ? 匹配一個字元,如/index? 可以匹配 /index1 , 但不能匹配 /index 或 /index12
- * 匹配零個或多個字元,如/index1/*,可以匹配/index1/demo,但不匹配/index1/demo/demo
- ** 匹配零個或多個路徑,如/index2/**:可以匹配/index2路徑下的所有子路徑,如匹配/index2/demo,或/index2/demo/demo
- 如果我有如下模式,那Spring該選擇哪一個執行呢?當我的請求為“/long/long”時如下所示:
- /long/long
- /long/**/abc
- /long/**
- /**
- Spring的AbstractUrlHandlerMapping使用:最長匹配優先;
- 如請求為“/long/long” 將匹配第一個“/long/long”,但請求“/long/acd” 則將匹配 “/long/**”,如請求“/long/aa/abc”則匹配“/long/**/abc”,如請求“/abc”則將匹配“/**”
UrlFilenameViewController還提供瞭如下屬性:
prefix:生成邏輯檢視名的字首;
suffix:生成邏輯檢視名的字尾;
Java程式碼
- protected String postProcessViewName(String viewName) {
- return getPrefix() + viewName + getSuffix();
- }
Java程式碼
- <bean name="/*.htm" class="org.springframework.web.servlet.mvc.UrlFilenameViewController">
- <property name="prefix" value="test"/>
- <property name="suffix" value="test"/>
- </bean>
當prefix=“test”,suffix=“test”,如上所示的/*.htm:可以匹配如/abc.htm,但邏輯檢視名將變為testabctest。