4.15、MultiActionController

之前學過的控制器如AbstractCommandController、SimpleFormController等一般對應一個功能處理方法（如新增），如果我要實現比如最簡單的使用者增刪改查（CRUD Create-Read-Update-Delete），那該怎麼辦呢？

 

4.15.1 解決方案

1、每一個功能對應一個控制器，如果是CRUD則需要四個控制器，但這樣我們的控制器會暴增，肯定不可取；

2、使用Spring Web MVC提供的MultiActionController，用於支援在一個控制器裡新增多個功能處理方法，即將多個請求的處理方法放置到一個控制器裡，這種方式不錯。

 

4.15.2 問題

1、  MultiActionController如何將不同的請求對映不同的請求的功能處理方法呢？

Spring Web MVC提供了MethodNameResolver（方法名解析器）用於解析當前請求到需要執行的功能處理方法的方法名。預設使用InternalPathMethodNameResolver實現類，另外還提供了ParameterMethodNameResolver和PropertiesMethodNameResolver，當然我們也可以自己來實現，稍候我們仔細研究下它們是如何工作的。

 

2、那我們的功能處理方法應該怎麼寫呢？

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

 

哦，原來如此，我們只需要按照如上格式寫我們的功能處理方法即可；此處需要注意一下幾點：

1、返回值：即模型和檢視部分；

ModelAndView：模型和檢視部分，之前已經見過了；

Map：只返回模型資料，邏輯檢視名會根據RequestToViewNameTranslator實現類來計算，稍候討論；

String：只返回邏輯檢視名；

void：表示該功能方法直接寫出response響應（如果其他返回值型別（如Map）返回null則和void進行相同的處理）；

2、actionName：功能方法名字；由methodNameResolver根據請求資訊解析功能方法名，通過反射呼叫；

3、形參列表：順序固定，“[]”表示可選，我們來看看幾個示例吧：

//表示到新增頁面

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提供了簡單的異常處理，即在請求的功能處理過程中遇到異常會交給異常處理方法進行處理，式如下所示：

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)

4.15.3 MultiActionController類實現

類定義：public class MultiActionController extends AbstractController implements LastModified ，繼承了AbstractController，並實現了LastModified介面，預設返回-1；

 

核心屬性：

delegate：功能處理的委託物件，即我們要呼叫請求處理方法所在的物件，預設是this；

methodNameResolver：功能處理方法名解析器，即根據請求資訊來解析需要執行的delegate的功能處理方法的方法名。

核心方法：

 

Java程式碼  

1. //判斷方法是否是功能處理方法  
2. private boolean isHandlerMethod(Method method) {  
3.     //得到方法返回值型別  
4.     Class returnType = method.getReturnType();  
5.     //返回值型別必須是ModelAndView、Map、String、void中的一種，否則不是功能處理方法  
6.     if (ModelAndView.class.equals(returnType) || Map.class.equals(returnType) || String.class.equals(returnType) ||  
7.             void.class.equals(returnType)) {  
8.         Class[] parameterTypes = method.getParameterTypes();  
9.         //功能處理方法引數個數必須>=2，且第一個是HttpServletRequest型別、第二個是HttpServletResponse  
10.         //且不能Controller介面的handleRequest(HttpServletRequest request, HttpServletResponse response)，這個方法是由系統呼叫  
11.         return (parameterTypes.length >= 2 &&  
12.                 HttpServletRequest.class.equals(parameterTypes[0]) &&  
13.                 HttpServletResponse.class.equals(parameterTypes[1]) &&  
14.                 !("handleRequest".equals(method.getName()) && parameterTypes.length == 2));  
15.     }  
16.     return false;  
17. }  

 

Java程式碼  

1. //是否是異常處理方法  
2. private boolean isExceptionHandlerMethod(Method method) {  
3.     //異常處理方法必須是功能處理方法 且 引數長度為3、第三個引數型別是Throwable子類  
4.     return (isHandlerMethod(method) &&  
5.             method.getParameterTypes().length == 3 &&  
6.             Throwable.class.isAssignableFrom(method.getParameterTypes()[2]));  
7. }  

