MultiActionController與ParameterMethodNameResolver


如 果您的應用程式的規模越來越大,若您為每一個請求的處理撰寫一個Controller類別,很快的,您發現到Web應用程式中有越來越多的 Controller類別,而事實上當中的一些職責是可以組織在一個類別,例如與資料庫操作相關的list()、add()、delete()等方法,就 可以組織在一個類別來加以管理。

您可以使用AbstractController類別的一個子類別: org.springframework.web.servlet.mvc.multiaction.MultiActionController。它可 以讓您在一個Controller類別中定義多個方法,並根據使用者的請求來呼叫當中的某個方法來執行。

要使用MultiActionController,您要配合一個 org.springframework.web.servlet.mvc.multiaction.MethodNameResolver的實例, MultiActionController預設使用的MethodNameResolver類別是 org.springframework.web.servlet.mvc.multiaction.InternalPathMethodNameResolver, 這個類別可以根據您所給的網址最後的檔案名稱來判斷要執行Controller中的哪一個方法,例如若請求的/test.do的請求會執行test (HttpServletRequest, HttpServletResponse)方法,但通常不會使用InternalPathMethodNameResolver,因為這就失去了使用 MultiActionController的一些優點,像是依使用者所附帶的請求參數來決定所要呼叫的方法。

通常在使用MultiActionController時會搭配使用 org.springframework.web.servlet.mvc.multiaction.ParameterMethodNameResolver 或是 org.springframework.web.servlet.mvc.multiaction.PropertiesMethodNameResolver, 兩個類別都是根據一個請求參數,以參數來決定要執行Controller類別中的哪一個方法,這邊先以 ParameterMethodNameResolver為例,例如可以在Bean定義檔中這麼撰寫:
  • mvc-config.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC
"-//SPRING/DTD BEAN/EN"
"http://www.springframework.org/dtd/spring-beans.dtd">

<beans>
<bean id="urlMapping"
class="org.springframework.web.servlet.
→ handler.SimpleUrlHandlerMapping">
<property name="mappings">
<props>
<prop key="/book.do">bookController</prop>
</props>
</property>
</bean>

<bean id="viewResolver"
class="org.springframework.web.servlet.
→ view.InternalResourceViewResolver">
<property name="prefix">
<value>/WEB-INF/jsp/</value>
</property>
<property name="suffix">
<value>.jsp</value>
</property>
</bean>

<bean id="paraMethodResolver"
class="org.springframework.web.servlet.mvc.
→ multiaction.ParameterMethodNameResolver">
<property name="paramName">
<value>action</value>
</property>
<property name="defaultMethodName">
<value>list</value>
</property>
</bean>

<bean id="bookController"
class="onlyfun.caterpillar.BookController">
<property name="methodNameResolver">
<ref bean="paraMethodResolver"/>
</property>
<property name="testPage">
<value>test</value>
</property>
</bean>
</beans>

在paraMethodResolver的Bean定義中,使用"paramName"屬性定義在HTTP請求中使用"action"參數來指定所要呼叫 的方法,若是請求中沒有指定"action"參數,則會使用"defaultMethodName"屬性所指定的方法,這邊指定的是list()方法。

BookController是個繼承MultiActionController的類別,當中可以定義在"action"參數指定下所要呼叫的方法,例如:
  • BookController.java
package onlyfun.caterpillar; 

import javax.servlet.http.*;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.
multiaction.MultiActionController;


public class BookController extends MultiActionController {
private String testPage;

public ModelAndView list(HttpServletRequest req,
HttpServletResponse res) {
return new ModelAndView(
this.getTestPage(),"executed", "list");
}

public ModelAndView add(HttpServletRequest req,
HttpServletResponse res) {
return new ModelAndView(
this.getTestPage(),"executed", "add");
}

public ModelAndView delete(HttpServletRequest req,
HttpServletResponse res) {
return new ModelAndView(
this.getTestPage(),"executed", "delete");
}

public String getTestPage() {
return testPage;
}

public void setTestPage(String testPage) {
this.testPage = testPage;
}
}

注意到在定義的方法中,必須包括HttpServletRequest與HttpServletResponse的參數,您也可以使用帶有第三個參數HttpSession的版本。

以上所定義的BookController類別只是一個簡單的範例,用於測試MultiActionController的運作,它所作的處理只是設定一個字串,表示目前所執行的方法名稱,可以設計一個測試用的JSP網頁,用以顯示使用者所請求的方法,例如:
  • test.jsp
<%@page contentType="text/html"%>
<%@page pageEncoding="UTF-8"%>

<html>
<head>
<meta http-equiv="Content-Type"
content="text/html; charset=UTF-8">
<title>MultiAction Test Page</title>
</head>
<body>
<H1> "\${executed}" method is executed.</H1>
</body>
</html>