• 热门专题

Struts2拦截器原理以及实例

作者:清凉一冬  发布日期:2014-09-09 23:02:31
Tag标签:实例  原理  
  • 一、Struts2拦截器定义

    1. Struts2拦截器是在访问某个Action或Action的某个方法,字段之前或之后实施拦截,并且Struts2拦截器是可插拔的,拦截器是AOP的一种实现.

    2. 拦截器栈(Interceptor Stack)。Struts2拦截器栈就是将拦截器按一定的顺序联结成一条链。在访问被拦截的方法或字段时,Struts2拦截器链中的拦截器就会按其之前定义的顺序被调用。

    二、实现Struts2拦截器原理

      Struts 2的拦截器实现相对简单。当请求到达Struts2的ServletDispatcher时,Struts 2会查找配置文件,并根据其配置实例化相对的拦截器对象,然后串成一个列表(list),最后一个一个地调用列表中的拦截器。事实上,我们之所以能够如此灵活地使用拦截器,完全归功于“动态代理”的使用。动态代理是代理对象根据客户的需求做出不同的处理。对于客户来说,只要知道一个代理对象就行了。

    那Struts2中,拦截器是如何通过动态代理被调用的呢?当Action请求到来的时候,会由系统的代理生成一个Action的代理对象,由这个代理对象调用Action的execute()或指定的方法,并在struts.xml中查找与该Action对应的拦截器。如果有对应的拦截器,就在Action的方法执行前(后)调用这些拦截器;如果没有对应的拦截器则执行Action的方法。其中系统对于拦截器的调用,是通过ActionInvocation来实现的。代码如下:

    if (interceptors.hasNext()) {  
      Interceptor interceptor=(Interceptor)interceptors.next();  
      resultCode = interceptor.intercept(this);  
    } else {  
      if (proxy.getConfig().getMethodName() == null) {  
        resultCode = getAction().execute();  
      } else {  
        resultCode = invokeAction(getAction(), proxy.getConfig());  
    } }

    三.拦截器执行分析

         Interceptor的接口定义没有什么特别的地方,除了init和destory方法以外,intercept方法是实现整个拦截器机制的核心方法。而它所依赖的参数ActionInvocation则是著名的Action调度者。我们再来看看一个典型的Interceptor的抽象实现类:

    public abstract class AroundInterceptor extends AbstractInterceptor {  
    /* (non-Javadoc) 
     * @see com.opensymphony.xwork2.interceptor.AbstractInterceptor#intercept(com.opensymphony.xwork2.ActionInvocation)  
     */  
      @Override  
      public String intercept(ActionInvocation invocation) throws Exception {  
         String result = null;  
            before(invocation);  
      // 调用下一个拦截器,如果拦截器不存在,则执行Action  
            result = invocation.invoke();  
            after(invocation, result);  
         return result;  
      }  
      public abstract void before(ActionInvocation invocation) throws Exception;  
      public abstract void after(ActionInvocation invocation, String resultCode) throws Exception;  
    }  

       在这个实现类中,实际上已经实现了最简单的拦截器的雏形。这里需要指出的是一个很重要的方法invocation.invoke()。这是ActionInvocation中的方法,而ActionInvocation是Action调度者,所以这个方法具备以下2层含义:
    1. 如果拦截器堆栈中还有其他的Interceptor,那么invocation.invoke()将调用堆栈中下一个Interceptor的执行。
    2. 如果拦截器堆栈中只有Action了,那么invocation.invoke()将调用Action执行。

       invocation.invoke()这个方法其实是整个拦截器框架的实现核心。基于这样的实现机制,我们还可以得到下面2个非常重要的推论:
    1. 如果在拦截器中,我们不使用invocation.invoke()来完成堆栈中下一个元素的调用,而是直接返回一个字符串作为执行结果,那么整个执行将被中止。
    2. 我们可以以invocation.invoke()为界,将拦截器中的代码分成2个部分,在invocation.invoke()之前的代码,将会在Action之前被依次执行,而在invocation.invoke()之后的代码,将会在Action之后被逆序执行。
    由此,我们就可以通过invocation.invoke()作为Action代码真正的拦截点,从而实现AOP。

    三.源码解析

            通过查看源码来看看Struts2是如何保证拦截器、Action与Result三者之间的执行顺序的。之前我曾经提到,ActionInvocation是Struts2中的调度器,所以事实上,这些代码的调度执行,是在ActionInvocation的实现类中完成的,这里,我抽取了DefaultActionInvocation中的invoke()方法,它将向我们展示一切。

    public String invoke() throws Exception {  
        String profileKey = "invoke: ";  
      try {  
           UtilTimerStack.push(profileKey);  
         if (executed) {  
            throw new IllegalStateException("Action has already executed");  
           }  
         // 依次调用拦截器堆栈中的拦截器代码执行  
        if (interceptors.hasNext()) {  
            final InterceptorMapping interceptor = (InterceptorMapping) interceptors.next();  
              UtilTimerStack.profile("interceptor: "+interceptor.getName(),new UtilTimerStack.ProfilingBlock<String>() {  
              public String doProfiling() throws Exception {  
                // 将ActionInvocation作为参数,调用interceptor中的intercept方法执行  
                  resultCode = interceptor.getInterceptor().intercept(DefaultActionInvocation.this);  
                return null;  
              }  
             });  
           } else {  
               resultCode = invokeActionOnly();  
           }  
        // this is needed because the result will be executed, then control will return to the Interceptor, which will  
        // return above and flow through again  
        if (!executed) {  
          // 执行PreResultListener  
          if (preResultListeners != null) {  
            for (Iterator iterator = preResultListeners.iterator();iterator.hasNext();) {  
                 PreResultListener listener = (PreResultListener) iterator.next();  
                 String _profileKey="preResultListener: ";  
              try {  
                   UtilTimerStack.push(_profileKey);  
                   listener.beforeResult(this, resultCode);  
                 }finally {  
                   UtilTimerStack.pop(_profileKey);  
                 }  
               }  
             }  
          // now execute the result, if we're supposed to  
          // action与interceptor执行完毕,执行Result  
          if (proxy.getExecuteResult()) {  
               executeResult();  
             }    
             executed = true;  
           }  
        return resultCode;  
        }finally {  
         UtilTimerStack.pop(profileKey);  
        }  
    }  

     从源码中,我们可以看到Action层的4个不同的层次,在这个方法中都有体现,他们分别是:拦截器(Interceptor)、Action、PreResultListener和Result。在这个方法中,保证了这些层次的有序调用和执行。由此我们也可以看出Struts2在Action层次设计上的众多考虑,每个层次都具备了高度的扩展性和插入点,使得程序员可以在任何喜欢的层次加入自己的实现机制改变Action的行为。
    在这里,需要特别强调的,是其中拦截器部分的执行调用:

    resultCode = interceptor.getInterceptor().intercept(DefaultActionInvocation.this); 

    原来在intercept()方法又对ActionInvocation的invoke()方法进行递归调用,ActionInvocation循环嵌套在intercept()中,一直到语句result = invocation.invoke()执行结束。这样,Interceptor又会按照刚开始执行的逆向顺序依次执行结束。一个有序链表,通过递归调用,变成了一个堆栈执行过程,将一段有序执行的代码变成了2段执行顺序完全相反的代码过程,从而巧妙地实现了AOP。这也就成为了Struts2的Action层的AOP基础。 

    拦截器和过滤器之间有很多相同之处,但是两者之间存在根本的差别。其主要区别为以下几点:
    1)拦截器是基于JAVA反射机制的,而过滤器是基于函数回调的。
    2)过滤器依赖于Servlet容器,而拦截器不依赖于Servlet容器
    3)拦截器只能对Action请求起作用,而过滤器可以对几乎所有的请求起作用。
    4)拦截器可以访问Action上下文、值栈里的对象,而过滤器不能
    5)在Action的生命周期中,拦截器可以多次被调用,而过滤器只能在容器初始化时被调用一次。

About IT165 - 广告服务 - 隐私声明 - 版权申明 - 免责条款 - 网站地图 - 网友投稿 - 联系方式
本站内容来自于互联网,仅供用于网络技术学习,学习中请遵循相关法律法规