Struts2的攔截器和Servlet過濾器類似。在執行Action的execute方法之前,Struts2會首先執行在struts.xml中引用的攔截器,在執行完所有引用的攔截器的intercept方法後,會執行Action的execute方法。
Struts2攔截器類必須從com.opensymphony.xwork2.interceptor.Interceptor接口繼承,在Intercepter接口中有如下三個方法需要實現:
void destroy();
void init();
String intercept(ActionInvocation invocation) throws Exception;
其中intercept方法是攔截器的核心方法,所有安裝的攔截器都會調用之個方法。在Struts2中已經在struts-default.xml中預定義了一些自帶的攔截器,如timer、params等。如果在<package>標簽中繼承struts-default,則當前package就會自動擁有struts-default.xml中的所有配置。代碼如下:
<package name="demo" extends="struts-default" > ... </package>
在struts-default.xml中有一個默認的引用,在默認情況下(也就是<action>中未引用攔截器時)會自動引用一些攔截器。這個默認的攔截器引用如下:
<default-interceptor-ref name="defaultStack"/> <interceptor-stack name="defaultStack"> <interceptor-ref name="exception"/> <interceptor-ref name="alias"/> <interceptor-ref name="servletConfig"/> <interceptor-ref name="prepare"/> <interceptor-ref name="i18n"/> <interceptor-ref name="chain"/> <interceptor-ref name="debugging"/> <interceptor-ref name="profiling"/> <interceptor-ref name="scopedModelDriven"/> <interceptor-ref name="modelDriven"/> <interceptor-ref name="fileUpload"/> <interceptor-ref name="checkbox"/> <interceptor-ref name="staticParams"/> <interceptor-ref name="params"> <param name="excludeParams">dojo\..*</param> </interceptor-ref> <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>
上面在defaultStack中引用的攔截器都可以在<action>中不經過引用就可以使用(如果在<action>中引用了任何攔截器後,要使用在defaultStack中定義的攔截器,也需要在<action>中重新引用,在後面將詳細講解)。
下面我們來看幾個簡單的攔截器的使用方法。
一、記錄攔截器和execute方法的執行時間(timer)
timer是Struts2中最簡單的攔截器,這個攔截器對應的類是com.opensymphony.xwork2.interceptor.TimerInterceptor。它的功能是記錄execute方法和其他攔截器(在timer後面定義的攔截器)的intercept方法執行的時間總和。如下面的配置代碼所示:
<action name="first" class="action.FirstAction"> <interceptor-ref name="logger"/> <interceptor-ref name="timer" /> </action>
由於在timer後面沒有其他的攔截器定義,因此,timer只能記錄execute方法的執行時間,在訪問first動作時,會在控制台輸出類似下面的一條信息:
信息: Executed action [/test/first!execute] took 16 ms.
在使用timer攔截器時,需要commons-logging.jar的支持。將logger引用放到timer的後面,就可以記錄logger攔截器的intercept方法和Action的execute方法的執行時間總和,代碼如下:
<action name="first" class="action.FirstAction"> <interceptor-ref name="timer" /> <interceptor-ref name="logger"/> </action>
大家可以使用如下的Action類來測試一下timer攔截器:
package action; import com.opensymphony.xwork2.ActionSupport; public class FirstAction extends ActionSupport { public String execute() throws Exception { Thread.sleep(1000); // 延遲1秒 return null; } }
如果只記錄execute方法的執行時間,一般會輸出如下的信息:
信息: Executed action [/test/first!execute] took 1000 ms.
二、通過請求調用Action的setter方法(params)
當客戶端的一個form向服務端提交請求時,如有一個textfield,代碼如下:
<s:form action="first" namespace="/test"> <s:textfield name="name"/> <s:submit/> </s:form
在提交後,Struts2將會自動調用first動作類中的setName方法,並將name文本框中的值通過setName方法的參數傳入。實際上,這個操作是由params攔截器完成的,params對應的類是com.opensymphony.xwork2.interceptor.ParametersInterceptor。由於params已經在defaultStack中定義,因此,在未引用攔截器的<action>中是會自動引用params的,如下面的配置代碼,在訪問first動作時,Struts2是會自動執行相應的setter方法的。
<action name="first" class="action.FirstAction">
... ...
</action>
但如果在<action>中引用了其他的攔截器,就必須再次引用params攔截器,Struts2才能調用相應的setter方法。如下面的配置代碼所示:
<action name="first" class="action.FirstAction"> <interceptor-ref name="timer" /> <interceptor-ref name="params"/> </action>
三、通過配置參數調用Action的setter方法(static-params)
static-params攔截器可以通過配置<params>標簽來調用Action類的相應的setter方法,static-params攔截器對應的類是com.opensymphony.xwork2.interceptor.StaticParametersInterceptor。
下面配置代碼演示了如何使用static-params攔截器:
<action name="first" class="action.FirstAction"> <interceptor-ref name="timer" /> <param name="who">比爾</param> <interceptor-ref name="params"/> <interceptor-ref name="static-params"/> </action>
如果first動作使用上面的配置,在訪問first動作時,Struts2會自動調用setWho方法將“比爾”作為參數值傳入setWho方法。
四、使用攔截器棧
為了能在多個動作中方便地引用同一個或幾個攔截器,可以使用攔截器棧將這些攔截器作為一個整體來引用。攔截器棧要在<package>標簽中使用<interceptors>和子標簽<interceptor-stack>來定義。代碼如下:
<package name="demo" extends="struts-default" > <interceptors> <interceptor-stack name="mystack"> <interceptor-ref name="timer" /> <interceptor-ref name="logger" /> <interceptor-ref name="params" /> <interceptor-ref name="static-params" /> </interceptor-stack> </interceptors> <action name="first" class="action.FirstAction"> <param name="who">比爾</param> <interceptor-ref name="mystack"/> </action> </package>
可以象使用攔截器一樣使用攔截器棧,如上面代碼所示。