码农小汪-Spring-MVC 控制器4

MultiActionController

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

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

MultiActionController如何将不同的请求映射不同的请求的功能处理方法呢？

Spring Web MVC提供了MethodNameResolver（方法名解析器）用于解析当前请求到需要执行的功能处理方法的方法名。默认使用InternalPathMethodNameResolver实现类
另外还提供了ParameterMethodNameResolver和PropertiesMethodNameResolver，当然我们也可以自己来实现

那我们的功能处理方法应该怎么写呢？

public (ModelAndView | Map | String | void) actionName(HttpServletRequest request, HttpServletResponse response, [, HttpSession session ] [,AnyObject]);

哦，原来如此，我们只需要按照如上格式写我们的功能处理方法即可；此处需要注意一下几点：

1. 返回值：即模型和视图部分、
   ModelAndView：模型和视图部分，之前已经见过了；
   Map：只返回模型数据，逻辑视图名会根据RequestToViewNameTranslator实现类来计算，稍候讨论；
   String：只返回逻辑视图名；
   void：表示该功能方法直接写出response响应（如果其他返回值类型（如Map）返回null则和void进行相同的处理）；
   
   1. actionName：功能方法名字；由methodNameResolver根据请求信息解析功能方法名，通过反射调用；
   2. 形参列表：顺序固定，“[]”表示可选，我们来看看几个示例吧：

//表示到新增页面
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)
4. 异常处理方法，MultiActionController
MultiActionController提供了简单的异常处理，即在请求的功能处理过程中遇到异常会交给异常处理方法进行处理，式如下所示：
public ModelAndView anyMeaningfulName(HttpServletRequest request, HttpServletResponse response, ExceptionClass exception)

/处理PayException
public ModelAndView processPayException(HttpServletRequest request, HttpServletResponse response, PayException ex)
//处理Exception
public ModelAndView processException(HttpServletRequest request, HttpServletResponse response, Exception ex)
5. 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) { //异常处理方法必须是功能处理方法 且 参数长度为3、第三个参数类型是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 {
        //1、使用methodNameResolver 方法名解析器根据请求解析到要执行的功能方法的方法名
        String methodName = this.methodNameResolver.getHandlerMethodName(request);
        //2、调用功能方法（通过反射调用，此处就粘贴代码了）
        return invokeNamedMethod(methodName, request, response);
    }
    catch (NoSuchRequestHandlingMethodException ex) {
        return handleNoSuchRequestHandlingMethod(ex, request, response);
    }
}

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

MethodNameResolver

1. InternalPathMethodNameResolver
   MultiActionController的默认实现，提供从请求URL路径.解析功能方法的方法名，从请求的最后一个路径（/）开始，并忽略扩展名；如请求URL是“/user/list.html”，则解析的功能处理方法名为“list”，即调用list方法。该解析器还可以指定前缀和后
   缀，通过prefix和suffix属性，如指定prefix=”test_”,则功能方法名将变为test_list；
2. ParameterMethodNameResolver
   提供从请求参数解析功能处理方法的方法名，并按照如下顺序进行解析：
   （methodParamNames：根据请求的参数名解析功能方法名（功能方法名和参数名同名）

<property name="methodParamNames" value="list,create,update"/>         

paramName根据请求参数名的值解析功能方法名，默认的参数名是action，即请求的参数中含有
“action=query”，则功能处理方法名为query；
3. 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>

用于直接将请求转换为逻辑视图名。默认实现为DefaultRequestToViewNameTranslator。
DefaultRequestToViewNameTranslator：将请求URL转换为逻辑视图名，默认规则如下：
http://localhost:9080/web上下文/list ——-> 逻辑视图名为list
http://localhost:9080/web上下文/list.html ——-> 逻辑视图名为list(默认删除扩展名)
http://localhost:9080/web上下文/user/list.html ——-> 逻辑视图名为user/li

列子哦~
控制器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";
    }
}

spring配置文件chapter4-servlet.xml
http://jinnianshilongnian.iteye.com/blog/1630585

   <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>

默认的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功能处理方法名。