Java程式碼  

1. private void registerHandlerMethods(Object delegate) {  
2.     //快取Map清空  
3.     this.handlerMethodMap.clear();  
4.     this.lastModifiedMethodMap.clear();  
5.     this.exceptionHandlerMap.clear();  
6.   
7.     //得到委託物件的所有public方法  
8.     Method[] methods = delegate.getClass().getMethods();  
9.     for (Method method : methods) {  
10.         //驗證是否是異常處理方法，如果是放入exceptionHandlerMap快取map  
11.         if (isExceptionHandlerMethod(method)) {  
12.             registerExceptionHandlerMethod(method);  
13.         }  
14.         //驗證是否是功能處理方法，如果是放入handlerMethodMap快取map  
15.         else if (isHandlerMethod(method)) {  
16.             registerHandlerMethod(method);  
17.             registerLastModifiedMethodIfExists(delegate, method);  
18.         }  
19.     }  
20. }  

Java程式碼  

1. protected ModelAndView handleRequestInternal(HttpServletRequest request, HttpServletResponse response)  
2.         throws Exception {  
3.     try {  
4.         //1、使用methodNameResolver 方法名解析器根據請求解析到要執行的功能方法的方法名  
5.         String methodName = this.methodNameResolver.getHandlerMethodName(request);  
6.         //2、呼叫功能方法（通過反射呼叫，此處就貼上程式碼了）  
7.         return invokeNamedMethod(methodName, request, response);  
8.     }  
9.     catch (NoSuchRequestHandlingMethodException ex) {  
10.         return handleNoSuchRequestHandlingMethod(ex, request, response);  
11.     }  
12. }  

 

接下來，我們看一下MultiActionController如何使用MethodNameResolver來解析請求到功能處理方法的方法名。

4.15.4 MethodNameResolver

1、InternalPathMethodNameResolver：MultiActionController的預設實現，提供從請求URL路徑解析功能方法的方法名，從請求的最後一個路徑（/）開始，並忽略副檔名；如請求URL是“/user/list.html”，則解析的功能處理方法名為“list”，即呼叫list方法。該解析器還可以指定字首和字尾，通過prefix和suffix屬性，如指定prefix=”test_”,則功能方法名將變為test_list；

 

2、ParameterMethodNameResolver：提供從請求引數解析功能處理方法的方法名，並按照如下順序進行解析：

（1、 methodParamNames：根據請求的引數名解析功能方法名（功能方法名和引數名同名）；

Java程式碼  

1. <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”進行匹配。

 

Java程式碼  

1. for (String suffix : SUBMIT_IMAGE_SUFFIXES)  {//SUBMIT_IMAGE_SUFFIXES {“.x”, “.y”}  
2.     if (request.getParameter(name + suffix) != null) {// name是我們配置的methodParamNames  
3.         return true;  
4.     }  
5. }  

 

（2、paramName：根據請求引數名的值解析功能方法名，預設的引數名是action，即請求的引數中含有“action=query”，則功能處理方法名為query；

（3、logicalMappings：邏輯功能方法名到真實功能方法名對映，如下所示：

Java程式碼  

1. <property name="logicalMappings">  
2.     <props>  
3.         <prop key="doList">list</prop>  
4.     </props>  
5. </property>  

  即如果步驟1或2解析出邏輯功能方法名為doList（邏輯的），將會被重新對映為list功能方法名（真正執行的）。

（4、defaultMethodName：預設的方法名，當以上策略失敗時預設呼叫的方法名。

 

3、PropertiesMethodNameResolver：提供自定義的從請求URL解析功能方法的方法名，使用一組使用者自定義的模式到功能方法名的對映，對映使用Properties物件存放，具體配置示例如下：

Java程式碼  

1. <bean id="propertiesMethodNameResolver"   
2. class="org.springframework.web.servlet.mvc.multiaction.PropertiesMethodNameResolver">  
3.     <property name="mappings">  
4.         <props>  
5.               <prop key="/create">create</prop>  
6.               <prop key="/update">update</prop>  
7.               <prop key="/delete">delete</prop>  
8.               <prop key="/list">list</prop>  
9.               <!-- 預設的行為 -->  
10.               <prop key="/**">list</prop>  
11.         </props>  
12.     </property>  
13. </bean>   

