struts2筆記 - 配置

與Struts 1.X不同，Struts2引入了WebWork的配置機制，在很大程度上提高了配置的靈活度。通過使用配置可以配置如下內容：

配置類型 配置文件 Struts2 參數配置 struts.properties Struts2 Action 配置 struts.xml Struts2 Result 配置 struts.xml Struts2 Exception Handling 配置 struts.xml Struts2 Intercept 配置 struts.xml Struts2 多配置文件 struts.xml

struts.properties文件在WEB-INF/classes目錄下存放。

這個文件用來配置Struts2系統的一些基本規約，所有在struts.properties中配置的內容都可以在struts.xml中配置，或者web.xml中在struts2 filter中配置，例如：

Struts.properties中的如下配置：

struts.i18n.encoding=UTF-8

相當於struts.xml中的如下配置：

<constant name=“struts.i18n.encoding” value=“true” />

相當於web.xml中的如下配置：

<filter>
　 <filter-name>struts</filter-name>
　　<filter-class>org.apache.struts2.dispatcher.FilterDispatcher</filter-class>
　　<init-param>
　　　　<param-name>struts.i18n.encoding</param-name>
　　　　<param-value>true</param-value>
　　</init-param>
</filter>

Package配置

使用package可以將邏輯上相關的一組Action，Result，Intercepter等組件分為一組，Package有些想對象，可以繼承其他的Package，也可以被其他package繼承，甚至可以定義抽象的Package。

Package的可以使用的屬性：

屬性 是否必須 說明 name 是 Package的表示，為了讓其他的package引用 extends 否 從哪個package集成行為 namespace 否 參考Namespace配置說明
@TODO Namespace配置說明 abstract 否 定義這個package為抽象的，這個package中不需要定義action

由於struts.xml文件是自上而下解析的，所以被集成的package要放在集成package的前邊。

Namespace配置

Namespace將action分成邏輯上的不同模塊，每一個模塊有自己獨立的前綴。使用namespace可以有效的避免action重名的沖突，例如每一個package都可以有自己獨立的Menu和Help action，但是事項方式各有不同。Struts2標簽帶有namespace選項，可以根據namespace的不同向服務器提交不同的package的action的請求。

“/”表示跟namespace，所有直接在應用程序上下文環境下的請求（Context）都在這個package中查找。

“”表示默認namespace，當所有的namespace中都找不到的時候就在這個namespace中尋找，例如我們上面的login應用程序。

例如，有如下配置：

<package name="default">
<action name="foo" class="mypackage.simpleAction>
　　　　<result name="success" type="dispatcher">
　　　 　　greeting.jsp
　　　 </result>
　　</action>
　　<action name="bar" class="mypackage.simpleAction">
　　　 <result name="success" type="dispatcher">bar1.jsp</result>
　　</action>
</package>
<package name="mypackage1" namespace="/">
　　<action name="moo" class="mypackage.simpleAction">
　　　　<result name="success" type="dispatcher">moo.jsp</result>
　　</action>
</package>
<package name="mypackage2" namespace="/barspace">
　　<action name="bar" class="mypackage.simpleAction">
　　　 <result name="success" type="dispatcher">bar2.jsp</result>
　　</action>
</package>

1 如果請求為/barspace/bar.action

查找namespace/barspace，如果找到bar則執行對應的action，否則將會查找默認的namespace，在上面的例子中，在barspace中存在名字位bar的action，所以這個action將會被執行，如果返回結果為success，則畫面將定為到bar2.jsp

2 如果請求為/ moo.action

根namespace（'/'）被查找，如果moo action存在則執行否則查詢默認的namespace，上面的例子中，根namespace中存在moo action，所以改action被調用，返回success的情況下畫面將定位到moo.jsp

Action配置

在struts2框架中每一個Action是一個工作單元。Action負責將一個請求對應到一個Action處理上去，每當一個Action類匹配一個請求的時候，這個Action類就會被Struts2框架調用。

一個Action配置示例：

<action name="Logon" class="tutorial.Logon">
<result type="redirect-action">Menu</result>
<result name="input">/tutorial/Logon.jsp</result>
</action>

每一個Action可以配置多個result，多個ExceptionHandler，多個Intercepter，但是只能有一個name，這個name和package的namespace來唯一區別一個Action。

每當struts2框架接受到一個請求的時候，他會去掉Host，Application和後綴等信息，得到Action的名字，例如如下的請求將得到Welcome這個Action。

http://www.planetstruts.org/struts2-mailreader/Welcome.action

在一個Struts2應用程序中，一個指向Action的鏈接通常有Struts Tag產生，這個Tag只需要指定Action的名字，Struts框架會自動添加諸如後綴等的擴展，例如：

