Struts2攔截器的使用 (詳解)

  如何使用struts2攔截器，或者自定義攔截器。特別注意，在使用攔截器的時候，在Action裏面必須最後一定要引用struts2自帶的攔截器缺省堆棧defaultStack,如下(這裏我是引用了struts2自帶的checkbox攔截器)：

<interceptor-ref name="checkbox">
  <param name="uncheckedValue">0</param>
</interceptor-ref>
<interceptor-ref name="defaultStack"/>(必須加，否則出錯)也可以改爲對全局Action設置自己需要的攔截器，如下：

在struts.xml裏面定義全局的配置設置
  <package name="struts-shop" extends="struts-default">
    <interceptors>
      <interceptor-stack name="myStack">
        <interceptor-ref name="checkbox">
          <param name="uncheckedValue">0</param>
       </interceptor-ref>
       <interceptor-ref name="defaultStack"/>
      </interceptor-stack>
    </interceptors>
    <default-interceptor-ref name="myStack"/>（這句是設置所有Action自動調用的攔截器堆棧）
  </package>
 
struts-action.xml裏面配置Action如下：
  <package name="LogonAdmin" extends="struts-shop">（這裏擴展struts.xml裏面定義的配置就可以了）
  <action name="logon" class="logonAction">
     <result>/jsp/smeishop/admin/index.jsp</result>
     <result name="error">/jsp/smeishop/admin/logon.jsp</result>
     <result name="input">/jsp/smeishop/admin/logon.jsp</result>
   </action>
   <action name="logout" class="logoutAction">
     <result>/jsp/smeishop/admin/logon.jsp</result>
   </action>
 </package>

你的攔截器可以正常工作了！！HOHO

以下是參考資料

struts2自帶的配置及其攔截器配置

Struts2 攔截器 [Interceptor]

攔截器的工作原理如上圖，每一個Action請求都包裝在一系列的攔截器的內部。攔截器可以在Action執行直線做相似的操作也可以在Action執行直後做回收操作。

 

每一個Action既可以將操作轉交給下面的攔截器，Action也可以直接退出操作返回客戶既定的畫面。

 

如何自定義一個攔截器？

自定義一個攔截器需要三步：

1 自定義一個實現Interceptor接口（或者繼承自AbstractInterceptor）的類。

2 在strutx.xml中註冊上一步中定義的攔截器。

3 在需要使用的Action中引用上述定義的攔截器，爲了方便也可將攔截器定義爲默認的攔截器，這樣在不加特殊聲明的情況下所有的Action都被這個攔截器攔截。

 

Interceptor接口聲明瞭三個方法：

 

public interface Interceptor extends Serializable {
    void destroy();
    void init();
    String intercept(ActionInvocation invocation) throws Exception;
}

 

Init方法在攔截器類被創建之後，在對Action鏡像攔截之前調用，相當於一個post-constructor方法，使用這個方法可以給攔截器類做必要的初始話操作。

 

Destroy方法在攔截器被垃圾回收之前調用，用來回收init方法初始化的資源。

 

Intercept是攔截器的主要攔截方法，如果需要調用後續的Action或者攔截器，只需要在該方法中調用invocation.invoke()方法即可，在該方法調用的前後可以插入Action調用前後攔截器需要做的方法。如果不需要調用後續的方法，則返回一個String類型的對象即可，例如Action.SUCCESS。

另外AbstractInterceptor提供了一個簡單的Interceptor的實現，這個實現爲：

public abstract class AbstractInterceptor implements Interceptor {
     public void init() {
    }
    public void destroy() {
    }
    public abstract String intercept(ActionInvocation invocation) throws Exception;
}

在不需要編寫init和destroy方法的時候，只需要從AbstractInterceptor繼承而來，實現intercept方法即可。

 

我們嘗試編寫一個Session過濾用的攔截器，該攔截器查看用戶Session中是否存在特定的屬性（LOGIN屬性）如果不存在，中止後續操作定位到LOGIN，否則執行原定操作，代碼爲：

public class CheckLoginInterceptor extends AbstractInterceptor {
    public static final String LOGIN_KEY = "LOGIN";
    public static final String LOGIN_PAGE = "global.login";
    public String intercept(ActionInvocation actionInvocation) throws Exception {
        System.out.println("begin check login interceptor!");
        // 對LoginAction不做該項攔截
        Object action = actionInvocation.getAction();
        if (action instanceof LoginAction) {
            System.out.println("exit check login, because this is login action.");
            return actionInvocation.invoke();
        }
        // 確認Session中是否存在LOGIN
        Map session = actionInvocation.getInvocationContext().getSession();
        String login = (String) session.get(LOGIN_KEY);
        if (login != null && login.length() > 0) {
            // 存在的情況下進行後續操作。
            System.out.println("already login!");
            return actionInvocation.invoke();
        } else {
            // 否則終止後續操作，返回LOGIN
            System.out.println("no login, forward login page!");
            return LOGIN_PAGE;
        }
    }
}

 