對於/create請求將呼叫create方法，Spring內部使用PathMatcher進行匹配（預設實現是AntPathMatcher）。

4.15.5 RequestToViewNameTranslator

用於直接將請求轉換為邏輯檢視名。預設實現為DefaultRequestToViewNameTranslator。

 

1、DefaultRequestToViewNameTranslator：將請求URL轉換為邏輯檢視名，預設規則如下：

  http://localhost:9080/web上下文/list -------> 邏輯檢視名為list

  http://localhost:9080/web上下文/list.html -------> 邏輯檢視名為list(預設刪除副檔名)

  http://localhost:9080/web上下文/user/list.html -------> 邏輯檢視名為user/list

4.15.6 示例

（1、控制器UserController

Java程式碼  

1. package cn.javass.chapter4.web.controller;  
2. //省略import  
3. public class UserController extends MultiActionController {  
4.     //使用者服務類  
5.     private UserService userService;  
6.     //邏輯檢視名 通過依賴注入方式注入，可配置  
7.     private String createView;  
8.     private String updateView;  
9.     private String deleteView;  
10.     private String listView;  
11.     private String redirectToListView;  
12.     //省略setter/getter  
13.   
14.     public String create(HttpServletRequest request, HttpServletResponse response, UserModel user) {  
15.         if("GET".equals(request.getMethod())) {  
16.             //如果是get請求 我們轉向 新增頁面  
17.             return getCreateView();  
18.         }  
19.         userService.create(user);  
20.         //直接重定向到列表頁面  
21.         return getRedirectToListView();  
22.     }  
23.     public ModelAndView update(HttpServletRequest request, HttpServletResponse response, UserModel user) {  
24.         if("GET".equals(request.getMethod())) {  
25.             //如果是get請求 我們轉向更新頁面  
26.             ModelAndView mv = new ModelAndView();  
27.             //查詢要更新的資料  
28.             mv.addObject("command", userService.get(user.getUsername()));  
29.             mv.setViewName(getUpdateView());  
30.             return mv;  
31.         }  
32.         userService.update(user);  
33.         //直接重定向到列表頁面  
34.         return new ModelAndView(getRedirectToListView());  
35.     }  
36.   
37.       
38.     public ModelAndView delete(HttpServletRequest request, HttpServletResponse response, UserModel user) {  
39.         if("GET".equals(request.getMethod())) {  
40.             //如果是get請求 我們轉向刪除頁面  
41.             ModelAndView mv = new ModelAndView();  
42.             //查詢要刪除的資料  
43.             mv.addObject("command", userService.get(user.getUsername()));  
44.             mv.setViewName(getDeleteView());  
45.             return mv;  
46.         }  
47.         userService.delete(user);  
48.         //直接重定向到列表頁面  
49.         return new ModelAndView(getRedirectToListView());  
50.     }     
51.       
52.     public ModelAndView list(HttpServletRequest request, HttpServletResponse response) {  
53.         ModelAndView mv = new ModelAndView();  
54.         mv.addObject("userList", userService.list());  
55.         mv.setViewName(getListView());  
56.         return mv;  
57.     }  
58.       
59.     //如果使用委託方式，命令物件名稱只能是command  
60.     protected String getCommandName(Object command) {  
61.         //命令物件的名字 預設command  
62.         return "command";  
63.     }  
64. }  

  增刪改：如果是GET請求方法，則表示到展示頁面，POST請求方法表示真正的功能操作；

  getCommandName：表示是命令物件名字，預設command，對於委託物件實現方式無法改變，因此我們就使用預設的吧。

 

（2、spring配置檔案chapter4-servlet.xml

 

Java程式碼  

