Controller接口控制器4

时间 2019-11-08

标签 controller 接口控制器繁體版

原文原文链接

本文为转载学习html

原文连接：http://jinnianshilongnian.iteye.com/blog/1630585java

MultiActionControllerweb

以前学过的控制器如AbstractCommandController、SimpleFormController等通常对应一个功能处理方法（如新增），若是我要实现好比最简单的用户增删改查（CRUD Create-Read-Update-Delete），那该怎么办呢？spring

解决方案缓存

一、每个功能对应一个控制器，若是是CRUD则须要四个控制器，但这样咱们的控制器会暴增，确定不可取；session

二、使用Spring Web MVC提供的MultiActionController，用于支持在一个控制器里添加多个功能处理方法，即将多个请求的处理方法放置到一个控制器里，这种方式不错。mvc

问题app

一、MultiActionController如何将不一样的请求映射不一样的请求的功能处理方法呢？jsp

Spring Web MVC提供了MethodNameResolver（方法名解析器）用于解析当前请求到须要执行的功能处理方法的方法名。默认使用InternalPathMethodNameResolver实现类，另外还提供了ParameterMethodNameResolver和PropertiesMethodNameResolver，固然咱们也能够本身来实现，稍候咱们仔细研究下它们是如何工做的。post

二、那咱们的功能处理方法应该怎么写呢？
public (ModelAndView | Map | String | void) actionName(HttpServletRequest request, HttpServletResponse response, [,HttpSession session] [,AnyObject]);

此处须要注意一下几点：

一、返回值：即模型和视图部分；

ModelAndView：模型和视图部分，以前已经见过了；

Map：只返回模型数据，逻辑视图名会根据RequestToViewNameTranslator实现类来计算，稍候讨论；

String：只返回逻辑视图名；

void：表示该功能方法直接写出response响应（若是其余返回值类型（如Map）返回null则和void进行相同的处理）；

二、actionName：功能方法名字；由methodNameResolver根据请求信息解析功能方法名，经过反射调用；

三、形参列表：顺序固定，“[]”表示可选，咱们来看看几个示例吧：

//表示到新增页面
public ModelAndView toAdd(HttpServletRequest request, HttpServletResponse response);

//表示新增表单提交，在最后能够带着命令对象
public ModelAndView add(HttpServletRequest request, HttpServletResponse response, UserModel user);

//列表，但只返回模型数据，视图名会经过RequestToViewNameTranslator实现来计算
public Map list(HttpServletRequest request, HttpServletResponse response);

//文件下载，返回值类型为void，表示该功能方法直接写响应
public void fileDownload(HttpServletRequest request, HttpServletResponse response)

//第三个参数能够是session
public ModelAndView sessionWith(HttpServletRequest request, HttpServletResponse response, HttpSession session);

//若是第三个参数是session，那么第四个能够是命令对象，顺序必须是以下顺序
public void sessionAndCommandWith(HttpServletRequest request, HttpServletResponse response, HttpSession session, UserModel user)

四、异常处理方法，MultiActionController提供了简单的异常处理，即在请求的功能处理过程当中遇到异常会交给异常处理方法进行处理，式以下所示：
public ModelAndView anyMeaningfulName(HttpServletRequest request, HttpServletResponse response, ExceptionClass exception)

MultiActionController会使用最接近的异常类型来匹配对应的异常处理方法，示例以下所示：
//处理PayException
public ModelAndView processPayException(HttpServletRequest request, HttpServletResponse response, PayException ex)
//处理Exception
public ModelAndView processException(HttpServletRequest request, HttpServletResponse response,  Exception ex)

MultiActionController类实现

类定义：public class MultiActionController extends AbstractController implements LastModified ，继承了AbstractController，并实现了LastModified接口，默认返回-1；

核心属性：

delegate：功能处理的委托对象，即咱们要调用请求处理方法所在的对象，默认是this；

methodNameResolver：功能处理方法名解析器，即根据请求信息来解析须要执行的delegate的功能处理方法的方法名。

核心方法：

