SHH攔截器的使用

原創 迷迷糊 2018-09-03 17:39

一、攔截器


  1、攔截器小介


       攔截器的功能類似於web.xml文件中的Filter，能對用戶的請求進行攔截，通過攔截用戶的請求來實現對頁面的控制。攔截器是在Struts-core-2.2.3.jar中進行配置的，原始的攔截器是在struts-default.xml中配置的，裏面封存了攔截器的基本使用方法。

       Struts2攔截器功能類似於Servlet過濾器。在Action執行execute方法前，Struts2會首先執行struts.xml中引用的攔截器，如果有多個攔截器則會按照上下順序依次執行，在執行完所有的攔截器的interceptor方法後，會執行Action的execute方法。

        Struts2的攔截器必須從com.opensymphoy.xwork2.interceptor.Interceptor中實現該接口，在被定義的攔截器中有下面三個方法需要被實現：

[java] view plain copy
  1. void destroy();   
  2. void init();   
  3. String intercept(ActionInvocation invocation) throws Exception;  

       自定義的攔截器需要重寫上面三個方法。另外Struts2的攔截器配置文件struts.xml它是繼承了原始文件struts-default.xml文件的，這樣在相應的<package>中就會自動擁有struts-default.xml中的所有配置信息了。具體代碼如下：

[html] view plain copy
  1. <package name="demo" extends="struts-default" > ... </package>  


  2、Demo


       想要使用攔截器必須要經過配置，struts2採用的是映射的方法，所以想用使用某一個功能就必須在配置文件中配置，攔截器也不例外。所以必須在package中添加相應的攔截器元素，同時將攔截器關聯相應的class文件，這樣在執行action前纔會執行相應的攔截器，具體使用方法如下。


      （1）添加配置文件struts.xml，並在該文件中添加攔截器

[html] view plain copy
  1. <package name="testLogin" namespace="/" extends="struts-default">  
  2.     <!-- 攔截器 -->  
  3.     <interceptors>  
  4.         <interceptor name="myInterceptor" class="com.interceptor.MyInterceptor"></interceptor>  
  5.     </interceptors>  
  6.           
  7.     <action name="demo" class="com.action.LoginAction">  
  8.         <result name="error" type="redirect">/error.jsp</result>  
  9.         <result name="success">/success.jsp</result>  
  10.         <result name="checkError">/checkSession.jsp</result>  
  11.         <interceptor-ref name="myInterceptor"></interceptor-ref>  
  12.         <interceptor-ref name="defaultStack"></interceptor-ref>  
  13.     </action>  
  14. </package>  

        上面的package中添加了一個名爲myInterceptor的攔截器，併爲該攔截器註冊了一個java類，該類名稱爲MyInterceptor，並被封存在com.interceptor包中。另外還在該package中添加了相應的action，在執行該action前會首先執行myInterceptor攔截器。


      （2）編寫被註冊的攔截器類MyInterceptor，該類必須實現com.opensymphoy.xwork2.interceptor.Interceptor接口，並重寫相應的方法

[java] view plain copy
  1. package com.interceptor;  
  2.   
  3. import java.util.Map;  
  4.   
  5. import com.entity.User;  
  6. import com.opensymphony.xwork2.ActionContext;  
  7. import com.opensymphony.xwork2.ActionInvocation;  
  8. import com.opensymphony.xwork2.interceptor.Interceptor;  
  9.   
  10. public class MyInterceptor implements Interceptor{  
  11.   
  12.     private User user;  
  13.       
  14.       
  15.     public User getUser() {  
  16.         return user;  
  17.     }  
  18.   
  19.     public void setUser(User user) {  
  20.         this.user = user;  
  21.     }  
  22.   
  23.     @Override  
  24.     public void destroy() {  
  25.         // TODO Auto-generated method stub  
  26.         System.out.println("----destroy()----");  
  27.     }  
  28.   
  29.     @Override  
  30.     public void init() {  
  31.         // TODO Auto-generated method stub  
  32.         System.out.println("-----Init()-------");  
  33.     }  
  34.   
  35.     @Override  
  36.     public String intercept(ActionInvocation invocation) throws Exception {  
  37.         // TODO Auto-generated method stub  
  38.         System.out.println("----intercept()------");  
  39.         Map<String, Object> session= invocation.getInvocationContext().getSession();  
  40.         if(session.get("username")!=null){  
  41.             System.out.println("登陸成功！");          
  42.             //session.put("username",user.getUsername());  
  43.             return invocation.invoke();  
  44.         }else{  
  45.             System.out.println("登陸失敗！");  
  46.             return "checkError";  
  47.         }  
  48.     }  
  49.   
  50. }  


       （3）經過前面兩步後，攔截器已經配置完成，最後一部就是使用攔截器了，在顯示頁面上添加相應的標籤，併爲標籤指定上面創建的名爲demo的action，然後執行頁面即可在控制檯中打印出相應的攔截器內容。