1. <bean id="userService" class="cn.javass.chapter4.service.UserService"/>  
2. <bean name="/user/**" class="cn.javass.chapter4.web.controller.UserController">  
3.     <property name="userService" ref="userService"/>  
4.     <property name="createView" value="user/create"/>  
5.     <property name="updateView" value="user/update"/>  
6.     <property name="deleteView" value="user/delete"/>  
7.     <property name="listView" value="user/list"/>  
8.     <property name="redirectToListView" value="redirect:/user/list"/>  
9.     <!-- 使用PropertiesMethodNameResolver來解析功能處理方法名 -->         
10.     <!--property name="methodNameResolver" ref="propertiesMethodNameResolver"/-->  
11. </bean>  

 

  userService：使用者服務類，實現業務邏輯；

  依賴注入：對於邏輯檢視頁面通過依賴注入方式注入，redirectToListView表示增刪改成功後重定向的頁面，防止重複表單提交；

  預設使用InternalPathMethodNameResolver解析請求URL到功能方法名。

 

（3、檢視頁面

（3.1、list頁面（WEB-INF/jsp/user/list.jsp）

 

Java程式碼  

1. <a href="${pageContext.request.contextPath}/user/create">使用者新增</a><br/>  
2. <table border="1" width="50%">  
3.    <tr>  
4.       <th>使用者名稱</th>  
5.       <th>真實姓名</th>  
6.       <th>操作</th>  
7.    </tr>   
8.    <c:forEach items="${userList}" var="user">  
9.    <tr>  
10.       <td>${user.username }</td>  
11.       <td>${user.realname }</td>  
12.       <td>  
13.           <a href="${pageContext.request.contextPath}/user/update?username=${user.username}">更新</a>  
14.           |  
15.           <a href="${pageContext.request.contextPath}/user/delete?username=${user.username}">刪除</a>  
16.       </td>  
17.    </tr>  
18.    </c:forEach>     
19. </table>  

 

（3.2、update頁面（WEB-INF/jsp/user/update.jsp）

Java程式碼  

1. <form action="${pageContext.request.contextPath}/user/update" method="post">  
2. 使用者名稱： <input type="text" name="username" value="${command.username}"/><br/>  
3. 真實姓名：<input type="text" name="realname" value="${command.realname}"/><br/>  
4. <input type="submit" value="更新"/>  
5. </form>  

（4、測試：

預設的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：

 

Java程式碼  