//判断方法是不是功能处理方法
private boolean isHandlerMethod(Method method) {
        //获得方法返回值类型
        Class returnType = method.getReturnType();
        //返回值类型必须是ModelAndView、Map、String、void中的一种，不然不是功能处理方法
        if (ModelAndView.class.equals(returnType) || Map.class.equals(returnType) || 
        String.class.equals(returnType) ||void.class.equals(returnType)) {
            Class[] parameterTypes = method.getParameterTypes();
          //功能处理方法参数个数必须>=2，且第一个是HttpServletRequest类型、第二个是HttpServletResponse
          //且不能Controller接口的handleRequest(HttpServletRequest request, HttpServletResponse response)，这个方法是由系统调用
            return (parameterTypes.length >= 2 &&
                HttpServletRequest.class.equals(parameterTypes[0]) &&
                HttpServletResponse.class.equals(parameterTypes[1]) &&
                !("handleRequest".equals(method.getName()) && parameterTypes.length == 2));
        }
        return false;
}

//是不是异常处理方法
private boolean isExceptionHandlerMethod(Method method) {
    //异常处理方法必须是功能处理方法 且 参数长度为三、第三个参数类型是Throwable子类
    return (isHandlerMethod(method) && method.getParameterTypes().length == 3 &&
        Throwable.class.isAssignableFrom(method.getParameterTypes()[2]));
}

private void registerHandlerMethods(Object delegate) {
    //缓存Map清空
    this.handlerMethodMap.clear();
    this.lastModifiedMethodMap.clear();
    this.exceptionHandlerMap.clear();
    //获得委托对象的全部public方法
    Method[] methods = delegate.getClass().getMethods();
    for (Method method : methods) {
        //验证是不是异常处理方法，若是是放入exceptionHandlerMap缓存map
        if (isExceptionHandlerMethod(method)) {
            registerExceptionHandlerMethod(method);
        }
        //验证是不是功能处理方法，若是是放入handlerMethodMap缓存map
        else if (isHandlerMethod(method)) {
            registerHandlerMethod(method);
            registerLastModifiedMethodIfExists(delegate, method);
        }
    }
}

protected ModelAndView handleRequestInternal(HttpServletRequest request, HttpServletResponse response)throws Exception {
    try {
        //一、使用methodNameResolver 方法名解析器根据请求解析到要执行的功能方法的方法名
        String methodName = this.methodNameResolver.getHandlerMethodName(request);
        //二、调用功能方法（经过反射调用，此处就粘贴代码了）
        return invokeNamedMethod(methodName, request, response);
     }
    catch (NoSuchRequestHandlingMethodException ex) {
        return handleNoSuchRequestHandlingMethod(ex, request, response);
    }
}

接下来，咱们看一下MultiActionController如何使用MethodNameResolver来解析请求到功能处理方法的方法名。

MethodNameResolver

一、InternalPathMethodNameResolver：MultiActionController的默认实现，提供从请求URL路径解析功能方法的方法名，从请求的最后一个路径（/）开始，并忽略扩展名；如请求URL是“/user/list.html”，则解析的功能处理方法名为“list”，即调用list方法。该解析器还能够指定前缀和后缀，经过prefix和suffix属性，如指定prefix=”test_”,则功能方法名将变为test_list；

二、ParameterMethodNameResolver：提供从请求参数解析功能处理方法的方法名，并按照以下顺序进行解析：

一、 methodParamNames：根据请求的参数名解析功能方法名（功能方法名和参数名同名）；
<property name="methodParamNames" value="list,create,update"/>
如上配置时，若是请求中含有参数名list、create、update时，则功能处理方法名为list、create、update，这种方式的能够在当一个表单有多个提交按钮时使用，不一样的提交按钮名字不同便可。

ParameterMethodNameResolver也考虑到图片提交按钮提交问题：

<input type="image" name="list"> 和submit相似能够提交表单，单击该图片后会发送两个参数“list.x=x轴坐标”和“list.y=y轴坐标”（如提交后会变为list.x=7&list.y=5）；所以咱们配置的参数名（如list）在会加上“.x” 和 “.y”进行匹配。
for (String suffix : SUBMIT_IMAGE_SUFFIXES)  {//SUBMIT_IMAGE_SUFFIXES {“.x”, “.y”}
    if (request.getParameter(name + suffix) != null) {// name是咱们配置的methodParamNames
        return true;
    }
}

二、paramName：根据请求参数名的值解析功能方法名，默认的参数名是action，即请求的参数中含有“action=query”，则功能处理方法名为query；

三、logicalMappings：逻辑功能方法名到真实功能方法名映射，以下所示：

<property name="logicalMappings">

<props>

<prop key="doList">list</prop>

</props>

</property>

