本章講述Struts2的工作原理。
讀者如果曾經學習過Struts1.x或者有過Struts1.x的開發經驗，那麼千萬不要想當然地以爲這一章可以跳過。實際上Struts1.x與Struts2並無我們想象的血緣關係。雖然Struts2的開發小組極力保留Struts1.x的習慣，但因爲Struts2的核心設計完全改變，從思想到設計到工作流程，都有了很大的不同。
Struts2是Struts社區和WebWork社區的共同成果，我們甚至可以說，Struts2是WebWork的升級版，他採用的正是WebWork的核心，所以，Struts2並不是一個不成熟的產品，相反，構建在WebWork基礎之上的Struts2是一個運行穩定、性能優異、設計成熟的WEB框架。
本章主要對Struts的源代碼進行分析，因爲Struts2與WebWork的關係如此密不可分，因此，讀者需要下載xwork的源代碼，訪問http://www.opensymphony.com/xwork/download.action即可自行下載。
下載的Struts2源代碼文件是一個名叫struts-2.1.0-src.zip的壓縮包，裏面的目錄和文件非常多，讀者可以定位到struts-2.1.0-src\struts-2.0.10\src\core\src\main\java目錄下查看Struts2的源文件，如圖14所示。
（圖14）
Struts2框架的正常運行，除了佔核心地位的xwork的支持以外，Struts2本身也提供了許多類，這些類被分門別類組織到不同的包中。從源代碼中發現，基本上每一個Struts2類都訪問了WebWork提供的功能，從而也可以看出Struts2與WebWork千絲萬縷的聯繫。但無論如何，Struts2的核心功能比如將請求委託給哪個Action處理都是由xwork完成的，Struts2只是在WebWork的基礎上做了適當的簡化、加強和封裝，並少量保留Struts1.x中的習慣。
以下是對各包的簡要說明：
|
包名 |
說明 |
|
org.apache.struts2. components |
該包封裝視圖組件，Struts2在視圖組件上有了很大加強，不僅增加了組件的屬性個數，更新增了幾個非常有用的組件，如updownselect、doubleselect、datetimepicker、token、tree等。
另外，Struts2可視化視圖組件開始支持主題(theme)，缺省情況下，使用自帶的缺省主題，如果要自定義頁面效果，需要將組件的theme屬性設置爲simple。 |
|
org.apache.struts2. config |
該包定義與配置相關的接口和類。實際上，工程中的xml和properties文件的讀取和解析都是由WebWork完成的，Struts只做了少量的工作。 |
|
org.apache.struts2.dispatcher |
Struts2的核心包，最重要的類都放在該包中。 |
|
org.apache.struts2.impl |
該包只定義了3個類，他們是StrutsActionProxy、StrutsActionProxyFactory、StrutsObjectFactory，這三個類都是對xwork的擴展。 |
|
org.apache.struts2.interceptor |
定義內置的截攔器。 |
|
org.apache.struts2.util |
實用包。 |
|
org.apache.struts2.validators |
只定義了一個類：DWRValidator。 |
|
org.apache.struts2.views |
提供freemarker、jsp、velocity等不同類型的頁面呈現。 |
下表是對一些重要類的說明：
|
類名 |
說明 |
|
org.apache.struts2.dispatcher. Dispatcher |
該類有兩個作用： 1、初始化 2、調用指定的Action的execute()方法。 |
|
org.apache.struts2.dispatcher. FilterDispatcher |
這是一個過濾器。文檔中已明確說明，如果沒有經驗，配置時請將url-pattern的值設成/*。
該類有四個作用： 1、執行Action 2、清理ActionContext，避免內存泄漏 3、處理靜態內容（Serving static content） 4、爲請求啓動xwork’s的截攔器鏈。 |
|
com.opensymphony.xwork2. ActionProxy |
Action的代理接口。 |
|
com.opensymphony.xwork2. ctionProxyFactory |
生產ActionProxy的工廠。 |
|
com.opensymphony.xwork2.ActionInvocation |
負責調用Action和截攔器。 |
|
com.opensymphony.xwork2.config.providers. XmlConfigurationProvider |
負責Struts2的配置文件的解析。 |
三、 Struts2的工作機制
3.1 Struts2體系結構圖
Strut2的體系結構如圖15所示：
（圖15）
3.2 Struts2的工作機制
從圖15可以看出，一個請求在Struts2框架中的處理大概分爲以下幾個步驟：
1、客戶端初始化一個指向Servlet容器（例如Tomcat）的請求；
2、這個請求經過一系列的過濾器（Filter）（這些過濾器中有一個叫做ActionContextCleanUp的可選過濾器，這個過濾器對於Struts2和其他框架的集成很有幫助，例如：SiteMesh Plugin）；
3、接着FilterDispatcher被調用，FilterDispatcher詢問ActionMapper來決定這個請求是否需要調用某個Action；
4、如果ActionMapper決定需要調用某個Action，FilterDispatcher把請求的處理交給ActionProxy；
5、ActionProxy通過Configuration Manager詢問框架的配置文件，找到需要調用的Action類；
6、ActionProxy創建一個ActionInvocation的實例。
7、ActionInvocation實例使用命名模式來調用，在調用Action的過程前後，涉及到相關攔截器（Intercepter）的調用。
8、一旦Action執行完畢，ActionInvocation負責根據struts.xml中的配置找到對應的返回結果。返回結果通常是（但不總是，也可能是另外的一個Action鏈）一個需要被表示的JSP或者FreeMarker的模版。在表示的過程中可以使用Struts2 框架中繼承的標籤。在這個過程中需要涉及到ActionMapper。
注：以上步驟參拷至網上，具體網址已忘記。在此表示感謝！
3.3 Struts2源代碼分析
和Struts1.x不同，Struts2的啓動是通過FilterDispatcher過濾器實現的。下面是該過濾器在web.xml文件中的配置：
代碼清單6：web.xml（截取）
<filter>
<filter-name>struts2</filter-name>
<filter-class>
org.apache.struts2.dispatcher.FilterDispatcher
</filter-class>
</filter>
<filter-mapping>
<filter-name>struts2</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
Struts2建議，在對Struts2的配置尚不熟悉的情況下，將url-pattern配置爲/*，這樣該過濾器將截攔所有請求。
實際上，FilterDispatcher除了實現Filter接口以外，還實現了StrutsStatics接口，繼承代碼如下：
代碼清單7：FilterDispatcher結構
public class FilterDispatcher implements StrutsStatics, Filter {
}
StrutsStatics並沒有定義業務方法，只定義了若干個常量。Struts2對常用的接口進行了重新封裝，比如HttpServletRequest、HttpServletResponse、HttpServletContext等。 以下是StrutsStatics的定義：
代碼清單8：StrutsStatics.java
public interface StrutsStatics {
/**
* Constant for the HTTP request object.
*/
public static final String HTTP_REQUEST = "com.opensymphony.xwork2.dispatcher.HttpServletRequest";
/**
* Constant for the HTTP response object.
*/
public static final String HTTP_RESPONSE = "com.opensymphony.xwork2.dispatcher.HttpServletResponse";
/**
* Constant for an HTTP request dispatcher}.
*/
public static final String SERVLET_DISPATCHER = "com.opensymphony.xwork2.dispatcher.ServletDispatcher";
/**
* Constant for the servlet context} object.
*/
public static final String SERVLET_CONTEXT = "com.opensymphony.xwork2.dispatcher.ServletContext";
/**
* Constant for the JSP page context}.
*/
public static final String PAGE_CONTEXT = "com.opensymphony.xwork2.dispatcher.PageContext";
/** Constant for the PortletContext object */
public static final String STRUTS_PORTLET_CONTEXT = "struts.portlet.context";
}
容器啓動後，FilterDispatcher被實例化，調用init(FilterConfig filterConfig)方法。該方法創建Dispatcher類的對象，並且將FilterDispatcher配置的初始化參數傳到對象中（詳情請參考代碼清單10），並負責Action的執行。然後得到參數packages，值得注意的是，還有另外三個固定的包和該參數進行拼接，分別是org.apache.struts2.static、template、和org.apache.struts2.interceptor.debugging，中間用空格隔開，經過解析將包名變成路徑後存儲到一個名叫pathPrefixes的數組中，這些目錄中的文件會被自動搜尋。
代碼清單9：FilterDispatcher.init()方法
public void init(FilterConfig filterConfig) throws ServletException {
this.filterConfig = filterConfig;
dispatcher = createDispatcher(filterConfig);
dispatcher.init();
String param = filterConfig.getInitParameter("packages");
String packages = "org.apache.struts2.static template org.apache.struts2.interceptor.debugging";
if (param != null) {
packages = param + " " + packages;
}
this.pathPrefixes = parse(packages);
}
代碼清單10：FilterDispatcher.createDispatcher()方法
protected Dispatcher createDispatcher(FilterConfig filterConfig) {
Map<String,String> params = new HashMap<String,String>();
for (Enumeration e = filterConfig.getInitParameterNames(); e.hasMoreElements(); ) {
String name = (String) e.nextElement();
String value = filterConfig.getInitParameter(name);
params.put(name, value);
}
return new Dispatcher(filterConfig.getServletContext(), params);
}
當用戶向Struts2發送請求時，FilterDispatcher的doFilter()方法自動調用，這個方法非常關鍵。首先，Struts2對請求對象進行重新包裝，此次包裝根據請求內容的類型不同，返回不同的對象，如果爲multipart/form-data類型，則返回MultiPartRequestWrapper類型的對象，該對象服務於文件上傳，否則返回StrutsRequestWrapper類型的對象，MultiPartRequestWrapper是StrutsRequestWrapper的子類，而這兩個類都是HttpServletRequest接口的實現。包裝請求對象如代碼清單11所示：
代碼清單11：FilterDispatcher.prepareDispatcherAndWrapRequest()方法
protected HttpServletRequest prepareDispatcherAndWrapRequest(
HttpServletRequest request,
HttpServletResponse response) throws ServletException {
Dispatcher du = Dispatcher.getInstance();
if (du == null) {
Dispatcher.setInstance(dispatcher);
dispatcher.prepare(request, response);
} else {
dispatcher = du;
}
try {
request = dispatcher.wrapRequest(request, getServletContext());
} catch (IOException e) {
String message = "Could not wrap servlet request with MultipartRequestWrapper!";
LOG.error(message, e);
throw new ServletException(message, e);
}
return request;
}
request對象重新包裝後，通過ActionMapper的getMapping()方法得到請求的Action，Action的配置信息存儲在ActionMapping對象中，該語句如下：mapping = actionMapper.getMapping(request, dispatcher.getConfigurationManager());。下面是ActionMapping接口的實現類DefaultActionMapper的getMapping()方法的源代碼：
代碼清單12：DefaultActionMapper.getMapping()方法
public ActionMapping getMapping(HttpServletRequest request,
ConfigurationManager configManager) {
ActionMapping mapping = new ActionMapping();
String uri = getUri(request);//得到請求路徑的URI，如：testAtcion.action或testAction!method
uri = dropExtension(uri);//刪除擴展名，默認擴展名爲action，在代碼中的定義是List extensions = new ArrayList() {{ add("action");}};
if (uri == null) {
return null;
}
parseNameAndNamespace(uri, mapping, configManager);//從uri變量中解析出Action的name和namespace
handleSpecialParameters(request, mapping);//將請求參數中的重複項去掉
//如果Action的name沒有解析出來，直接返回
if (mapping.getName() == null) {
return null;
}
//下面處理形如testAction!method格式的請求路徑
if (allowDynamicMethodCalls) {
// handle "name!method" convention.
String name = mapping.getName();
int exclamation = name.lastIndexOf("!");//!是Action名稱和方法名的分隔符
if (exclamation != -1) {
mapping.setName(name.substring(0, exclamation));//提取左邊爲name
mapping.setMethod(name.substring(exclamation + 1));//提取右邊的method
}
}
return mapping;
}
該代碼的活動圖如下：
（圖16）
從代碼中看出，getMapping()方法返回ActionMapping類型的對象，該對象包含三個參數：Action的name、namespace和要調用的方法method。
如果getMapping()方法返回ActionMapping對象爲null，則FilterDispatcher認爲用戶請求不是Action，自然另當別論，FilterDispatcher會做一件非常有意思的事：如果請求以/struts開頭，會自動查找在web.xml文件中配置的packages初始化參數，就像下面這樣(注意粗斜體部分)：
代碼清單13：web.xml(部分)
<filter>
<filter-name>struts2</filter-name>
<filter-class>
org.apache.struts2.dispatcher.FilterDispatcher
</filter-class>
<init-param>
<param-name>packages</param-name>
<param-value>com.lizanhong.action</param-value>
</init-param>
</filter>
FilterDispatcher會將com.lizanhong.action包下的文件當作靜態資源處理，即直接在頁面上顯示文件內容，不過會忽略擴展名爲class的文件。比如在com.lizanhong.action包下有一個aaa.txt的文本文件，其內容爲“中華人民共和國”，訪問http://localhost:8081/Struts2Demo/struts/aaa.txt時會有如圖17的輸出：
（圖17）