[html] view plain copy
  1. <%@ page language="java" contentType="text/html; charset=UTF-8"  
  2.     pageEncoding="UTF-8"%>  
  3. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  
  4. <html>  
  5. <head>  
  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  
  7. <title>Insert title here</title>  
  8. </head>  
  9. <body>  
  10.     <form action="demo">  
  11.         用戶名：<input type="text" name="username"><br>  
  12.         密  碼：<input type="text" name="password"><br>  
  13.         <input type="submit" name="ok" value="提交">  
  14.     </form>  
  15. </body>  
  16. </html>  

打印輸出內容：

        分析輸出結果，程序編譯階段首先會去讀取配置文件struts.xml，在該配置文件action中順序查找是否添加了攔截器，如果添加了攔截器則根據攔截器名稱在<interceptors>中查找是否定義了該攔截器或者攔截器棧，如果發現定義的是攔截器則根據攔截器查找對應的註冊的class，最後在包內查找註冊的class並執行相應的init()方法；程序運行階段的大致流程和編譯階段類似，用戶在前臺提交請求後，會按照註冊的action在struts.xml中查找與之相對應的，如果查找到將會查找攔截器，沒有查找到的話會相應的拋錯，最後執行攔截器註冊類的intercept方法。


  3、攔截器棧


       攔截器同樣有棧的概念，它是將使用的攔截器定義到共有的狀態下來實現統一管理，這樣在package中就可以做到攔截器的共享了，大大便利了攔截器的使用。在一個package中往往會用到重複的interceptor，如果每次都在Action中添加interceptor-ref的話就會很麻煩，那麼攔截器棧就是爲了解決這個問題而產生的，具體配置如下：

[html] view plain copy
  1. <package name="testLogin" namespace="/" extends="struts-default">  
  2.         <!-- 攔截器 -->  
  3.         <interceptors>  
  4.             <interceptor name="myInterceptor" class="com.interceptor.MyInterceptor"></interceptor>  
  5.             <!-- 定義公共的攔截器鏈，在action標籤中只需要引用攔截器鏈 -->  
  6.             <interceptor-stack name="defaultstack1">  
  7.                 <interceptor-ref name="myInterceptor"></interceptor-ref>  
  8.                 <interceptor-ref name="defaultStack"></interceptor-ref>  
  9.             </interceptor-stack>  
  10.         </interceptors>  
  11.           
  12.         <action name="demo" class="com.action.LoginAction">  
  13.             <result name="error" type="redirect">/error.jsp</result>  
  14.             <result name="success">/success.jsp</result>  
  15.             <result name="checkError">/checkSession.jsp</result>  
  16.             <interceptor-ref name="defaultstack1"></interceptor-ref>  
  17.         </action>  
  18. </package>  

        實例中使用了interceptor-stack來定義了一個名稱爲defaultstack1的攔截器棧，在該棧中添加了要執行的攔截器，把攔截器做了封裝，在Action中直接調用該攔截器棧即可，實現了攔截器棧的共享。


  4、默認攔截器棧


        另外可以定義默認的攔截器棧，即：如果某個Action中沒有定義攔截器，那麼它會默認執行該公共的攔截器。它和interceptors標籤屬於同一等級的，使用default-interceptor-ref定義。

