Struts2拦截器

Posted 2020-06-14

Struts2拦截器

拦截器的工作原理如下图，在工作的时候每一个Action请求都被包装在一堆拦截器的内部。拦截器可以在Action执行之前做操作也可以在Action执行之后做操作。 

每一个Action既可以将操作转交给下一个拦截器，Action也可以直接退出操作返回客户指定的页面。

 

1、如何使用Struts2自带的拦截器： 
在Struts2中已经在struts-default.xml中预定义了一些自带的拦截器，如timer、params等。如果在<package>标签中继承struts-default，则当前package就会自动拥有struts-default.xml中的所有配置。代码如下： 
<package name="system" extends="struts-default" > 

    ............

</package> 

在struts-default.xml中有一个默认的引用，在默认情况下（也就是<action>中未引用拦截器时）会自动引用一些拦截器。这个默认的拦截器引用如下： 

 

面在defaultStack中引用的拦截器都可以在<action>中不经过引用就可以使用（如果在<action>中手动的引用了任何拦截器后，要使用在defaultStack中定义的拦截器，也需要在<action>中重新引用。

下面我们来看几个简单的拦截器的使用方法：

①　记录拦截器和execute方法的执行时间(timer拦截器) 

timer是Struts2中最简单的拦截器，这个拦截器对应的类是com.opensymphony.xwork2.interceptor.TimerInterceptor。它的功能是记录execute方法和其他拦截器（在timer后面定义的拦截器）的intercept方法执行的时间总和。如下面的配置代码所示：

<action name="first" class="action.FirstAction">  

    <interceptor-ref name="logger"/>  

    <interceptor-ref name="timer" />  

</action>  

 

由于在timer后面没有其他的拦截器定义，因此，timer只能记录execute方法的执行时间，在访问first动作时，会在控制台输出类似下面的一条信息： 

信息: Executed action [/test/first!execute] took 16 ms. 

在使用timer拦截器时，需要commons-logging.jar的支持。将logger引用放到timer的后面，就可以记录logger拦截器的intercept方法和Action的execute方法的执行时间总和，代码如下： 

<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(2000); 

           return null;  

       }    

}  

如果只记录execute方法的执行时间，一般会输出如下的信息： 
信息: Executed action [/test/first!execute] took 2000 ms. 

 

总结：

1、手动定义拦截器的时候，必须要手动的引用默认的拦截器栈。

2、拦截器的工作顺序，是根据定义的位置来执行的（有顺序的）。

 

②　通过请求调用Action的setter方法(params) 

当客户端的一个form向服务端提交请求时，如有一个textfield，代码如下： 

<s:form action="first" namespace="/test">  

   <s:textfield name="name"/>  

   <s:submit/>  

</s:form>  

在提交后，Struts2将会自动调用first动作类中的setName方法，并将name文本框中的值通过setName方法的参数传入。实际上，这个操作是由params拦截器完成的，params对应的类是com.opensymphony.xwork2.interceptor.ParametersInterceptor。由于params已经在defaultStack中定义，因此，在未引用拦截器的<action>中是会自动引用params的，如下面的配置代码，在访问first动作时，Struts2是会自动执行相应的setter方法的。 

但如果在<action>中引用了其他的拦截器，就必须再次引用params拦截器，Struts2才能调用相应的setter方法。如下面的配置代码所示： 

<action name="first" class="action.FirstAction">  

    <interceptor-ref name="timer" />  

    <interceptor-ref name="params"/>  

</action>  

③　通过配置参数调用Action的setter方法(staticparams) 

staticparams拦截器可以通过配置<param>标签来调用Action类的相应的setter方法，staticparams

拦截器对应的类是

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="staticparams"/>  

</action>  

如果first动作使用上面的配置，在访问first动作时，Struts2会自动调用setWho方法将“刘德华”作为参数值传入setWho方法。 

④　使用拦截器栈 

为了能在多个动作中方便地引用同一个或几个拦截器，可以使用拦截器栈将这些拦截器作为一个整体来引用。拦截器栈要在<package>标签中使用<interceptors>和子标签<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="staticparams" />  

        </interceptor-stack>  

    </interceptors>  

  

    <action name="first" class="action.FirstAction">  

        <param name="who">刘德华</param>  

        <interceptor-ref name="mystack"/>              

    </action>  

</package> 

这样一来，我们就可以象使用拦截器一样使用拦截器栈。也可以理解为是拦截器的打包。如何自定义一个拦截器？ 

自定义一个拦截器，我们需要三步就可以完成了： 
1 自定义一个实现Interceptor接口（或者继承自AbstractInterceptor）的类。 
2 在strutx.xml中注册刚刚定义好的拦截器。 
3 在需要使用的Action中引用上述定义的拦截器，为了方便也可将拦截器定义为默认的拦截器，这样在不加特殊声明的情况下所有的Action都被这个拦截器拦截。 

Interceptor接口声明了三个方法： 

1. public interface Interceptor extends Serializable {  
3. void destroy();  
5. void init();  
7. String intercept(ActionInvocation invocation) throws Exception;  
8. }  

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

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

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

另外源码中AbstractInterceptor提供了一个简单的Interceptor的实现，这个实现为： 

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

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

 

自定义一个拦截器，实现相应的功能，体现自定义拦截器的使用.............

依靠代码来进行演示...........

登录权限的应用？

 

登录页面login.jsp-----------用户名的输入框

进入到系统中的操作界面-------------点击使用系统了。

使用自定义的拦截器完成对登录的权限的限制。

 

如果登录成功--------session保存成功的用户账号------>

（加入自定义的拦截器进行账号的验证）

      具有权限------>正常的进行相应的页面。

      没有权限------>结束访问，进入指定的提示页面。

----> 系统中操作Action（save方法）

 

需要说明的几点： 
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>  

 执行顺序为：

1. thisWillRunFirstInterceptor  
2. thisWillRunNextInterceptor  
3. followedByThisInterceptor  
4. thisWillRunLastInterceptor  
5. MyAction1  
6. MyPreResultListener  
7. MyResult (result)  
8. thisWillRunLastInterceptor  
9. followedByThisInterceptor  
10. thisWillRunNextInterceptor  
11. thisWillRunFirstInterceptor