即若是步骤1或2解析出逻辑功能方法名为doList（逻辑的），将会被从新映射为list功能方法名（真正执行的）。

四、defaultMethodName：默认的方法名，当以上策略失败时默认调用的方法名。

三、PropertiesMethodNameResolver：提供自定义的从请求URL解析功能方法的方法名，使用一组用户自定义的模式到功能方法名的映射，映射使用Properties对象存放，具体配置示例以下：

<bean id="propertiesMethodNameResolver" 
class="org.springframework.web.servlet.mvc.multiaction.PropertiesMethodNameResolver">
    <property name="mappings">
        <props>
              <prop key="/create">create</prop>
              <prop key="/update">update</prop>
              <prop key="/delete">delete</prop>
              <prop key="/list">list</prop>
              <!-- 默认的行为 -->
              <prop key="/**">list</prop>
        </props>
    </property>
</bean>&nbsp;

对于/create请求将调用create方法，Spring内部使用PathMatcher进行匹配（默认实现是AntPathMatcher）。

RequestToViewNameTranslator

用于直接将请求转换为逻辑视图名。默认实现为DefaultRequestToViewNameTranslator。

一、DefaultRequestToViewNameTranslator：将请求URL转换为逻辑视图名，默认规则以下：

http://localhost:9080/web上下文/list -------> 逻辑视图名为list

http://localhost:9080/web上下文/list.html -------> 逻辑视图名为list(默认删除扩展名)

http://localhost:9080/web上下文/user/list.html -------> 逻辑视图名为user/list

示例

一、控制器UserController

package cn.javass.chapter4.web.controller;
//省略import
public class UserController extends MultiActionController {
    //用户服务类
    private UserService userService;
    //逻辑视图名 经过依赖注入方式注入，可配置
    private String createView;
    private String updateView;
    private String deleteView;
    private String listView;
    private String redirectToListView;
    //省略setter/getter
    public String create(HttpServletRequest request, HttpServletResponse response, 
    UserModel user) {
        if("GET".equals(request.getMethod())) {
            //若是是get请求 咱们转向 新增页面
            return getCreateView();
        }
        userService.create(user);
        //直接重定向到列表页面
        return getRedirectToListView();
    }
    public ModelAndView update(HttpServletRequest request, HttpServletResponse response, 
    UserModel user) {
        if("GET".equals(request.getMethod())) {
            //若是是get请求 咱们转向更新页面
            ModelAndView mv = new ModelAndView();
            //查询要更新的数据
            mv.addObject("command", userService.get(user.getUsername()));
            mv.setViewName(getUpdateView());
            return mv;
        }
        userService.update(user);
        //直接重定向到列表页面
        return new ModelAndView(getRedirectToListView());
    }
    public ModelAndView delete(HttpServletRequest request, HttpServletResponse response, 
    UserModel user) {
        if("GET".equals(request.getMethod())) {
            //若是是get请求 咱们转向删除页面
            ModelAndView mv = new ModelAndView();
            //查询要删除的数据
            mv.addObject("command", userService.get(user.getUsername()));
            mv.setViewName(getDeleteView());
            return mv;
        }
        userService.delete(user);
        //直接重定向到列表页面
        return new ModelAndView(getRedirectToListView());
    }
    public ModelAndView list(HttpServletRequest request, HttpServletResponse response) {
        ModelAndView mv = new ModelAndView();
        mv.addObject("userList", userService.list());
        mv.setViewName(getListView());
        return mv;
    }
    //若是使用委托方式，命令对象名称只能是command
    protected String getCommandName(Object command) {
        //命令对象的名字 默认command
        return "command";
    }
}

增删改：若是是GET请求方法，则表示到展现页面，POST请求方法表示真正的功能操做；

getCommandName：表示是命令对象名字，默认command，对于委托对象实现方式没法改变，所以咱们就使用默认的吧。

二、spring配置文件chapter4-servlet.xml

   <bean id="userService" class="cn.javass.chapter4.service.UserService"/>
   <bean name="/user/**" class="cn.javass.chapter4.web.controller.UserController">
       <property name="userService" ref="userService"/>
       <property name="createView" value="user/create"/>
       <property name="updateView" value="user/update"/>
       <property name="deleteView" value="user/delete"/>
       <property name="listView" value="user/list"/>
       <property name="redirectToListView" value="redirect:/user/list"/>
       <!-- 使用PropertiesMethodNameResolver来解析功能处理方法名 -->       
       <!--property name="methodNameResolver" ref="propertiesMethodNameResolver"/-->
   </bean>

    userService：用户服务类，实现业务逻辑；

    依赖注入：对于逻辑视图页面经过依赖注入方式注入，redirectToListView表示增删改为功后重定向的页面，防止重复表单提交；

    默认使用InternalPathMethodNameResolver解析请求URL到功能方法名。

