Struts2教程9：實(shí)現(xiàn)自已的攔截器
【相關(guān)文章】
- Struts2教程1：***個(gè)Struts2程序
- Struts2教程2：處理一個(gè)form多個(gè)submit
- Struts2教程3：struts.xml常用配置解析
- Struts2教程4：使用validate方法驗(yàn)證數(shù)據(jù)
- Struts2教程5：使用Validation框架驗(yàn)證數(shù)據(jù)
- Struts2教程6：在Action類(lèi)中獲得HttpServletResponse對(duì)象
- Struts2教程7：上傳任意多個(gè)文件
- Struts2教程8：攔截器概述
- Struts2教程10：國(guó)際化
在上一篇中介紹了Struts2攔截器的原理，在這一篇中我們將學(xué)習(xí)一下如何編寫(xiě)自己的攔截器。
攔截器的實(shí)現(xiàn)
實(shí)現(xiàn)一個(gè)攔截器非常簡(jiǎn)單。實(shí)際上，一個(gè)攔截器就是一個(gè)普通的類(lèi)，只是這個(gè)類(lèi)必須實(shí)現(xiàn)com.opensymphony.xwork2.interceptor.Interceptor接口。Interceptor接口有如下三個(gè)方法：
publicinterfaceInterceptorextendsSerializable
{
voiddestroy();
voidinit();
Stringintercept(ActionInvocationinvocation)throwsException;
}
|
其中init和destroy方法只在攔截器加載和釋放（都由Struts2自身處理）時(shí)執(zhí)行一次。而intercept方法在每次訪問(wèn)動(dòng)作時(shí)都會(huì)被調(diào)用。Struts2在調(diào)用攔截器時(shí)，每個(gè)攔截器類(lèi)只有一個(gè)對(duì)象實(shí)例，而所有引用這個(gè)攔截器的動(dòng)作都共享這一個(gè)攔截器類(lèi)的對(duì)象實(shí)例，因此，在實(shí)現(xiàn)Interceptor接口的類(lèi)中如果使用類(lèi)變量，要注意同步問(wèn)題。
下面我們來(lái)實(shí)現(xiàn)一個(gè)簡(jiǎn)單的攔截器，這個(gè)攔截器通過(guò)請(qǐng)求參數(shù)action指定一個(gè)攔截器類(lèi)中的方法，并調(diào)用這個(gè)方法（我們可以使用這個(gè)攔截器對(duì)某一特定的動(dòng)作進(jìn)行預(yù)處理）。如果方法不存在，或是action參數(shù)不存在，則繼續(xù)執(zhí)行下面的代碼。如下面的URL：
http://localhost:8080/struts2/test/interceptor.action?action=test
訪問(wèn)上面的url后，攔截器會(huì)就會(huì)調(diào)用攔截器中的test方法，如果這個(gè)方法不存在，則調(diào)用invocation.invoke方法，invoke方法和Servlet過(guò)濾器中調(diào)用FilterChain.doFilter方法類(lèi)似，如果在當(dāng)前攔截器后面還有其他的攔截器，則invoke方法就是調(diào)用后面攔截器的intercept方法，否則，invoke會(huì)調(diào)用Action類(lèi)的execute方法（或其他的執(zhí)行方法）。
下面我們先來(lái)實(shí)現(xiàn)一個(gè)攔截器的父類(lèi)ActionInterceptor。這個(gè)類(lèi)主要實(shí)現(xiàn)了根據(jù)action參數(shù)值來(lái)調(diào)用方法的功能，代碼如下：
packageinterceptor;
importcom.opensymphony.xwork2.ActionInvocation;
importcom.opensymphony.xwork2.interceptor.Interceptor;
importjavax.servlet.http.*;
importorg.apache.struts2.*;
publicclassActionInterceptorimplementsInterceptor
{
protectedfinalStringINVOKE="##invoke";
publicvoiddestroy()
{
System.out.println("destroy");
}
publicvoidinit()
{
System.out.println("init");
}
publicStringintercept(ActionInvocationinvocation)throwsException
{
HttpServletRequestrequest=ServletActionContext.getRequest();
Stringaction=request.getParameter("action");
System.out.println(this.hashCode());
if(action!=null)
{
try
{
java.lang.reflect.Methodmethod=this.getClass().getMethod(action);
Stringresult=(String)method.invoke(this);
if(result!=null)
{
if(!result.equals(INVOKE))
returnresult;
}
else
returnnull;
}
catch(Exceptione)
{
}
}
returninvocation.invoke();
}
}
從上面代碼中的intercept方法可以看出，在調(diào)用action所指定的方法后，來(lái)判斷返回值。可能發(fā)生的情況有三種：
1. 返回值為null，執(zhí)行return null。
2. 返回值為INVOKE，執(zhí)行return invockation.invoke()。
3. 其他情況，執(zhí)行return result。result表示指定方法的返回值，如上面代碼所示。
在實(shí)現(xiàn)完上面的攔截器父類(lèi)后，任何繼承于ActionInterceptor類(lèi)的攔截器都可以自動(dòng)根據(jù)action的參數(shù)值調(diào)用自身的相應(yīng)方法。下面我們來(lái)實(shí)現(xiàn)一個(gè)擁有兩個(gè)動(dòng)作方法test和print的攔截器類(lèi)。代碼如下：
packageinterceptor;
importjavax.servlet.http.HttpServletResponse; |
est方法返回了INVOKE，因此，在執(zhí)行完這個(gè)方法后，Struts2會(huì)接著調(diào)用其他攔截器的intercept方法或Action類(lèi)的execute方法。而print方法在執(zhí)行完后，只是返回了null，而不再調(diào)用其他的方法了，也就是訪問(wèn)如下的url時(shí)，動(dòng)作的execute方法將不會(huì)執(zhí)行：
http://localhost:8080/struts2/test/ddd.action?action=print
下面我們來(lái)實(shí)現(xiàn)一個(gè)Action類(lèi)，代碼如下：
packageaction;
importorg.apache.struts2.*; |
#p#
在這個(gè)Action類(lèi)中，只有一個(gè)abcd方法，實(shí)際上，這個(gè)方法相當(dāng)于execute方法，在下面會(huì)設(shè)置動(dòng)作的method屬性為abcd。下面我們來(lái)在struts.xml中定義攔截器類(lèi)和動(dòng)作，代碼如下：
＜?xmlversion="1.0"encoding="UTF-8"?＞ |
在配置上面的methodStack攔截器時(shí)要注意，***在后面引用defaultStack，否則很多通過(guò)攔截器提供的功能將失去。
現(xiàn)在訪問(wèn)如下的URL：
http://localhost:8080/struts2/test/ddd.action?action=test
在瀏覽器中將會(huì)出現(xiàn)如下的字符串：
invoke test
invoke abcd
而如果訪問(wèn)http://localhost:8080/struts2/test/ddd.action?action=print，將會(huì)只出現(xiàn)如下的字符串：
invoke print
大家可以看出，訪問(wèn)這個(gè)url時(shí)并沒(méi)有調(diào)用abcd方法。如果隨便指定的action值的話(huà)，則只調(diào)用abcd方法，如訪問(wèn)http://localhost:8080/struts2/test/ddd.action?action=aaa，就只會(huì)輸出invoke abcd。
攔截器的參數(shù)
我們?cè)谑褂煤芏郤truts2內(nèi)置的攔截器時(shí)會(huì)發(fā)現(xiàn)有很多攔截器都帶參數(shù)，當(dāng)然。我們自己做的攔截器也可以加上同樣的參數(shù)。有兩個(gè)參數(shù)比較常用，這兩個(gè)參數(shù)是includeMethods和excludeMethods，其中includeMethods指定了攔截器要調(diào)用的Action類(lèi)的執(zhí)行方法（默認(rèn)是execute），也就是說(shuō)，只有在includeMethods中指定的方法才會(huì)被Struts2調(diào)用，而excludeMethods恰恰相反，在這個(gè)參數(shù)中指定的執(zhí)行方法不會(huì)被Struts2調(diào)用。如果有多個(gè)方法，中間用逗號(hào)(,)分隔。在Struts2中提供了一個(gè)抽象類(lèi)來(lái)處理這兩個(gè)參數(shù)。這個(gè)類(lèi)如下：
com.opensymphony.xwork2.interceptor.MethodFilterInterceptor |
如有繼承于這個(gè)類(lèi)的攔截器類(lèi)都會(huì)自動(dòng)處理includeMethods和excludeMethods參數(shù)，如下面的攔截器類(lèi)所示：
packageinterceptor;
importcom.opensymphony.xwork2.ActionInvocation; |
MethodFilterInterceptor的子類(lèi)需要實(shí)現(xiàn)doIntercept方法（相當(dāng)于Interceptor的intercept方法），如上面代碼所示。在上面的代碼中還有一個(gè)name屬性，是為了讀取攔截器的name屬性而設(shè)置的，如下面的配置代碼所示：
＜!DOCTYPEstrutsPUBLIC
"-//ApacheSoftwareFoundation//DTDStrutsConfiguration2.0//EN"
"http://struts.apache.org/dtds/struts-2.0.dtd"＞
＜struts＞
?。紁ackagename="demo"extends="struts-default"namespace="/test"＞
?。糹nterceptors＞
＜interceptorname="method"class="interceptor.MultiMethodInterceptor"/＞
?。糹nterceptorname="filter"
class="interceptor.MyFilterInterceptor"＞
?。紁aramname="includeMethods"＞abcd＜/param＞
?。紁aramname="name"＞中國(guó)＜/param＞
?。?interceptor＞
?。糹nterceptor-stackname="methodStack"＞
?。糹nterceptor-refname="method"/＞
?。糹nterceptor-refname="filter"/＞
?。糹nterceptor-refname="defaultStack"/＞
?。?interceptor-stack＞
?。?interceptors＞
?。糰ctionname="interceptor"class="action.InterceptorAction"method="abcd"＞
?。糹nterceptor-refname="methodStack"/＞
?。?action＞
?。?package＞
＜/struts＞
再次訪問(wèn)http://localhost:8080/struts2/test/ddd.action?action=test, Struts2就會(huì)調(diào)用MyFilterInterceptor的doIntercept方法來(lái)輸出name屬性值。如果將上面的includeMethods參數(shù)值中的abcd去掉，則Action類(lèi)的abcd方法不會(huì)被執(zhí)行。
【編輯推薦】
