本文為原創(chuàng)，如需轉(zhuǎn)載，請(qǐng)注明作者和出處，謝謝！
上一篇：Struts2教程8：攔截器概述
在上一篇中介紹了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è)方法：
public interface Interceptor extends Serializable
{
void destroy();
void init();
String intercept(ActionInvocation invocation) throws Exception;
}
其中init和destroy方法只在攔截器加載和釋放（都由Struts2自身處理）時(shí)執(zhí)行一次。而intercept方法在每次訪(fǎng)問(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
訪(fǎng)問(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)用方法的功能，代碼如下：
package interceptor;
import com.opensymphony.xwork2.ActionInvocation;
import com.opensymphony.xwork2.interceptor.Interceptor;
import javax.servlet.http.*;
import org.apache.struts2.*;
public class ActionInterceptor implements Interceptor
{
protected final String INVOKE = "##invoke";
public void destroy()
{
System.out.println("destroy");
}
public void init()
{
System.out.println("init");
}
public String intercept(ActionInvocation invocation) throws Exception
{
HttpServletRequest request = ServletActionContext.getRequest();
String action = request.getParameter("action");
System.out.println(this.hashCode());
if (action != null)
{
try
{
java.lang.reflect.Method method = this.getClass().getMethod(action);
String result = (String)method.invoke(this);
if(result != null)
{
if(!result.equals(INVOKE))
return result;
}
else
return null;
}
catch (Exception e)
{
}
}
return invocation.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)。代碼如下：
package interceptor;
import javax.servlet.http.HttpServletResponse;
import org.apache.struts2.ServletActionContext;
public class MultiMethodInterceptor extends ActionInterceptor
{
public String test() throws Exception
{
HttpServletResponse response = ServletActionContext.getResponse();
response.getWriter().println("invoke test");
return this.INVOKE;
}
public String print() throws Exception
{
HttpServletResponse response = ServletActionContext.getResponse();
response.getWriter().println("invoke print");
return null;
}
}
test方法返回了INVOKE，因此，在執(zhí)行完這個(gè)方法后，Struts2會(huì)接著調(diào)用其他攔截器的intercept方法或Action類(lèi)的execute方法。而print方法在執(zhí)行完后，只是返回了null，而不再調(diào)用其他的方法了，也就是訪(fǎng)問(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)，代碼如下：
package action;
import org.apache.struts2.*;
import com.opensymphony.xwork2.ActionSupport;
public class InterceptorAction extends ActionSupport
{
public String abcd() throws Exception
{
ServletActionContext.getResponse().getWriter()
.println("invoke abcd");
return null;
}
}
在這個(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)作，代碼如下：
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE struts PUBLIC
"-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
"http://struts.apache.org/dtds/struts-2.0.dtd">
<struts>
<package name="demo" extends="struts-default" namespace="/test">
<interceptors>
<interceptor name="method" class="interceptor.MultiMethodInterceptor" />
<interceptor-stack name="methodStack">
<interceptor-ref name="method" />
<interceptor-ref name="defaultStack" />
</interceptor-stack>
</interceptors>
<action name="interceptor" class="action.InterceptorAction" method="abcd">
<interceptor-ref name="methodStack" />
</action>
</package>
</struts>
在配置上面的methodStack攔截器時(shí)要注意，最好在后面引用defaultStack，否則很多通過(guò)攔截器提供的功能將失去。
OK，現(xiàn)在訪(fǎng)問(wèn)如下的URL：
http://localhost:8080/struts2/test/ddd.action?action=test
在瀏覽器中將會(huì)出現(xiàn)如下的字符串：
invoke test
invoke abcd
而如果訪(fǎng)問(wèn)http://localhost:8080/struts2/test/ddd.action?action=print，將會(huì)只出現(xiàn)如下的字符串：
invoke print
大家可以看出，訪(fǎng)問(wèn)這個(gè)url時(shí)并沒(méi)有調(diào)用abcd方法。如果隨便指定的action值的話(huà)，則只調(diào)用abcd方法，如訪(fǎng)問(wèn)http://localhost:8080/struts2/test/ddd.action?action=aaa，就只會(huì)輸出invoke abcd。
二、攔截器的參數(shù)
我們?cè)谑褂煤芏?/span>Struts2內(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)所示：
package interceptor;
import com.opensymphony.xwork2.ActionInvocation;
import com.opensymphony.xwork2.interceptor.*;
public class MyFilterInterceptor extends MethodFilterInterceptor
{
private String name;
public String getName()
{
return name;
}
public void setName(String name)
{
this.name = name;
}
@Override
protected String doIntercept(ActionInvocation invocation) throws Exception
{
System.out.println("doIntercept");
System.out.println(name);
return invocation.invoke();
}
}
MethodFilterInterceptor的子類(lèi)需要實(shí)現(xiàn)doIntercept方法（相當(dāng)于Interceptor的intercept方法），如上面代碼所示。在上面的代碼中還有一個(gè)name屬性，是為了讀取攔截器的name屬性而設(shè)置的，如下面的配置代碼所示：
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE struts PUBLIC
"-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
"http://struts.apache.org/dtds/struts-2.0.dtd">
<struts>
<package name="demo" extends="struts-default" namespace="/test">
<interceptors>
<interceptor name="method" class="interceptor.MultiMethodInterceptor" />
<interceptor name="filter"
class="interceptor.MyFilterInterceptor">
<param name="includeMethods">abcd</param>
<param name="name">中國(guó)</param>
</interceptor>
<interceptor-stack name="methodStack">
<interceptor-ref name="method" />
<interceptor-ref name="filter" />
<interceptor-ref name="defaultStack" />
</interceptor-stack>
</interceptors>
<action name="interceptor" class="action.InterceptorAction" method="abcd">
<interceptor-ref name="methodStack" />
</action>
</package>
</struts>
再次訪(fǎng)問(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í)行。
下一篇：Struts2教程10：國(guó)際化
新浪微博：http://t.sina.com.cn/androidguy 昵稱(chēng)：李寧_Lining