三、视图页面

3.一、list页面（WEB-INF/jsp/user/list.jsp）

 <a href="${pageContext.request.contextPath}/user/create">用户新增</a><br/>
<table border="1" width="50%">
   <tr>
      <th>用户名</th>
      <th>真实姓名</th>
      <th>操做</th>
   </tr> 
   <c:forEach items="${userList}" var="user">
   <tr>
      <td>${user.username }</td>
      <td>${user.realname }</td>
      <td>
          <a href="${pageContext.request.contextPath}/user/update?username=${user.username}">更新</a>
          |
          <a href="${pageContext.request.contextPath}/user/delete?username=${user.username}">删除</a>
      </td>
   </tr>
   </c:forEach>   
</table>

3.二、update页面（WEB-INF/jsp/user/update.jsp）

<form action="${pageContext.request.contextPath}/user/update" method="post">
用户名： <input type="text" name="username" value="${command.username}"/><br/>
真实姓名：<input type="text" name="realname" value="${command.realname}"/><br/>
<input type="submit" value="更新"/>
</form>

四、测试：

默认的InternalPathMethodNameResolver将进行以下解析：

http://localhost:9080/springmvc-chapter4/user/list————>list方法名；

http://localhost:9080/springmvc-chapter4/user/create————>create方法名；

http://localhost:9080/springmvc-chapter4/user/update————>update功能处理方法名；

http://localhost:9080/springmvc-chapter4/user/delete————>delete功能处理方法名。

咱们能够将默认的InternalPathMethodNameResolver改成PropertiesMethodNameResolver：

<bean id="propertiesMethodNameResolver" 
class="org.springframework.web.servlet.mvc.multiaction.PropertiesMethodNameResolver">
    <property name="mappings">
        <props>
              <prop key="/user/create">create</prop>
              <prop key="<span style="font-size: 1em; line-height: 1.5;">/user/</span><span style="font-size: 1em; line-height: 1.5;">update">update</prop></span>
              <prop key="<span style="font-size: 1em; line-height: 1.5;">/user/</span><span style="font-size: 1em; line-height: 1.5;">delete">delete</prop></span>
              <prop key="<span style="font-size: 1em; line-height: 1.5;">/user/</span><span style="font-size: 1em; line-height: 1.5;">list">list</prop></span>
              <prop key="/**">list</prop><!-- 默认的行为 -->
          </props>
    </property>
    <property name="alwaysUseFullPath" value="false"/><!-- 不使用全路径 -->
</bean>   
<bean name="/user/**" class="cn.javass.chapter4.web.controller.UserController">
       <!—省略其余配置，详见配置文件-->
       <!-- 使用PropertiesMethodNameResolver来解析功能处理方法名 -->       
       <property name="methodNameResolver" ref="propertiesMethodNameResolver"/>
</bean>

