向导控制器类提供了多步骤(向导)表单的支持(如完善个人资料时分步骤填写基本信息、工作信息、学校信息等)。
假设现在做一个完善个人信息的功能,分三个页面展示:
- 页面1完善基本信息;
- 页面2完善学校信息;
- 页面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中,从而可以跨越多次请求得到该命令对象。
接下来具体看一下如何使用吧。先接下来具体看一下如何使用吧。
public class UserModel { private String username; private String password; private String realname; //真实姓名 private WorkInfoModel workInfo; private SchoolInfoModel schoolInfo; //省略getter/setter }
public class SchoolInfoModel { private String schoolType; //学校类型:高中、中专、大学 private String schoolName; //学校名称 private String specialty; //专业 //省略getter/setter }
public class WorkInfoModel { private String city; //所在城市 private String job; //职位 private String year; //工作年限 //省略getter/setter }
接下来看看控制器的实现代码。
package com.xttblog.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):允许覆盖默认的绑定参数到命令对象和验证流程。
spring配置文件(chapter4-servlet.xml)
<bean name="/infoFillWizard" class="com.xttblog.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”,以此类推,从而可以按步骤选择要展示的视图。
向导中的每一步视图
基本信息页面(第一步) baseInfo.jsp:
<form method="post"> 真实姓名:<input type="text" name="realname" value="${user.realname}"><br/> <input type="submit" name="_target1" value="下一步"/> </form>
当前页码为0;
name="_target1":表示向导下一步要显示的页面的页码为1;
学校信息页面(第二步) schoolInfo.jsp:
<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>
工作信息页面(第三步) workInfo.jsp:
<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框架。
: » AbstractWizardFormController(向导控制器)
原创文章,作者:kirin,如若转载,请注明出处:https://blog.ytso.com/251632.html