java框架篇---struts實現(xiàn)攔截器

2019-11-14 23:24:59

字體：大中小

供稿：網(wǎng)友

Struts2的攔截器和Servlet過濾器類似。在執(zhí)行Action的execute方法之前，Struts2會首先執(zhí)行在struts.xml中引用的攔截器，在執(zhí)行完所有引用的攔截器的intercept方法后，會執(zhí)行Action的execute方法。

Struts2攔截器類必須從com.opensymphony.xwork2.interceptor.Interceptor接口繼承，在Intercepter接口中有如下三個方法需要實現(xiàn)：

void destroy();void init();String intercept(ActionInvocation invocation) throws Exception;

其中intercept方法是攔截器的核心方法，所有安裝的攔截器都會調(diào)用之個方法。在Struts2中已經(jīng)在struts-default.xml中預(yù)定義了一些自帶的攔截器，如timer、params等。如果在<package>標(biāo)簽中繼承struts-default，則當(dāng)前package就會自動擁有struts-default.xml中的所有配置。代碼如下：

在struts-default.xml中有一個默認(rèn)的引用，在默認(rèn)情況下（也就是<action>中未引用攔截器時）會自動引用一些攔截器。這個默認(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="上面在defaultStack中引用的攔截器都可以在<action>中不經(jīng)過引用就可以使用（如果在<action>中引用了任何攔截器后，要使用在defaultStack中定義的攔截器，也需要在<action>中重新引用，在后面將詳細(xì)講解）。
下面我們來看幾個簡單的攔截器的使用方法。
一、記錄攔截器和execute方法的執(zhí)行時間(timer)
 timer是Struts2中最簡單的攔截器，這個攔截器對應(yīng)的類是com.opensymphony.xwork2.interceptor.TimerInterceptor。它的功能是記錄execute方法和其他攔截器（在timer后面定義的攔截器）的intercept方法執(zhí)行的時間總和。如下面的配置代碼所示：
<action name="first" class="action.FirstAction">    <interceptor-ref name="logger"/>    <interceptor-ref name="timer" /></action>
由于在timer后面沒有其他的攔截器定義，因此，timer只能記錄execute方法的執(zhí)行時間，在訪問first動作時，會在控制臺輸出類似下面的一條信息：信息: Executed action [/test/first!execute] took 16 ms.
在使用timer攔截器時，需要commons-logging.jar的支持。將logger引用放到timer的后面，就可以記錄logger攔截器的intercept方法和Action的execute方法的執(zhí)行時間總和，代碼如下：
<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方法的執(zhí)行時間，一般會輸出如下的信息：
信息: Executed action [/test/first!execute] took 1000 ms.
二、通過請求調(diào)用Action的setter方法(params)
 當(dāng)客戶端的一個form向服務(wù)端提交請求時，如有一個textfield，代碼如下：
<s:form action="first" namespace="/test">   <s:textfield name="name"/>   <s:submit/></s:form>
在提交后，Struts2將會自動調(diào)用first動作類中的setName方法，并將name文本框中的值通過setName方法的參數(shù)傳入。實際上，這個操作是由params攔截器完成的，params對應(yīng)的類是com.opensymphony.xwork2.interceptor.ParametersInterceptor。由于params已經(jīng)在defaultStack中定義，因此，在未引用攔截器的<action>中是會自動引用params的，如下面的配置代碼，在訪問first動作時，Struts2是會自動執(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>
三、通過配置參數(shù)調(diào)用Action的setter方法(static-params)
 static-params攔截器可以通過配置<params>標(biāo)簽來調(diào)用Action類的相應(yīng)的setter方法，static-params攔截器對應(yīng)的類是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會自動調(diào)用setWho方法將“比爾”作為參數(shù)值傳入setWho方法。
四、使用攔截器棧
 為了能在多個動作中方便地引用同一個或幾個攔截器，可以使用攔截器棧將這些攔截器作為一個整體來引用。攔截器棧要在<package>標(biāo)簽中使用<interceptors>和子標(biāo)簽<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>
 可以象使用攔截器一樣使用攔截器棧，如上面代碼所示。
攔截器的實現(xiàn)實現(xiàn)一個攔截器非常簡單。實際上，一個攔截器就是一個普通的類，只是這個類必須實現(xiàn)com.opensymphony.xwork2.interceptor.Interceptor接口。Interceptor接口有如下三個方法：
public interface Interceptor extends Serializable {    void destroy();    void init();    String intercept(ActionInvocation invocation) throws Exception;}
其中init和destroy方法只在攔截器加載和釋放（都由Struts2自身處理）時執(zhí)行一次。而intercept方法在每次訪問動作時都會被調(diào)用。Struts2在調(diào)用攔截器時，每個攔截器類只有一個對象實例，而所有引用這個攔截器的動作都共享這一個攔截器類的對象實例，因此，在實現(xiàn)Interceptor接口的類中如果使用類變量，要注意同步問題。
下面我們來實現(xiàn)一個簡單的攔截器，這個攔截器通過請求參數(shù)action指定一個攔截器類中的方法，并調(diào)用這個方法（我們可以使用這個攔截器對某一特定的動作進行預(yù)處理）。如果方法不存在，或是action參數(shù)不存在，則繼續(xù)執(zhí)行下面的代碼。如下面的URL：
http://localhost:8080/struts2/test/interceptor.action?action=test
訪問上面的url后，攔截器會就會調(diào)用攔截器中的test方法，如果這個方法不存在，則調(diào)用invocation.invoke方法，invoke方法和Servlet過濾器中調(diào)用FilterChain.doFilter方法類似，如果在當(dāng)前攔截器后面還有其他的攔截器，則invoke方法就是調(diào)用后面攔截器的intercept方法，否則，invoke會調(diào)用Action類的execute方法（或其他的執(zhí)行方法）。
下面我們先來實現(xiàn)一個攔截器的父類ActionInterceptor。這個類主要實現(xiàn)了根據(jù)action參數(shù)值來調(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所指定的方法后，來判斷返回值。可能發(fā)生的情況有三種：
1.返回值為null，執(zhí)行return null。
2.返回值為INVOKE，執(zhí)行return invockation.invoke()。
3.其他情況，執(zhí)行return result。result表示指定方法的返回值，如上面代碼所示。
在實現(xiàn)完上面的攔截器父類后，任何繼承于ActionInterceptor類的攔截器都可以自動根據(jù)action的參數(shù)值調(diào)用自身的相應(yīng)方法。下面我們來實現(xiàn)一個擁有兩個動作方法test和print的攔截器類。代碼如下：
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í)行完這個方法后，Struts2會接著調(diào)用其他攔截器的intercept方法或Action類的execute方法。而print方法在執(zhí)行完后，只是返回了null，而不再調(diào)用其他的方法了，也就是訪問如下的url時，動作的execute方法將不會執(zhí)行： http://localhost:8080/struts2/test/ddd.action?action=print
下面我們來實現(xiàn)一個Action類，代碼如下：
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;    }}
在這個Action類中，只有一個abcd方法，實際上，這個方法相當(dāng)于execute方法，在下面會設(shè)置動作的method屬性為abcd。下面我們來在struts.xml中定義攔截器類和動作，代碼如下：
<?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攔截器時要注意，最好在后面引用defaultStack，否則很多通過攔截器提供的功能將失去。
OK，現(xiàn)在訪問如下的URL： http://localhost:8080/struts2/test/ddd.action?action=test
在瀏覽器中將會出現(xiàn)如下的字符串： invoke test
invoke abcd
而如果訪問http://localhost:8080/struts2/test/ddd.action?action=print，將會只出現(xiàn)如下的字符串： invoke print
大家可以看出，訪問這個url時并沒有調(diào)用abcd方法。如果隨便指定的action值的話，則只調(diào)用abcd方法，如訪問http://localhost:8080/struts2/test/ddd.action?action=aaa，就只會輸出invoke abcd。
攔截器的參數(shù)我們在使用很多Struts2內(nèi)置的攔截器時會發(fā)現(xiàn)有很多攔截器都帶參數(shù)，當(dāng)然。我們自己做的攔截器也可以加上同樣的參數(shù)。有兩個參數(shù)比較常用，這兩個參數(shù)是includeMethods和excludeMethods，其中includeMethods指定了攔截器要調(diào)用的Action類的執(zhí)行方法（默認(rèn)是execute），也就是說，只有在includeMethods中指定的方法才會被Struts2調(diào)用，而excludeMethods恰恰相反，在這個參數(shù)中指定的執(zhí)行方法不會被Struts2調(diào)用。如果有多個方法，中間用逗號(,)分隔。在Struts2中提供了一個抽象類來處理這兩個參數(shù)。這個類如下：
 com.opensymphony.xwork2.interceptor.MethodFilterInterceptor如有繼承于這個類的攔截器類都會自動處理includeMethods和excludeMethods參數(shù)，如下面的攔截器類所示：
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的子類需要實現(xiàn)doIntercept方法（相當(dāng)于Interceptor的intercept方法），如上面代碼所示。在上面的代碼中還有一個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">中國</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>
再次訪問http://localhost:8080/struts2/test/ddd.action?action=test, Struts2就會調(diào)用MyFilterInterceptor的doIntercept方法來輸出name屬性值。如果將上面的includeMethods參數(shù)值中的abcd去掉，則Action類的abcd方法不會被執(zhí)行。