<s:form action="Hello">
　　<s:textfield label="Please enter your name" name="name"/>
　　<s:submit/>
</s:form>

將產生一個如下的鏈接的請求:

http://Hostname:post/appname/Hello.action

在定義Action的名字的時候不要使用.和/來明明，最好使用英文字母和下劃線。

Action中的方法

Action的默認入口方法由xwork2的Action接口來定義，代碼清單為：

public interface Action {
　　public String execute() throws Exception;
}

有些時候我們想指定一個Action的多個方法，我們可以做如下兩步：

<!--[if !supportLists]-->1　　<!--[endif]-->建立一些execute簽名相同的方法，例如：

Public String forward() throws Exception

<!--[if !supportLists]-->2　　<!--[endif]-->在Action配置的時候使用method屬性，例如：

<action name="delete" class="example.CrudAction" method="delete">

Action中的方法通配符

有些時候對Action中方法的調用滿足一定的規律，例如edit Action對應edit方法，delete Action對應 delete方法，這個時候我們可以使用方法通配符，例如：

<action name="*Crud" class="example.Crud" method="{1}">

這時，editCrud Action的引用將調用edit方法，同理，deleteCrud Action的引用將調用delete 方法。

另外一種比較常用的方式是使用下劃線分割，例如：

<action name="Crud_*" class="example.Crud" method="{1}">

這樣當遇到如下調用的時候可以找到對應的方法。

"action=Crud_input" =>input方法

"action=Crud_delete"　=>delete方法

通配符和普通的配置具有相同的地位，可以結合使用框架的所有其他功能。

默認的Action

當我們沒有指定Action的class屬性的時候，例如：

<action name="Hello">

我們默認使用com.opensymphony.xwork.ActionSupport

ActionSupport有兩個方法input和execute，每個方法都是簡單的返回SUCCESS。

Post-Back Action

可以使用如下畫面達到字畫面刷新的效果

<s:form>
　　<s:textfield label="Please enter your name" name="name"/>
　　<s:submit/>
</s:form>

默認Action

通常情況下，請求的Action不存在的情況下，Struts2框架會返回一個Error畫面：“404 - Page not found”，有些時候或許我們不想出現一個控制之外的錯誤畫面，我們可以指定一個默認的Action，在請求的Action不存在的情況下，調用默認的Action，通過如下配置可以達到要求：

<package name="Hello" extends="action-default">
<default-action-ref name="UnderConstruction">
<action name="UnderConstruction">
<result>/UnderConstruction.jsp</result>
</action>"

默認通配符

<action name="*" >
<result>/{1}.jsp</result>
</action>

每個Action將會被映射到以自己名字明明的JSP上。

Result配置

Action裡提供了五個默認的返回值：

String SUCCESS = "success";
String NONE　　= "none";
String ERROR　 = "error";
String INPUT　 = "input";
String LOGIN　 = "login";

默認的一些配置

在package下有如下配置

<result-types>
<result-type name="dispatcher"
class="org.apache.struts2.dispatcher.ServletDispatcherResult"
　　default="true" />
</result-types>

如果一個Result的type沒有設定的話，默認為dispthcher。Dispatcher的意思是轉向一個JSP等的資源。

另外如果Result的name沒有設定的話，默認為SUCCESS。

一個完整的Result的聲明如下：

<result name="success" type="dispatcher">
　　<param name="location">/ThankYou.jsp</param>
</result>

考慮到默認值可以寫成：

<result>
　　<param name="location">/ThankYou.jsp</param>
</result>

另外也可以簡寫為：

<result>/ThankYou.jsp</result>

另外為了方便，可以在package中設置一些全局的result，例如：

<global-results>
<result name="error">/Error.jsp</result>
<result name="invalid.token">/Error.jsp</result>
<result name="login" type="redirect-action">Logon_input</result>
</global-results>

動態結果

有些時候，在Action執行完畢之後才知道Result的指向，可以使用如下的方法：

Action
private String nextAction;
public String getNextAction() {
　　return nextAction;
}
public String execute() throws Exception {
return “next”;
}

struts.xml

<action name="fragment" class="FragmentAction">
<result name="next" type="redirect-action">${nextAction}</result>
</action>

3.4節 ActionSupport

Action類不一定非要實現Action接口或者集成ActionSupport類，也就是說Action可以是一個POJO對象，只不過提供一個返回String的方法。如果Action類不實現Action接口，也不從ActionSupport集成，則Struts框架通過Java的反射機制（Reflection）來調用Action類中的處理方法。

Action類的處理方法需要滿足以下要求

1 public

2 返回String，框架根據返回值決定遷移的目的

3 （可選）拋出Exception，讓Struts框架統一處理異常

3.5節 Exception Handling