[html] view plain copy
  1. <package name="testLogin" namespace="/" extends="struts-default">  
  2.     <!-- 攔截器 -->  
  3.     <interceptors>  
  4.         <interceptor name="myInterceptor" class="com.interceptor.MyInterceptor"></interceptor>  
  5.         <!-- 定義公共的攔截器鏈，在action標籤中只需要引用攔截器鏈 -->  
  6.         <interceptor-stack name="defaultinter">  
  7.             <interceptor-ref name="myInterceptor"></interceptor-ref>  
  8.             <interceptor-ref name="defaultStack"></interceptor-ref>  
  9.         </interceptor-stack>  
  10.     </interceptors>  
  11.       
  12.     <!-- 定義默認的攔截器棧，會自動註冊到action中 -->  
  13.     <default-interceptor-ref name="defaultinter"></default-interceptor-ref>  
  14.       
  15.     <action name="demo" class="com.action.LoginAction">  
  16.         <result name="error" type="redirect">/error.jsp</result>  
  17.         <result name="success">/success.jsp</result>  
  18.         <result name="checkError">/checkSession.jsp</result>  
  19.     </action>  
  20. </package>  

      定義的默認的攔截器棧只是在Action沒有指定攔截器的情況下才執行自定義默認的攔截器棧的，如果在Action中重定義了攔截器，那麼它會覆蓋自定義默認的攔截器棧的。

  5、不執行任何攔截器


      還有一種情況是一個package中定義了默認的攔截器，但是在編寫的某個Action中並不需要執行任何攔截器，那麼此時可以在相應的Action中添加一個名稱爲defaultStack的攔截器即可，它是系統默認的攔截器，不會有任何操作。

[html] view plain copy
  1. <package name="testLogin" namespace="/" extends="struts-default">  
  2.     <!-- 攔截器 -->  
  3.     <interceptors>  
  4.         <interceptor name="myInterceptor" class="com.interceptor.MyInterceptor"></interceptor>  
  5.         <!-- 定義公共的攔截器鏈，在action標籤中只需要引用攔截器鏈 -->  
  6.         <interceptor-stack name="defaultinter">  
  7.             <interceptor-ref name="myInterceptor"></interceptor-ref>  
  8.             <interceptor-ref name="defaultStack"></interceptor-ref>  
  9.         </interceptor-stack>  
  10.     </interceptors>  
  11.       
  12.     <!-- 定義默認的攔截器棧，會自動註冊到action中 -->  
  13.     <default-interceptor-ref name="defaultinter"></default-interceptor-ref>  
  14.       
  15.     <action name="demo" class="com.action.LoginAction">  
  16.         <result name="error" type="redirect">/error.jsp</result>  
  17.         <result name="success">/success.jsp</result>  
  18.         <result name="checkError">/checkSession.jsp</result>  
  19.           
  20.         <!-- 添加defaultStack保證不執行攔截器 -->  
  21.         <interceptor-ref name="defaultStack"></interceptor-ref>  
  22.     </action>  
  23. </package>  


  6、攔截方法


      6.1 用法

        上面的攔截器只是實現了對Action的攔截，其實攔截器的功能很強大，它也可以攔截相應Action方法。和攔截Action不同的是想要攔截方法就必須繼承類MethodFilterInterceptor，該類封存在xwork-core.jar中，又一次證明了WebWork是Struts2的核心。另外還需要在配置文件中添加相應的屬性來確定攔截的方法和不攔截的方法，具體配置方法如下：

[html] view plain copy
  1. <package name="testLogin" namespace="/" extends="struts-default">  
  2.     <!-- 攔截器 -->  
  3.     <interceptors>  
  4.         <interceptor name="myInterceptor" class="com.interceptor.MyInterceptor"></interceptor>  
  5.         <!-- 定義公共的攔截器鏈，在action標籤中只需要引用攔截器鏈 -->  
  6.         <interceptor-stack name="defaultinter">  
  7.             <interceptor-ref name="myInterceptor"></interceptor-ref>  
  8.             <interceptor-ref name="defaultStack"></interceptor-ref>  
  9.         </interceptor-stack>  
  10.     </interceptors>  
  11.       
  12.     <action name="demo" class="com.action.LoginAction">  
  13.         <result name="error" type="redirect">/error.jsp</result>  
  14.         <result name="success">/success.jsp</result>  
  15.         <result name="checkError">/checkSession.jsp</result>  
  16.           
  17.         <!-- 在defaultStack中配置攔截方法，參數includeMethods中添加被攔截的方法名稱，excludeMethods中添加不需要攔截的名稱 -->  
  18.         <interceptor-ref name="defaultStack">  
  19.             <param name="includeMethods">添加要攔截的方法名稱</param><!-- 攔截方法 -->  
  20.             <param name="excludeMethods">添加不需要攔截的方法名稱</param><!-- 不攔截方法 -->  
  21.         </interceptor-ref>  
  22.     </action>  
  23. </package>  

      繼承MethodFilterInterceptor類的相應攔截方法的類中的代碼：

