Struts2教程:攔截器概述
Struts2的攔截器和Servlet過(guò)濾器類(lèi)似。在執(zhí)行Action的execute方法之前,Struts2會(huì)首先執(zhí)行在struts.xml中引用的攔截器,在執(zhí)行完所有引用的攔截器的intercept方法后,會(huì)執(zhí)行Action的execute方法。
Struts2攔截器類(lèi)必須從com.opensymphony.xwork2.interceptor.Interceptor接口繼承,在Intercepter接口中有如下三個(gè)方法需要實(shí)現(xiàn):
- void destroy();
- void init();
- String intercept(ActionInvocation invocation) throws Exception;
其中intercept方法是攔截器的核心方法,所有安裝的攔截器都會(huì)調(diào)用之個(gè)方法。在Struts2中已經(jīng)在struts-default.xml中預(yù)定義了一些自帶的攔截器,如timer、params等。如果在< package>標(biāo)簽中繼承struts-default,則當(dāng)前package就會(huì)自動(dòng)擁有struts-default.xml中的所有配置。代碼如下:
< package name="demo" extends="struts-default" > ... < /package>
在struts-default.xml中有一個(gè)默認(rèn)的引用,在默認(rèn)情況下(也就是< action>中未引用攔截器時(shí))會(huì)自動(dòng)引用一些攔截器。這個(gè)默認(rèn)的攔截器引用如下:
- < 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>中不經(jīng)過(guò)引用就可以使用(如果在< action>中引用了任何攔截器后,要使用在defaultStack中定義的攔截器,也需要在< action>中重新引用,在后面將詳細(xì)講解)。
下面我們來(lái)看幾個(gè)簡(jiǎn)單的攔截器的使用方法。
一、記錄攔截器和execute方法的執(zhí)行時(shí)間(timer)
timer是Struts2中最簡(jiǎn)單的攔截器,這個(gè)攔截器對(duì)應(yīng)的類(lèi)是com.opensymphony.xwork2.interceptor.TimerInterceptor。它的功能是記錄execute方法和其他攔截器(在timer后面定義的攔截器)的intercept方法執(zhí)行的時(shí)間總和。如下面的配置代碼所示:
- < action name="first" class="action.FirstAction">
- < interceptor-ref name="logger"/>
- < interceptor-ref name="timer" />
- < /action>
由于在timer后面沒(méi)有其他的攔截器定義,因此,timer只能記錄execute方法的執(zhí)行時(shí)間,在訪(fǎng)問(wèn)first動(dòng)作時(shí),會(huì)在控制臺(tái)輸出類(lèi)似下面的一條信息:
信息: Executed action [/test/first!execute] took 16 ms.
在使用timer攔截器時(shí),需要commons-logging.jar的支持。將logger引用放到timer的后面,就可以記錄logger攔截器的intercept方法和Action的execute方法的執(zhí)行時(shí)間總和,代碼如下:
- < action name="first" class="action.FirstAction">
- < interceptor-ref name="timer" />
- < interceptor-ref name="logger"/>
- < /action>
大家可以使用如下的Action類(lèi)來(lái)測(cè)試一下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方法的執(zhí)行時(shí)間,一般會(huì)輸出如下的信息:
信息: Executed action [/test/first!execute] took 1000 ms.
二、通過(guò)請(qǐng)求調(diào)用Action的setter方法(params)
當(dāng)客戶(hù)端的一個(gè)form向服務(wù)端提交請(qǐng)求時(shí),如有一個(gè)textfield,代碼如下:
- < s:form action="first" namespace="/test">
- < s:textfield name="name"/>
- < s:submit/>
- < /s:form>
在提交后,Struts2將會(huì)自動(dòng)調(diào)用first動(dòng)作類(lèi)中的setName方法,并將name文本框中的值通過(guò)setName方法的參數(shù)傳入。實(shí)際上,這個(gè)操作是由params攔截器完成的,params對(duì)應(yīng)的類(lèi)是com.opensymphony.xwork2.interceptor.ParametersInterceptor。由于params已經(jīng)在defaultStack中定義,因此,在未引用攔截器的< action>中是會(huì)自動(dòng)引用params的,如下面的配置代碼,在訪(fǎng)問(wèn)first動(dòng)作時(shí),Struts2是會(huì)自動(dòng)執(zhí)行相應(yīng)的setter方法的。
< action name="first" class="action.FirstAction">
... ...
< /action>
但如果在< action>中引用了其他的攔截器,就必須再次引用params攔截器,Struts2才能調(diào)用相應(yīng)的setter方法。如下面的配置代碼所示:
- < action name="first" class="action.FirstAction">
- < interceptor-ref name="timer" />
- < interceptor-ref name="params"/>
- < /action>
三、通過(guò)配置參數(shù)調(diào)用Action的setter方法(static-params)
static-params攔截器可以通過(guò)配置< params>標(biāo)簽來(lái)調(diào)用Action類(lèi)的相應(yīng)的setter方法,static-params攔截器對(duì)應(yīng)的類(lèi)是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動(dòng)作使用上面的配置,在訪(fǎng)問(wèn)first動(dòng)作時(shí),Struts2會(huì)自動(dòng)調(diào)用setWho方法將“比爾”作為參數(shù)值傳入setWho方法。
四、使用攔截器棧
為了能在多個(gè)動(dòng)作中方便地引用同一個(gè)或幾個(gè)攔截器,可以使用攔截器棧將這些攔截器作為一個(gè)整體來(lái)引用。攔截器棧要在< package>標(biāo)簽中使用< interceptors>和子標(biāo)簽< interceptor-stack>來(lái)定義。代碼如下:
- < 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>
可以象使用攔截器一樣使用攔截器棧,如上面代碼所示。
【編輯推薦】