/**表示默认解析到list功能处理方法。

如上配置方式能够很好的工做，但必须继承MultiActionController，Spring Web MVC提供给咱们无需继承MultiActionController实现方式，即便有委托对象方式，继续往下看吧。

委托方式实现

一、控制器UserDelegate

将UserController复制一份，更名为UserDelegate，并把继承MultiActionController去掉便可，其余无需改变。

二、spring配置文件chapter4-servlet.xml

<!—委托对象-->
<bean id="userDelegate" class="cn.javass.chapter4.web.controller.UserDelegate">
   <property name="userService" ref="userService"/>
   <property name="createView" value="user2/create"/>
   <property name="updateView" value="user2/update"/>
   <property name="deleteView" value="user2/delete"/>
   <property name="listView" value="user2/list"/>
   <property name="redirectToListView" value="redirect:/user2/list"/>
</bean>
<!—控制器对象-->
<bean name="/user2/**" 
class="org.springframework.web.servlet.mvc.multiaction.MultiActionController">
<property name="delegate" ref="userDelegate"/>
    <property name="methodNameResolver" ref="parameterMethodNameResolver"/>
</bean>

delegate：控制器对象经过delegate属性指定委托对象，即实际调用delegate委托对象的功能方法。

methodNameResolver：此处咱们使用ParameterMethodNameResolver解析器；

<!—ParameterMethodNameResolver -->
<bean id="parameterMethodNameResolver" 
class="org.springframework.web.servlet.mvc.multiaction.ParameterMethodNameResolver">
<!-- 一、根据请求参数名解析功能方法名 -->
    <property name="methodParamNames" value="create,update,delete"/>
    <!-- 二、根据请求参数名的值解析功能方法名 -->
    <property name="paramName" value="action"/>
<!-- 三、逻辑方法名到真实方法名的映射 -->
    <property name="logicalMappings">
       <props>
           <prop key="doList">list</prop>
       </props>
    </property>
    <!—四、默认执行的功能处理方法 -->
    <property name="defaultMethodName" value="list"/>
</bean>

一、methodParamNames：create,update,delete，当请求中有参数名为这三个的将被映射为功能方法名，如“<input type="submit" name="create" value="新增"/>”提交后解析获得的功能方法名为create;

二、paramName：当请求中有参数名为action，则将值映射为功能方法名，如“<input type="hidden" name="action" value="delete"/>”，提交后解析获得的功能方法名为delete；

三、logicalMappings：逻辑功能方法名到真实功能方法名的映射，如：

http://localhost:9080/springmvc-chapter4/user2?action=doList；

首先请求参数“action=doList”，则第二步解析获得逻辑功能方法名为doList；

本步骤会把doList再转换为真实的功能方法名list。

四、defaultMethodName：以上步骤若是没有解析到功能处理方法名，默认执行的方法名。

三、视图页面

3.一、list页面（WEB-INF/jsp/user2/list.jsp）

<a href="${pageContext.request.contextPath}/user2?action=create">用户新增</a><br/>
<table border="1" width="50%">
   <tr>
      <th>用户名</th>
      <th>真实姓名</th>
      <th>操做</th>
   </tr> 
   <c:forEach items="${userList}" var="user">
   <tr>
      <td>${user.username }</td>
      <td>${user.realname }</td>
      <td>
          <a href="${pageContext.request.contextPath}/user2?action=update&username=${user.username}">更新</a>
          |
          <a href="${pageContext.request.contextPath}/user2?action=delete&username=${user.username}">删除</a>
      </td>
   </tr>
   </c:forEach>   
</table>&nbsp;

3.二、update页面（WEB-INF/jsp/user2/update.jsp）

<form action="${pageContext.request.contextPath}/user2" method="post">
<input type="hidden" name="action" value="update"/>
用户名： <input type="text" name="username" value="${command.username}"/><br/>
真实姓名：<input type="text" name="realname" value="${command.realname}"/><br/>
<input type="submit" value="更新"/>
</form>&nbsp;
经过参数name="action" value="update"来指定要执行的功能方法名update。

3.三、create页面（WEB-INF/jsp/user2/create.jsp）

<form action="${pageContext.request.contextPath}/user2" method="post">
用户名： <input type="text" name="username" value="${command.username}"/><br/>
真实姓名：<input type="text" name="realname" value="${command.realname}"/><br/>
<input type="submit" name="create" value="新增"/>
</form>&nbsp;
经过参数name="create"来指定要执行的功能方法名create。

四、测试：

使用ParameterMethodNameResolver将进行以下解析：

http://localhost:9080/springmvc-chapter4/user2?create ————>create功能处理方法名（参数名映射）；

http://localhost:9080/springmvc-chapter4/user2?action=create————>create功能处理方法名（参数值映射）；

http://localhost:9080/springmvc-chapter4/user2?update ————>update功能处理方法名；

http://localhost:9080/springmvc-chapter4/user2?action=update————>update功能处理方法名；

http://localhost:9080/springmvc-chapter4/user2?delete ————>delete功能处理方法名；

http://localhost:9080/springmvc-chapter4/user2?action=delete————>delete功能处理方法名；

http://localhost:9080/springmvc-chapter4/user2?doList ————>经过logicalMappings解析为list功能处理方法。

http://localhost:9080/springmvc-chapter4/user2?action=doList————>经过logicalMappings解析为list功能处理方法。

http://localhost:9080/springmvc-chapter4/user2————>默认的功能处理方法名list（默认）。