1. <bean id="propertiesMethodNameResolver"   
2. class="org.springframework.web.servlet.mvc.multiaction.PropertiesMethodNameResolver">  
3.     <property name="mappings">  
4.         <props>  
5.               <prop key="/user/create">create</prop>  
6.               <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>  
7.               <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>  
8.               <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>  
9.               <prop key="/**">list</prop><!-- 預設的行為 -->  
10.           </props>  
11.     </property>  
12.     <property name="alwaysUseFullPath" value="false"/><!-- 不使用全路徑 -->  
13. </bean>     
14. <bean name="/user/**" class="cn.javass.chapter4.web.controller.UserController">  
15.        <!—省略其他配置，詳見配置檔案-->  
16.        <!-- 使用PropertiesMethodNameResolver來解析功能處理方法名 -->         
17.        <property name="methodNameResolver" ref="propertiesMethodNameResolver"/>  
18. </bean>   

 

 /**表示預設解析到list功能處理方法。

如上配置方式可以很好的工作，但必須繼承MultiActionController，Spring Web MVC提供給我們無需繼承MultiActionController實現方式，即使有委託物件方式，繼續往下看吧。

4.15.7、委託方式實現

（1、控制器UserDelegate

   將UserController複製一份，改名為UserDelegate，並把繼承MultiActionController去掉即可，其他無需改變。

（2、spring配置檔案chapter4-servlet.xml 

Java程式碼  

1. <!—委託物件-->  
2. <bean id="userDelegate" class="cn.javass.chapter4.web.controller.UserDelegate">  
3.    <property name="userService" ref="userService"/>  
4.    <property name="createView" value="user2/create"/>  
5.    <property name="updateView" value="user2/update"/>  
6.    <property name="deleteView" value="user2/delete"/>  
7.    <property name="listView" value="user2/list"/>  
8.    <property name="redirectToListView" value="redirect:/user2/list"/>  
9. </bean>  
10. <!—控制器物件-->  
11. <bean name="/user2/**"   
12. class="org.springframework.web.servlet.mvc.multiaction.MultiActionController">  
13. <property name="delegate" ref="userDelegate"/>  
14.     <property name="methodNameResolver" ref="parameterMethodNameResolver"/>  
15. </bean>  

 delegate：控制器物件通過delegate屬性指定委託物件，即實際呼叫delegate委託物件的功能方法。

 methodNameResolver：此處我們使用ParameterMethodNameResolver解析器；

Java程式碼  

1. <!—ParameterMethodNameResolver -->  
2. <bean id="parameterMethodNameResolver"   
3. class="org.springframework.web.servlet.mvc.multiaction.ParameterMethodNameResolver">  
4. <!-- 1、根據請求引數名解析功能方法名 -->  
5.     <property name="methodParamNames" value="create,update,delete"/>  
6.     <!-- 2、根據請求引數名的值解析功能方法名 -->  
7.     <property name="paramName" value="action"/>  
8. <!-- 3、邏輯方法名到真實方法名的對映 -->  
9.     <property name="logicalMappings">  
10.        <props>  
11.            <prop key="doList">list</prop>  
12.        </props>  
13.     </property>  
14.     <!—4、預設執行的功能處理方法 -->  
15.     <property name="defaultMethodName" value="list"/>  
16. </bean>     

1、methodParamNames：create,update,delete，當請求中有引數名為這三個的將被對映為功能方法名，如“<input type="submit" name="create" value="新增"/>”提交後解析得到的功能方法名為create;

2、paramName：當請求中有引數名為action，則將值對映為功能方法名，如“<input type="hidden" name="action" value="delete"/>”，提交後解析得到的功能方法名為delete；

3、logicalMappings：邏輯功能方法名到真實功能方法名的對映，如：

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

    首先請求引數“action=doList”，則第二步解析得到邏輯功能方法名為doList；

    本步驟會把doList再轉換為真實的功能方法名list。

4、defaultMethodName：以上步驟如果沒有解析到功能處理方法名，預設執行的方法名。

 

（3、檢視頁面

（3.1、list頁面（WEB-INF/jsp/user2/list.jsp）

Java程式碼  

1. <a href="${pageContext.request.contextPath}/user2?action=create">使用者新增</a><br/>  
2. <table border="1" width="50%">  
3.    <tr>  
4.       <th>使用者名稱</th>  
5.       <th>真實姓名</th>  
6.       <th>操作</th>  
7.    </tr>   
8.    <c:forEach items="${userList}" var="user">  
9.    <tr>  
10.       <td>${user.username }</td>  
11.       <td>${user.realname }</td>  
12.       <td>  
13.           <a href="${pageContext.request.contextPath}/user2?action=update&username=${user.username}">更新</a>  
14.           |  
15.           <a href="${pageContext.request.contextPath}/user2?action=delete&username=${user.username}">刪除</a>  
16.       </td>  
17.    </tr>  
18.    </c:forEach>     
19. </table>   

（3.2、update頁面（WEB-INF/jsp/user2/update.jsp）

Java程式碼  

1. <form action="${pageContext.request.contextPath}/user2" method="post">  
2. <input type="hidden" name="action" value="update"/>  
3. 使用者名稱： <input type="text" name="username" value="${command.username}"/><br/>  
4. 真實姓名：<input type="text" name="realname" value="${command.realname}"/><br/>  
5. <input type="submit" value="更新"/>  
6. </form>   

  通過引數name="action" value="update"來指定要執行的功能方法名update。

 

（3.3、create頁面（WEB-INF/jsp/user2/create.jsp）

Java程式碼  

1. <form action="${pageContext.request.contextPath}/user2" method="post">  
2. 使用者名稱： <input type="text" name="username" value="${command.username}"/><br/>  
3. 真實姓名：<input type="text" name="realname" value="${command.realname}"/><br/>  
4. <input type="submit" name="create" value="新增"/>  
5. </form>   

  通過引數name="create"來指定要執行的功能方法名create。

（4、測試：

使用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（預設）。