第四章 Controller接口控制器详解（2）

4.5、ServletForwardingController

将接收到的请求转发到一个命名的servlet，具体示例如下：

package cn.javass.chapter4.web.servlet;
public class ForwardingServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp)throws ServletException, IOException {
resp.getWriter().write("Controller forward to Servlet");
}
}

<servlet>
<servlet-name>forwarding</servlet-name>
<servlet-class>xx.xx.xx.web.servlet.ForwardingServlet</servlet-class>
</servlet>

<!— 在spring-servlet.xml配置处理器 -->
<bean name="/forwardToServlet"
class="org.springframework.web.servlet.mvc.ServletForwardingController">
<property name="servletName" value="forwarding"></property>
</bean>

当我们请求/forwardToServlet时，会被转发到名字为“forwarding”的servlet处理，该sevlet的servlet-mapping标签配置是可选的。

4.6、BaseCommandController

命令控制器通用基类，提供了以下功能支持：

1、数据绑定：请求参数绑定到一个command object（命令对象，非GoF里的命令设计模式），这里的命令对象是指绑定请求参数的任何POJO对象；

commandClass：表示命令对象实现类，如UserModel；

commandName：表示放入请求的命令对象名字（默认command），request.setAttribute(commandName, commandObject);

2、验证功能：提供Validator注册功能，注册的验证器会验证命令对象属性数据是否合法；

validators：通过该属性注入验证器，验证器用来验证命令对象属性是否合法；

该抽象类没有没有提供流程功能，只是提供了一些公共的功能，实际使用时需要使用它的子类。

4.7、AbstractCommandController

命令控制器之一，可以实现该控制器来创建命令控制器，该控制器能把自动封装请求参数到一个命令对象，而且提供了验证功能。

1、创建命令类（就是普通的JavaBean类/POJO）

package cn.javass.chapter4.model;
public class UserModel {
private String username;
private String password;
//省略setter/getter
}

2、实现控制器

package xx.xx.xx.web.controller;
//省略import
public class MyAbstractCommandController extends AbstractCommandController {
public MyAbstractCommandController() {
//设置命令对象实现类
setCommandClass(UserModel.class);
}
@Override
protected ModelAndView handle(HttpServletRequest req, HttpServletResponse resp, Object command, BindException errors) throws Exception {
//将命令对象转换为实际类型
UserModel user = (UserModel) command;
ModelAndView mv = new ModelAndView();
mv.setViewName("abstractCommand");
mv.addObject("user", user);
return mv;
}
}

<!— 在spring-servlet.xml配置处理器 -->
<bean name="/abstractCommand"
class="xx.xx.xx.web.controller.MyAbstractCommandController">
<!-- 也可以通过依赖注入 注入命令实现类 -->
<!-- property name="commandClass" value="cn.javass.chapter4.model.UserModel"/-->
</bean>

<!— WEB-INF/jsp/abstractCommand.jsp视图下的主要内容 -->

${user.username }-${user.password }

当我们在浏览器中输入“http://localhost:9080/springmvc-chapter4/abstractCommand?username=123&password=123”，会自动将请求参数username和password绑定到命令对象；绑定时按照JavaBean命名规范绑定；

4.8、AbstractFormController

用于支持带步骤的表单提交的命令控制器基类，使用该控制器可以完成：

1、定义表单处理（表单的渲染），并从控制器获取命令对象构建表单；

2、提交表单处理，当用户提交表单内容后，AbstractFormController可以将用户请求的数据绑定到命令对象，并可以验证表单内容、对命令对象进行处理。