Struts可以以聲明的方式處理Action類拋出的異常。以聲明的方式處理是指：所有的Action類的處理方法拋出的Exception會被框架統一處理，之後定向到預先定義的Result。處理這些異常的Action，Result等可以動態的配置。

Struts2自帶一個默認的配置：struts-default.xml，在這個文件中預先定義了一些基本的操作，其中Exception Handling也在其中，參看下述代碼：

...
<interceptors>
　　...
　　<interceptor name="exception"
　　　　　class="com.opensymphony.xwork.interceptor.ExceptionMappingInterceptor"/>
　　...
</interceptors>
<interceptor-stack name="defaultStack">
　　<interceptor-ref name="exception"/>
　　<interceptor-ref name="alias"/>
　　<interceptor-ref name="servlet-config"/>
　　<interceptor-ref name="prepare"/>
　　<interceptor-ref name="i18n"/>
　　<interceptor-ref name="chain"/>
　　<interceptor-ref name="debugging"/>
　　<interceptor-ref name="profiling"/>
　　<interceptor-ref name="scoped-model-driven"/>
　　<interceptor-ref name="model-driven"/>
　　<interceptor-ref name="fileUpload"/>
　　<interceptor-ref name="checkbox"/>
　　<interceptor-ref name="static-params"/>
　　<interceptor-ref name="params"/>
　　<interceptor-ref name="conversionError"/>
　　<interceptor-ref name="validation">
　　　　<param name="excludeMethods">input,back,cancel,browse</param>
　　</interceptor-ref>
　　<interceptor-ref name="workflow">
　　　　<param name="excludeMethods">input,back,cancel,browse</param>
　　</interceptor-ref>
</interceptor-stack>
...

要使用Struts2聲明式異常處理，只需要將異常映射到result就可以了，可以用兩種方法配置，一種方法是全局配置，針對所有的Action有效，另一種是針對具體的Action做配置，只針對具體的Action有效。

參看如下struts.xml 配置文件片段：

<package name="default">
　　　...
　　　<global-results>
　　　　　<result name="login" type="redirect">/Login.action</result>
　　　　　<result name="Exception">/Exception.jsp</result>
　　　</global-results>
　　　<global-exception-mappings>
　　　　　<exception-mapping
exception="java.sql.SQLException" result="SQLException"/>
　　　　　<exception-mapping
exception="java.lang.Exception" result="Exception"/>
　　　</global-exception-mappings>
　　　...
　　　<action name="DataAccess" class="com.company.DataAccess">
　　　　　<exception-mapping
exception="com.company.SecurityException" result="login"/>
　　　　　<result name="SQLException" type="chain">SQLExceptionAction</result>
　　　　　<result>/DataAccess.jsp</result>
　　　</action>
　　　...
</package>

上述配置有如下結果

1 一個java.sql.SQLException異常將鏈接到SQLExceptionAction （上述文件中沒有說明）

2 一個com.company.SecurityException將重新定位到login.action

3 其他從java.lang.Exception繼承而來的Exception將會被定為到/Exception.jsp頁面

3.6節 Intercepter攔截器

攔截器的運行時機在Action類運行之前和之後。攔截器使用Filter模式，將你需要執行的代碼放在Action類處理方法之前或者之後執行。攔截器在開發程序的時候功能非常強大，通過使用攔截器可以完成校驗，屬性設置，安全，日志，程序剖析等功能。

攔截器可以彼此鏈接構成一個攔截器的棧，每一個攔截器本質上是一個Java類，都有一個常常的類名，為了方便使用，可以在Struts2框架中注冊這些攔截器，例如：

<interceptor name="security" class="com.jpleasure.security.SecurityInterceptor"/>
<interceptor-stack name="secureStack">
　　<interceptor-ref name="security"/>
　　<interceptor-ref name="defaultStack"/>
</interceptor-stack>
</interceptors>

攔截器和攔截器棧可以混合使用來定義新的攔截器棧，在調用過程中，框架按照在攔截器棧中的順序逐個調用這些攔截器。

可以在Package中定義默認的攔截器棧，例如：

<default-interceptor-ref name="secureStack"/>

當然每一個Action類也可以定義自己的攔截器棧，例如：

<action name="VelocityCounter"
　　　　　　　　　　　　 class="org.apache.struts2.example.counter.SimpleCounter">
　　<result name="success">...</result>
　　<interceptor-ref name="defaultComponentStack"/>
</action>

3.7節 分離配置文件

可以在struts.xml中使用include標記將配置文件分離成不同的部分。

例如：

<!DOCTYPE struts PUBLIC
"-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
"http://struts.apache.org/dtds/struts-2.0.dtd">
<struts>
　　<include file="Home.xml"/>
　　<include file="Hello.xml"/>
　　<include file="Simple.xml"/>
　　<include file="/util/POJO.xml"/>
</struts>