註冊攔截器

<interceptors>
        <interceptor name="login" class="com.jpleasure.teamware.util.CheckLoginInterceptor"/>
            <interceptor-stack name="teamwareStack">
                <interceptor-ref name="login"/>
                <interceptor-ref name="defaultStack"/>
            </interceptor-stack>
</interceptors>

將上述攔截器設定爲默認攔截器：

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

這樣在後續同一個package內部的所有Action執行之前都會被login攔截。

 

註冊並引用Interceptor

<package name="default" extends="struts-default">
   <interceptors>
       <interceptor name="timer" class=".."/>
       <interceptor name="logger" class=".."/>
   </interceptors>
   <action name="login" class="tutorial.Login">
        <interceptor-ref name="timer"/>
        <interceptor-ref name="logger"/>
        <result name="input">login.jsp</result>
        <result name="success"
            type="redirect-action">/secure/home</result>
   </action>
</package>

 

可以將多個攔截器合併在一起作爲一個堆棧調用，當一個攔截器堆棧被附加到一個Action的時候，要想Action執行，必須執行攔截器堆棧中的每一個攔截器。

<package name="default" extends="struts-default">
   <interceptors>
        <interceptor name="timer" class=".."/>
        <interceptor name="logger" class=".."/>
        <interceptor-stack name="myStack">
           <interceptor-ref name="timer"/>
           <interceptor-ref name="logger"/>
        </interceptor-stack>
    </interceptors>

    <action name="login" class="tutuorial.Login">
         <interceptor-ref name="myStack"/>
         <result name="input">login.jsp</result>
         <result name="success"
             type="redirect-action">/secure/home</result>
    </action>
</package>

 

上述說明的攔截器在默認的Struts2應用中，根據慣例配置了若干個攔截器堆棧，詳細情參看struts-default.xml

其中有一個攔截器堆棧比較特殊，他會應用在默認的每一個Action上。

<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>

 

每一個攔截器都可以配置參數，有兩種方式配置參數，一是針對每一個攔截器定義參數，二是針對一個攔截器堆棧統一定義所有的參數，例如：

<interceptor-ref name="validation">
 <param name="excludeMethods">myValidationExcudeMethod</param>
</interceptor-ref>
<interceptor-ref name="workflow">
 <param name="excludeMethods">myWorkflowExcludeMethod</param>
</interceptor-ref>

或者

<interceptor-ref name="defaultStack">
    <param name="validation.excludeMethods">myValidationExcludeMethod</param>
    <param name="workflow.excludeMethods">myWorkflowExcludeMethod</param>
</interceptor-ref>

 

每一個攔截器都有兩個默認的參數：

excludeMethods - 過濾掉不使用攔截器的方法和

includeMethods – 使用攔截器的方法。

 

需要說明的幾點：

1 攔截器執行的順序按照定義的順序執行，例如：

<interceptor-stack name="xaStack">
   <interceptor-ref name="thisWillRunFirstInterceptor"/>
   <interceptor-ref name="thisWillRunNextInterceptor"/>
   <interceptor-ref name="followedByThisInterceptor"/>
   <interceptor-ref name="thisWillRunLastInterceptor"/>
</interceptor-stack>

的執行順序爲：

thisWillRunFirstInterceptor

 thisWillRunNextInterceptor

    followedByThisInterceptor

      thisWillRunLastInterceptor

        MyAction1

        MyAction2 (chain)

        MyPreResultListener

        MyResult (result)

      thisWillRunLastInterceptor

    followedByThisInterceptor

 thisWillRunNextInterceptor

thisWillRunFirstInterceptor

 

2 使用默認攔截器配置每個Action都需要的攔截器堆棧，例如：

<action name="login" class="tutorial.Login">
     <interceptor-ref name="timer"/>
     <interceptor-ref name="logger"/>
     <interceptor-ref name="default-stack"/>

     <result name="input">login.jsp</result>
     <result type="redirect-action">/secure/home</result>
</action>

可以按照如下的方式定義：

<interceptors>
     <interceptor-stack name="myStack">
        <interceptor-ref name="timer"/>
        <interceptor-ref name="logger"/>
        <interceptor-ref name="default-stack"/>
     </interceptor-stack>
</interceptors>

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

<action name="login" class="tutorial.Login">
       <result name="input">login.jsp</result>
       <result type="redirect-action">/secure/home</result>
</action>

 

3 如何訪問HttpServletRequest，HttpServletResponse或者HttpSession

有兩種方法可以達到效果，使用ActionContext：

Map attibutes = ActionContext.getContext().getSession();

或者實現相應的接口：

HttpSession            SessionAware

HttpServletRequest     ServletRequestAware

HttpServletResponse    ServletResponseAware