[java] view plain copy
  1. package com.interceptor;  
  2.   
  3. import java.util.Map;  
  4. import com.opensymphony.xwork2.ActionContext;  
  5. import com.opensymphony.xwork2.ActionInvocation;  
  6. import com.opensymphony.xwork2.interceptor.MethodFilterInterceptor;  
  7.   
  8. public class inter extends MethodFilterInterceptor {  
  9.   
  10.     @Override  
  11.     public String doIntercept(ActionInvocation invocation) throws Exception {  
  12.         System.out.println("--intercept()--");  
  13.         //獲取相應的Session  
  14.         Map<String,Object> session=invocation.getInvocationContext().getSession();  
  15.           
  16.         Map request=(Map)ActionContext.getContext().get("request");  
  17.           
  18.         String username=(String)request.get("user.username");  
  19.         if(session.get("username") != null){  
  20.             String result=invocation.invoke();  
  21.               
  22.             System.out.println("--end()--");  
  23.             return result;  
  24.         }  
  25.     }  
  26.   
  27. }  

    6.2 Demo

       來看一個攔截方法的實例，並對結果進行分析。下面的實例演示攔截方法的輸出結果，在實例中分別創建了一個loginAction類，添加Action要執行的方法；Inter類，攔截器中重寫MethodFilterInterceptor方法，在控制檯中輸出是否對某個方法進行攔截；login.jsp文件，添加三個按鈕，分別演示三個方法的執行。

      （1）struts.xml內方法攔截器的定義，在package中定義了一個名稱爲inter的攔截器，在攔截器中指定了參數，includeMethods用來攔截Method1，excludeMethods中的Method2表示不攔截Methods2方法，具體配置如下代碼：

[html] view plain copy
  1. <!DOCTYPE struts PUBLIC  
  2.           "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"  
  3.           "http://struts.apache.org/dtds/struts-2.0.dtd">  
  4. <struts>  
  5.     <constant name="struts.action.extension" value=","></constant>  
  6.       
  7.     <package name="login" extends="struts-default">    
  8.         <interceptors>  
  9.             <interceptor name="inter" class="com.interceptor.inter">  
  10.                 <param name="includeMethods">Method1</param> <!-- 攔截Method1方法 -->  
  11.                 <param name="excludeMethods">Method2</param>  
  12.             </interceptor>  
  13.             <interceptor-stack name="myInterceptor">  
  14.                 <interceptor-ref name="inter"></interceptor-ref>  
  15.                 <interceptor-ref name="defaultStack"></interceptor-ref>  
  16.             </interceptor-stack>  
  17.         </interceptors>  
  18.               
  19.         <action name="loginaction" class="com.action.loginAction">  
  20.             <result name="success">success.jsp</result>  
  21.             <result name="error">error.jsp</result>  
  22.             <result name="cancel" type="redirectAction">Welcome</result>  
  23.             <interceptor-ref name="inter"></interceptor-ref>  
  24.             <interceptor-ref name="defaultStack"></interceptor-ref>  
  25.         </action>  
  26.     </package>  
  27. </struts>  

       （2）loginAction類，配置login.jsp中的action，分別在該類中添加Method1-Method3三個方法，其中Method1被攔截，Method2和Method3不被攔截，最後我們查看輸出結果。

[java] view plain copy
  1. package com.action;  
  2.   
  3. import com.opensymphony.xwork2.ActionSupport;  
  4.   
  5. public class loginAction extends ActionSupport {  
  6.     @Override  
  7.     public String execute() throws Exception {  
  8.         if(this.username.equals("admin") && this.password.equals("admin")){  
  9.             return "success";  
  10.         }else if(this.username.equals("cancel") && this.password.equals("cancel")){  
  11.             return "cancel";  
  12.         }else{  
  13.             return "error";  
  14.         }  
  15.     }  
  16.       
  17.     public void Method1(){  
  18.         System.out.println("執行方法:Method1");  
  19.     }  
  20.       
  21.     public void Method2(){  
  22.         System.out.println("執行方法:Method2");  
  23.     }  
  24.       
  25.     public void Method3(){  
  26.         System.out.println("執行方法:Method3");  
  27.     }  
  28.       
  29.     private String username;  
  30.     private String password;  
  31.       
  32.     public String getUsername(){  
  33.         return this.username;  
  34.     }  
  35.       
  36.     public void setUsername(String username){         
  37.         this.username=username;  
  38.     }  
  39.       
  40.     public String getPassword(){  
  41.         return this.password;  
  42.     }  
  43.       
  44.     public void setPassword(String password){  
  45.         this.password=password;  
  46.     }  
  47.       
  48.       
  49. }  

        （3）inter類，繼承MethodFilterInterceptor類，用來實現攔截方法。重寫doIntercept方法，在該方法中添加攔截的相應信息。
