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接口声明了三个方法:

 


    
    
    
    
  1. public interface Interceptor extends Serializable { 
  2.     void destroy(); 
  3.     void init(); 
  4.     String intercept(ActionInvocation invocation) throws Exception; 

 

Init方法在拦截器类被创建之后,在对Action镜像拦截之前调用,相当于一个post-constructor方法,使用这个方法可以给拦截器类做必要的初始话操作。

 

Destroy方法在拦截器被垃圾回收之前调用,用来回收init方法初始化的资源。

 

Intercept是拦截器的主要拦截方法,如果需要调用后续的Action或者拦截器,只需要在该方法中调用invocation.invoke()方法即可,在该方法调用的前后可以插入Action调用前后拦截器需要做的方法。如果不需要调用后续的方法,则返回一个String类型的对象即可,例如Action.SUCCESS。

另外AbstractInterceptor提供了一个简单的Interceptor的实现,这个实现为:


    
    
    
    
  1. public abstract class AbstractInterceptor implements Interceptor { 
  2.      public void init() { 
  3.     } 
  4.     public void destroy() { 
  5.     } 
  6.     public abstract String intercept(ActionInvocation invocation) throws Exception; 

在不需要编写init和destroy方法的时候,只需要从AbstractInterceptor继承而来,实现intercept方法即可。

 

我们尝试编写一个Session过滤用的拦截器,该拦截器查看用户Session中是否存在特定的属性(LOGIN属性)如果不存在,中止后续操作定位到LOGIN,否则执行原定操作,代码为:


    
    
    
    
  1. public class CheckLoginInterceptor extends AbstractInterceptor { 
  2.     public static final String LOGIN_KEY = "LOGIN"
  3.     public static final String LOGIN_PAGE = "global.login"
  4.     public String intercept(ActionInvocation actionInvocation) throws Exception { 
  5.         System.out.println("begin check login interceptor!"); 
  6.         // 对LoginAction不做该项拦截 
  7.         Object action = actionInvocation.getAction(); 
  8.         if (action instanceof LoginAction) { 
  9.             System.out.println("exit check login, because this is login action."); 
  10.             return actionInvocation.invoke(); 
  11.         } 
  12.         // 确认Session中是否存在LOGIN 
  13.         Map session = actionInvocation.getInvocationContext().getSession(); 
  14.         String login = (String) session.get(LOGIN_KEY); 
  15.         if (login != null && login.length() > 0) { 
  16.             // 存在的情况下进行后续操作。 
  17.             System.out.println("already login!"); 
  18.             return actionInvocation.invoke(); 
  19.         } else { 
  20.             // 否则终止后续操作,返回LOGIN 
  21.             System.out.println("no login, forward login page!"); 
  22.             return LOGIN_PAGE; 
  23.         } 
  24.     } 

 

注册拦截器


    
    
    
    
  1. <interceptors> 
  2.         <interceptor name="login" class="com.jpleasure.teamware.util.CheckLoginInterceptor"/> 
  3.             <interceptor-stack name="teamwareStack"> 
  4.                 <interceptor-ref name="login"/> 
  5.                 <interceptor-ref name="defaultStack"/> 
  6.             </interceptor-stack> 
  7. </interceptors> 

将上述拦截器设定为默认拦截器:

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

这样在后续同一个package内部的所有Action执行之前都会被login拦截。

 

注册并引用Interceptor


    
    
    
    
  1. <package name="default" extends="struts-default"> 
  2.    <interceptors> 
  3.        <interceptor name="timer" class=".."/> 
  4.        <interceptor name="logger" class=".."/> 
  5.    </interceptors>  
  6.    <action name="login" class="tutorial.Login"> 
  7.         <interceptor-ref name="timer"/> 
  8.         <interceptor-ref name="logger"/> 
  9.         <result name="input">login.jsp</result> 
  10.         <result name="success" 
  11.             type="redirect-action">/secure/home</result> 
  12.    </action> 
  13. </package> 

 

可以将多个拦截器合并在一起作为一个堆栈调用,当一个拦截器堆栈被附加到一个Action的时候,要想Action执行,必须执行拦截器堆栈中的每一个拦截器。


    
    
    
    
  1. <package name="default" extends="struts-default"> 
  2.    <interceptors> 
  3.         <interceptor name="timer" class=".."/> 
  4.         <interceptor name="logger" class=".."/> 
  5.         <interceptor-stack name="myStack"> 
  6.            <interceptor-ref name="timer"/> 
  7.            <interceptor-ref name="logger"/> 
  8.         </interceptor-stack> 
  9.     </interceptors> 
  10.   
  11.     <action name="login" class="tutuorial.Login"> 
  12.          <interceptor-ref name="myStack"/> 
  13.          <result name="input">login.jsp</result> 
  14.          <result name="success" 
  15.              type="redirect-action">/secure/home</result> 
  16.     </action> 
  17. </package> 

 

上述说明的拦截器在默认的Struts2应用中,根据惯例配置了若干个拦截器堆栈,详细情参看struts-default.xml

其中有一个拦截器堆栈比较特殊,他会应用在默认的每一个Action上。


    
    
    
    
  1. <interceptor-stack name="defaultStack"> 
  2.     <interceptor-ref name="exception"/> 
  3.     <interceptor-ref name="alias"/> 
  4.     <interceptor-ref name="servletConfig"/> 
  5.     <interceptor-ref name="prepare"/> 
  6.     <interceptor-ref name="i18n"/> 
  7.     <interceptor-ref name="chain"/> 
  8.     <interceptor-ref name="debugging"/> 
  9.     <interceptor-ref name="profiling"/> 
  10.     <interceptor-ref name="scopedModelDriven"/> 
  11.     <interceptor-ref name="modelDriven"/> 
  12.     <interceptor-ref name="fileUpload"/> 
  13.     <interceptor-ref name="checkbox"/> 
  14.     <interceptor-ref name="staticParams"/> 
  15.     <interceptor-ref name="params"> 
  16.       <param name="excludeParams">dojo"..*</param> 
  17.     </interceptor-ref> 
  18.     <interceptor-ref name="conversionError"/> 
  19.     <interceptor-ref name="validation"> 
  20.         <param name="excludeMethods">input,back,cancel,browse</param> 
  21.     </interceptor-ref> 
  22.     <interceptor-ref name="workflow"> 
  23.         <param name="excludeMethods">input,back,cancel,browse</param> 
  24.     </interceptor-ref> 
  25. </interceptor-stack> 

 

每一个拦截器都可以配置参数,有两种方式配置参数,一是针对每一个拦截器定义参数,二是针对一个拦截器堆栈统一定义所有的参数,例如:


    
    
    
    
  1. <interceptor-ref name="validation"> 
  2.  <param name="excludeMethods">myValidationExcudeMethod</param> 
  3. </interceptor-ref> 
  4. <interceptor-ref name="workflow"> 
  5.  <param name="excludeMethods">myWorkflowExcludeMethod</param> 
  6. </interceptor-ref> 

或者


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

 

每一个拦截器都有两个默认的参数:

excludeMethods - 过滤掉不使用拦截器的方法和

includeMethods – 使用拦截器的方法。

 

需要说明的几点:

1 拦截器执行的顺序按照定义的顺序执行,例如:


    
    
    
    
  1. <interceptor-stack name="xaStack"> 
  2.    <interceptor-ref name="thisWillRunFirstInterceptor"/> 
  3.    <interceptor-ref name="thisWillRunNextInterceptor"/> 
  4.    <interceptor-ref name="followedByThisInterceptor"/> 
  5.    <interceptor-ref name="thisWillRunLastInterceptor"/> 
  6. </interceptor-stack> 

的执行顺序为:

thisWillRunFirstInterceptor

 thisWillRunNextInterceptor

    followedByThisInterceptor

      thisWillRunLastInterceptor

        MyAction1

        MyAction2 (chain)

        MyPreResultListener

        MyResult (result)

      thisWillRunLastInterceptor

    followedByThisInterceptor

 thisWillRunNextInterceptor

thisWillRunFirstInterceptor

 

2 使用默认拦截器配置每个Action都需要的拦截器堆栈,例如:


    
    
    
    
  1. <action name="login" class="tutorial.Login"> 
  2.      <interceptor-ref name="timer"/> 
  3.      <interceptor-ref name="logger"/> 
  4.      <interceptor-ref name="default-stack"/> 
  5.   
  6.      <result name="input">login.jsp</result> 
  7.      <result type="redirect-action">/secure/home</result> 
  8. </action> 

可以按照如下的方式定义:


    
    
    
    
  1. <interceptors> 
  2.      <interceptor-stack name="myStack"> 
  3.         <interceptor-ref name="timer"/> 
  4.         <interceptor-ref name="logger"/> 
  5.         <interceptor-ref name="default-stack"/> 
  6.      </interceptor-stack> 
  7. </interceptors> 
  8.   
  9. <default-interceptor-ref name="myStack"/> 
  10.   
  11. <action name="login" class="tutorial.Login"> 
  12.        <result name="input">login.jsp</result> 
  13.        <result type="redirect-action">/secure/home</result> 
  14. </action> 

 

3 如何访问HttpServletRequest,HttpServletResponse或者HttpSession

有两种方法可以达到效果,使用ActionContext

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

或者实现相应的接口:

HttpSession            SessionAware

HttpServletRequest     ServletRequestAware

HttpServletResponse    ServletResponseAware

 

你可能感兴趣的:(struts,拦截器,2)