@Override
rotected ModelAndView handleRequestInternal(HttpServletRequest request, HttpServletResponse response)
throws Exception {
//1、是否是表单提交？ 该方法实现为（"POST".equals(request.getMethod())），即POST表示表单提交
if (isFormSubmission(request)) {
try {
Object command = getCommand(request);
ServletRequestDataBinder binder = bindAndValidate(request, command);
BindException errors = new BindException(binder.getBindingResult());
//表单提交应该放到该方法实现
return processFormSubmission(request, response, command, errors);
}
catch (HttpSessionRequiredException ex) {
//省略部分代码
return handleInvalidSubmit(request, response);
}
}
else {
//2、表示是表单展示，该方法又转调showForm方法，因此我们需要覆盖showForm来完成表单展示
return showNewForm(request, response);
}

bindOnNewForm：是否在进行表单展示时绑定请求参数到表单对象，默认false，不绑定；

sessionForm：session表单模式，如果开启（true）则会将表单对象放置到session中，从而可以跨越多次请求保证数据不丢失（多步骤表单常使用该方式，详解AbstractWizardFormController），默认false；

Object formBackingObject(HttpServletRequest request) ：提供给表单展示时使用的表单对象（form object表单要展示的默认数据），默认通过commandName暴露到请求给展示表单；

Map referenceData(HttpServletRequest request, Object command, Errors errors)：展示表单时需要的一些引用数据（比如用户注册，可能需要选择工作地点，这些数据可以通过该方法提供），如：

protected Map referenceData(HttpServletRequest request) throws Exception {
Map model = new HashMap();
model.put("cityList", cityList);
return model;
}

这样就可以在表单展示页面获取cityList数据。

SimpleFormController继承该类，而且提供了更简单的表单流程控制。

4.9、SimpleFormController

提供了更好的两步表单支持：

1、准备要展示的数据，并到表单展示页面；

2、提交数据数据进行处理。

第一步，展示：



第二步，提交表单：



接下来咱们写一个用户注册的例子学习一下：

（1、控制器

package xx.xx.xx.web.controller;
//省略import
public class RegisterSimpleFormController extends SimpleFormController {
public RegisterSimpleFormController() {
setCommandClass(UserModel.class); //设置命令对象实现类
setCommandName("user");//设置命令对象的名字
}
//form object 表单对象，提供展示表单时的表单数据（使用commandName放入请求）
protected Object formBackingObject(HttpServletRequest request) throws Exception {
UserModel user = new UserModel();
user.setUsername("请输入用户名");
return user;
}
//提供展示表单时需要的一些其他数据
protected Map referenceData(HttpServletRequest request) throws Exception {
Map map = new HashMap();
map.put("cityList", Arrays.asList("山东", "北京", "上海"));
return map;
}
protected void doSubmitAction(Object command) throws Exception {
UserModel user = (UserModel) command;
//TODO 调用业务对象处理
System.out.println(user);
}
}

setCommandClass和setCommandName：分别设置了命令对象的实现类和名字；

formBackingObject和referenceData：提供了表单展示需要的视图；

doSubmitAction：用于执行表单提交动作，由onSubmit方法调用，如果不需要请求/响应对象或进行数据验证，可以直接使用doSubmitAction方法进行功能处理。

（2、spring配置（spring-servlet.xml）

<bean name="/simpleForm"
class="xx.xx.xx.web.controller.RegisterSimpleFormController">
<property name="formView" value="register"/>
<property name="successView" value="redirect:/success"/>
</bean>
<bean name="/success" class="xx.xx.xx.web.controller.SuccessController"/>

formView：表示展示表单时显示的页面；

successView：表示处理成功时显示的页面；“redirect:/success”表示成功处理后重定向到/success控制器；防止表单重复提交；

“/success” bean的作用是显示成功页面，此处就不列举了。

（3、视图页面

<!-- register.jsp 注册展示页面-->
<form method="post">
username:<input type="text" name="username" value="${user.username}"><br/>
password:<input type="password" name="username"><br/>
city:<select>
<c:forEach items="${cityList }" var="city">
<option>${city}</option>
</c:forEach>
</select><br/>
<input type="submit" value="注册"/>
</form>

此处可以使用${user.username}获取到formBackingObject设置的表单对象、使用${cityList}获取referenceData设置的表单支持数据；

到此一个简单的两步表单到此结束，但这个表单有重复提交表单的问题，而且表单对象到页面的绑定是通过手工绑定的，后边我们会学习spring标签库（提供自动绑定表单对象到页面）。

4.10、CancellableFormController

一个可取消的表单控制器，继承SimpleFormController，额外提供取消表单功能。

1、表单展示：和SimpleFormController一样；

2、表单取消：和SimpleFormController一样；

3、表单成功提交：取消功能处理方法为：onCancel(Object command)，而且默认返回cancelView属性指定的逻辑视图名。

那如何判断是取消呢？如果请求中有参数名为“_cancel”的参数，则表示表单取消。也可以通过cancelParamKey来修改参数名（如“_cancel.x”等）。



示例：

（1、控制器

复制RegisterSimpleFormController一份命名为CanCancelRegisterSimpleFormController，添加取消功能处理方法实现：

@Override
protected ModelAndView onCancel(Object command) throws Exception {
UserModel user = (UserModel) command;
//TODO 调用业务对象处理
System.out.println(user);
return super.onCancel(command);
}

onCancel：在该功能方法内实现取消逻辑，父类的onCancel方法默认返回cancelView属性指定的逻辑视图名。

（2、spring配置（chapter4-servlet.xml）

<bean name="/canCancelForm" class="xx.xx.xx.controller.CanCancelRegisterSimpleFormController">
<property name="formView" value="register"/>
<property name="successView" value="redirect:/success"/>
<property name="cancelView" value="redirect:/cancel"/>
</bean>
<bean name="/cancel" class="xx.xx.xx.web.controller.CancelController"/>

cancelParamKey：用于判断是否是取消的请求参数名，默认是_cancel，即如果请求参数数据中含有名字_cancel则表示是取消，将调用onCancel功能处理方法；

cancelView：表示取消时时显示的页面；“redirect:/cancel”表示成功处理后重定向到/cancel控制器；防止表单重复提交；

“/cancel” bean的作用是显示取消页面，此处就不列举了（详见代码）。

（3、视图页面（修改register.jsp）

<input type="submit" name="_cancel" value="取消"/>

该提交按钮的作用是取消，因为name="_cancel"，即请求后会有一个名字为_cancel的参数，因此会执行onCancel功能处理方法。

（4、测试：

在浏览器输入“http://localhost:9080/springmvc-chapter4/canCancelForm”，则首先到展示视图页面，点击“取消按钮”将重定向到“http://localhost:9080/springmvc-chapter4/cancel”，说明取消成功了。

实际项目可能会出现比如一些网站的完善个人资料都是多个页面（即多步），那应该怎么实现呢？接下来让我们看一下spring Web MVC提供的对多步表单的支持类AbstractWizardFormController。