Struts2攔截器學習

一、什麼是攔截器？

提到攔截器，使我不得不想起武俠劇中劫匪們常說的一句話：“此山是我開，此樹是我栽，要打此路過，留下買路財！”。難不成程式中也有“打劫”的，說的沒錯，攔截器就是個打劫的。在現實生活中，劫匪劫的大都是錢財，當然也有別的什麼，那麼程式中的“劫匪”劫的又是什麼呢？或者說程式中為什麼需要它？在我們的日常編程中少不了寫一些重複的代碼，例如在一個地方中寫了一段代碼，後來發現這段代碼在其它地方中同樣需要，在傳統的編程中我們一定會採取複製、粘貼的辦法。如果這段代碼只在這一兩個處需要，我們採取這種辦法，還說的過去，但是如果系統對這段代碼過於依賴，也就是這段代碼在系統中出現的過多，如果那一天我們發現這段代碼中在某些地方還需要完善，我們是不是要著個修改它們呢？我估計沒有人會這麼做，它嚴重違反了軟體開發中一條非常重要的DRY規則，不寫重複代碼。說了這麼多你一定知道我們為什麼需要在程式中弄一個“劫匪”了吧。這個“劫匪”就是並不是劫取什麼東西，只是為了在某個程式執行前後，動態增加一些功能（以前所寫通用代碼塊）或進行一些檢查工作。那麼這個攔截器到底是怎麼實現的呢？實際上它是用Java中的動態代理來實現的，具體可以參考《設計模式學習筆記(十六)—Proxy模式》。

二、攔截器在Struts2中的應用

對於Struts2架構而言，正是大量的內建攔截器完成了大部分操作。像params攔截器將http請求中參數解析出來賦值給Action中對應的屬性。Servlet-config攔截器負責把請求中HttpServletRequest執行個體和HttpServletResponse執行個體傳遞給Action……struts2內建的攔截器有很多，在此我就不一一列舉了，具體可以參考《Struts2中有關struts-default.xml,struts.xml,struts.properties檔案詳解》。

那麼怎麼在struts2中定義自己的攔截器呢?

很簡單Struts2為我們提供了一個Interceptor介面,該介面原始碼如下:

publicinterface Interceptor extends Serializable {

    void destroy();

    void init();

    String intercept(ActionInvocation invocation) throws Exception;

}

1)    init():在攔截器執行之前調用，主要用於初始化系統資源。

2)    destroty():與init()對應，用於攔截器執行之後銷毀資源。

3)    intercept():攔截器的核心方法，實現具體的攔截操作。與action一樣，該方法也返回一個字串作為邏輯視圖。如果攔截器成功調用了action，則返回一個真正的，也就是該action中execute()方法返回的邏輯視圖，反之，則返回一個自訂的邏輯視圖。

通常我們使用攔截器並不需要申請資源，為此Struts2還為我們提供了一個AbstractInterceptor類，該類的init()和destroy()都是空實現。我們開發自己的攔截器只需要繼承這個類就行了。

下面建立一個判斷使用者是否登入的攔截器。代碼如下:

/** *//**

*

* @author

* @version 1.0

* Creation date: Feb 12, 2008 5:05:28 PM

*/

import java.util.Map;

import com.opensymphony.xwork2.Action;

import com.opensymphony.xwork2.ActionInvocation;

import com.opensymphony.xwork2.interceptor.AbstractInterceptor;

@SuppressWarnings("serial")

public class CheckLoginInterceptor extends AbstractInterceptor {

    @SuppressWarnings("unchecked")

    public String intercept(ActionInvocation actionInvocation) throws Exception {

         System.out.println("begin check login interceptor!");

            // 檢查Session中是否存在user

            Map session = actionInvocation.getInvocationContext().getSession();

            String username = (String) session.get("user");

            if (username != null && username.length() > 0) {

                // 存在的情況下進行後續操作。

                System.out.println("already login!");

                return actionInvocation.invoke();

            } else {

                // 否則終止後續操作，返回LOGIN

                System.out.println("no login, forward login page!");

                return Action.LOGIN;

            }

        }

    }

建立好攔截器後，還不能使用，還需要我們在struts.xml中配置一下。

下面看一下怎麼配置攔截器。

<interceptors>

           <interceptor name="checkLogin" class="com.myblog.interceptor.CheckLoginInterceptor" />

</interceptors>

這個定義好的攔截器在Action中怎麼使用呢？使用方法很簡單，如下：

<action name=" " class=" " >

           <result> </result>

           <interceptor-ref name="checkLogin" />

</action>

一旦我們為某個action引用了自訂的攔截器，struts2預設的攔截器就不會再起作用，因此還需要引用預設攔截器。

<action name=" " class=" " >

           <result> </result>

           <interceptor-ref name="checkLogin" />

                     <interceptor-ref name="defaultStack" />

</action>

但是我們這麼做似乎也不太方便，因為如果攔截器checkLogin需要被多個action引用的話，每一個都要配置一遍太麻煩了。我們可以把它定義成預設的攔截器。

<interceptors>

           <interceptor name="checkLogin" class="com.myblog.interceptor.CheckLoginInterceptor" />

           <!—-定義一個攔截器棧-->

           <interceptor-stack name="mydefault">

              <interceptor-ref name="defaultStack" />

              <interceptor-ref name="checkLogin" />

           </interceptor-stack>

</interceptors>

<default-interceptor-ref name="mydefault" />

另外，struts2還為我們提供了一個方法過濾的攔截器MethodFilterInterceptor類，該類繼承AbstractInterceptor類，重寫了intercept(ActionInvocation invocation)並提供了一個新的方法doInterceptor(ActionInvocation invocation)抽象方法。該類的使用方法很簡單，就不舉例了。這個攔截器與以往的攔截器配置有所不同。那就是可以指定哪些方法需要被攔截，那些不需要。通常在引用該攔截器時指定。

<interceptor-ref name="  ">

       <param name="exculdeMethods"></param>

       <param name="includeMethods"></param>   

</interceptor-ref>

exculdeMethods：是不被攔截的方法，如果有多個以逗號分隔。

includeMethods：需要被攔截的方法，如果有多個以逗號分隔。