[java] view plain copy
  1. package com.interceptor;  
  2.   
  3. import java.util.Date;  
  4. import java.util.Map;  
  5.   
  6. import com.action.loginAction;  
  7. import com.opensymphony.xwork2.ActionContext;  
  8. import com.opensymphony.xwork2.ActionInvocation;  
  9. import com.opensymphony.xwork2.interceptor.MethodFilterInterceptor;  
  10.   
  11. public class inter extends MethodFilterInterceptor {  
  12.       
  13.     @Override  
  14.     protected String doIntercept(ActionInvocation invocation) throws Exception {  
  15.         // TODO Auto-generated method stub    
  16.          System.out.println("攔截器在Action執行前攔截"+new Date());    
  17.          String result=invocation.invoke();  //執行Action方法  
  18.          System.out.println("攔截器在Action執行後攔截"+new Date());    
  19.         return result;    
  20.   
  21.     }  
  22.   
  23. }  

     （4）login.jsp，在jsp頁面上添加三個按鈕，分別演示三個方法，判斷攔截器對方法的攔截情況。三個按鈕在點擊後回發的action是在javascript中動態的進行添加的，這樣做達到了一個form中執行不同的action的方法，當然還有其它的方法，將會在下篇文章中討論。
[html] view plain copy
  1. <%@ page language="java" contentType="text/html; charset=UTF-8"  
  2.     pageEncoding="UTF-8"%>  
  3. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  
  4. <html>  
  5. <head>  
  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  
  7. <title>Insert title here</title>  
  8. <script type="text/javascript">  
  9.       
  10.     //方法1，定義被攔截的方法的實例  
  11.     function method1(){  
  12.         var form=document.forms[0];  
  13.         form.action="loginaction!Method1";  
  14.         form.submit();  
  15.     }  
  16.       
  17.     //方法2，爲按鈕2添加不攔截的方法  
  18.     function method2(){  
  19.         var form=document.forms[0];  
  20.         form.action="loginaction!Method2";  
  21.         form.submit();  
  22.     }  
  23.       
  24.     //方法3，爲按鈕3添加不攔截的方法  
  25.     function method3(){  
  26.         var form=document.forms[0];  
  27.         form.action="loginaction!Method3";  
  28.         form.submit();  
  29.     }  
  30. </script>  
  31. </head>  
  32. <body>  
  33.     <form>  
  34.         用戶名：<input type="text" name="username"><br>  
  35.         密     碼：<input type="text" name="password"><br>  
  36.         <input type="submit" name="ok" value="按鈕1" onclick="method1()">  
  37.         <input type="submit" name="ok1" value="按鈕2" onclick="method2()">  
  38.         <input type="submit" name="ok2" value="按鈕3" onclick="method3()">  
  39.     </form>  
  40. </body>  
  41. </html>  

        運行完成後的頁面視圖：
              
       （5）分析運行結果，分別單擊按鈕1、2、3，在控制檯中輸出結果，按鈕1是綁定的method1，該方法在struts.xml中進行了攔截如果結果正確的話會顯示被攔截的結果，而相應的按鈕2和3只輸出運行結果，因爲它們沒有被攔截。那看下面的結果圖：

        結果圖正好正是了我們的分析結果，按鈕1被攔截了，執行了inter類中的doIntercept方法，二相應的按鈕2和3沒有被攔截。也就是說，Method1被放到了方法攔截器的白名單內，執行要攔截該方法；Method2被放到了攔截器黑名單內，不需要攔截該方法；Method3不做任何處理。
發表評論
所有評論
還沒有人評論，想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章

如何向json文件中寫入數據

迷迷糊 2018-09-03 17:39:34

power designer 導入java類生成表格關係圖

迷迷糊 2018-09-03 17:39:34

datagrid 如何通過單擊表格的某一行或者某一格來更改內容

迷迷糊 2018-09-03 17:39:34

給input標籤添加默認提示信息及設置默認提示信息字體顏色

迷迷糊 2018-09-03 17:39:34

從action能否返回list集合到ajax

迷迷糊 2018-09-03 17:39:34

如何獲取父節點，兄弟節點以及子節點然後遍歷

迷迷糊 2018-09-03 17:39:16