文档章节

Struts2 拦截器 Interceptor结构

拷贝忍者卡卡习
 拷贝忍者卡卡习
发布于 2016/11/02 11:07
字数 2525
阅读 15
收藏 0

Interceptor结构 

让我们再来回顾一下之前我们曾经用过的一张Action LifeCycle(生命周期)的图: 

图中,我们可以发现,Struts2的Interceptor一层一层,把Action包裹在最里面。这样的结构,大概有以下一些特点: 

1. 整个结构就如同一个堆栈,除了Action以外,堆栈中的其他元素是Interceptor 

2. Action位于堆栈的底部。由于堆栈"先进后出"的特性,如果我们试图把Action拿出来执行,我们必须首先把位于Action上端的Interceptor拿出来执行。这样,整个执行就形成了一个递归调用 

3. 每个位于堆栈中的Interceptor,除了需要完成它自身的逻辑,还需要完成一个特殊的执行职责。这个执行职责有3种选择: 
 

  • 中止整个执行,直接返回一个字符串作为resultCode 
  • 通过递归调用负责调用堆栈中下一个Interceptor的执行 
  • 如果在堆栈内已经不存在任何的Interceptor,调用Action 


Struts2的拦截器结构的设计,实际上是一个典型的责任链模式的应用。首先将整个执行划分成若干相同类型的元素,每个元素具备不同的逻辑责任,并将他们纳入到一个链式的数据结构中(我们可以把堆栈结构也看作是一个递归的链式结构),而每个元素又有责任负责链式结构中下一个元素的执行调用。 

这样的设计,从代码重构的角度来看,实际上是将一个复杂的系统,分而治之,从而使得每个部分的逻辑能够高度重用并具备高度可扩展性。所以,Interceptor结构实在是Struts2/Xwork设计中的精华之笔。

Interceptor执行分析 

Interceptor的定义 

我们来看一下Interceptor的接口的定义:

public interface Interceptor extends Serializable {  
  
    /** 
     * Called to let an interceptor clean up any resources it has allocated. 
     */  
    void destroy();  
  
    /** 
     * Called after an interceptor is created, but before any requests are processed using 
     * {@link #intercept(com.opensymphony.xwork2.ActionInvocation) intercept} , giving 
     * the Interceptor a chance to initialize any needed resources. 
     */  
    void init();  
  
    /** 
     * Allows the Interceptor to do some processing on the request before and/or after the rest of the processing of the 
     * request by the {@link ActionInvocation} or to short-circuit the processing and just return a String return code. 
     * 
     * @return the return code, either returned from {@link ActionInvocation#invoke()}, or from the interceptor itself. 
     * @throws Exception any system-level error, as defined in {@link com.opensymphony.xwork2.Action#execute()}. 
     */  
    String intercept(ActionInvocation invocation) throws Exception;  
}  



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。 

Interceptor拦截类型 

从上面的分析,我们知道,整个拦截器的核心部分是invocation.invoke()这个函数的调用位置。事实上,我们也正式根据这句代码的调用位置,来进行拦截类型的区分的。在Struts2中,Interceptor的拦截类型,分成以下三类: 

1. before 

before拦截,是指在拦截器中定义的代码,它们存在于invocation.invoke()代码执行之前。这些代码,将依照拦截器定义的顺序,顺序执行。 

2. after 

after拦截,是指在拦截器中定义的代码,它们存在于invocation.invoke()代码执行之后。这些代码,将一招拦截器定义的顺序,逆序执行。 

3. PreResultListener 

有的时候,before拦截和after拦截对我们来说是不够的,因为我们需要在Action执行完之后,但是还没有回到视图层之前,做一些事情。Struts2同样支持这样的拦截,这种拦截方式,是通过在拦截器中注册一个PreResultListener的接口来实现的。 

public interface PreResultListener {  
  
    /** 
     * This callback method will be called after the Action execution and before the Result execution. 
     * 
     * @param invocation 
     * @param resultCode 
     */  
    void beforeResult(ActionInvocation invocation, String resultCode);  
}  


在这里,我们看到,Struts2能够支持如此多的拦截类型,与其本身的数据结构和整体设计有很大的关系。正如我在之前的文章中所提到的: 

因为Action是一个普通的Java类,而不是一个Servlet类,完全脱离于Web容器,所以我们就能够更加方便地对Control层进行合理的层次设计,从而抽象出许多公共的逻辑,并将这些逻辑脱离出Action对象本身。



我们可以看到,Struts2对于整个执行的划分,从Interceptor到Action一直到Result,每一层都职责明确。不仅如此,Struts2还为每一个层次之前都设立了恰如其分的插入点。使得整个Action层的扩展性得到了史无前例的提升。 

Interceptor执行顺序 

Interceptor的执行顺序或许是我们在整个过程中最最关心的部分。根据上面所提到的概念,我们实际上已经能够大致明白了Interceptor的执行机理。我们来看看Struts2的Reference对Interceptor执行顺序的一个形象的例子。 

如果我们有一个interceptor-stack的定义如下: 

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

 整个拦截器栈的执行顺序为


在这里,我稍微改了一下Struts2的Reference中的执行顺序示例,使得整个执行顺序更加能够被理解。我们可以看到,递归调用保证了各种各样的拦截类型的执行能够井井有条。 

请注意在这里,每个拦截器中的代码的执行顺序,在Action之前,拦截器的执行顺序与堆栈中定义的一致;而在Action和Result之后,拦截器的执行顺序与堆栈中定义的顺序相反。 

源码解析 

接下来我们就来看看源码,看看Struts2是如何保证拦截器、Action与Result三者之间的执行顺序的。 

之前我曾经提到,ActionInvocation是Struts2中的调度器,所以事实上,这些代码的调度执行,是在ActionInvocation的实现类中完成的,这里,我抽取了DefaultActionInvocation中的invoke()方法,它将向我们展示一切。 

/** 
 * @throws ConfigurationException If no result can be found with the returned code 
 */  
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);  
    }  
}  



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

在这里,需要特别强调的,是其中拦截器部分的执行调用: 

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



表面上,它只是执行了拦截器中的intercept方法,如果我们结合拦截器来看,就能看出点端倪来: 

public String intercept(ActionInvocation invocation) throws Exception {  
    String result = null;  
  
        before(invocation);  
        // 调用invocation的invoke()方法,在这里形成了递归调用  
        result = invocation.invoke();  
        after(invocation, result);  
  
        return result;  
}  



原来在intercept()方法又对ActionInvocation的invoke()方法进行递归调用,ActionInvocation循环嵌套在intercept()中,一直到语句result = invocation.invoke()执行结束。这样,Interceptor又会按照刚开始执行的逆向顺序依次执行结束。 

一个有序链表,通过递归调用,变成了一个堆栈执行过程,将一段有序执行的代码变成了2段执行顺序完全相反的代码过程,从而巧妙地实现了AOP。这也就成为了Struts2的Action层的AOP基础。

 

本文转载自:http://struts2.group.iteye.com/group/wiki/1397-deep-into-struts2-interceptors

拷贝忍者卡卡习
粉丝 9
博文 39
码字总数 24335
作品 0
深圳
程序员
私信 提问
struts2的核心和工作原理

设计目标 Struts设计的第一目标就是使MVC模式应用于web程序设计。在这儿MVC模式的好处就不在提了。 技术优势 Struts2有两方面的技术优势,一是所有的Struts2应用程序都是基于client/server H...

白志华
2015/09/28
109
0
struts2的核心和工作原理

Struts 2定义:Struts 2是一个基于MVC设计模式的Web应用框架,它本质上相当于一个servlet,在MVC设计模式中,Struts 2作为控制器(Controller)来建立模型与视图的数据交互。Struts 2是Struts的...

李序锴
2017/11/09
0
0
Struts2拦截器的使用 (详解)

如何使用struts2拦截器,或者自定义拦截器。特别注意,在使用拦截器的时候,在Action里面必须最后一定要引用struts2自带的拦截器缺省堆栈defaultStack,如下(这里我是引用了struts2自带的che...

Idiot_s_Sky
2014/02/05
34
0
struts2学习笔记--拦截器(Interceptor)和登录权限验证Demo

 理解       Interceptor拦截器类似于我们学过的过滤器,是可以在action执行前后执行的代码.是我们做web开发是经常使用的技术,比如权限控制,日志.我们也可以把多个interceptor连在一起...

冬至饮雪
2016/02/15
0
0
Java程序员从笨鸟到菜鸟之(四十六)细谈struts2(八)拦截器的实现原理及源码剖析

本文来自:曹胜欢博客专栏。转载请注明出处:http://blog.csdn.net/csh624366188 拦截器(interceptor)是Struts2最强大的特性之一,也可以说是struts2的核心,拦截器可以让你在Action和res...

长平狐
2012/11/12
54
0

没有更多内容

加载失败,请刷新页面

加载更多

SpringBoot中 集成 redisTemplate 对 Redis 的操作(二)

SpringBoot中 集成 redisTemplate 对 Redis 的操作(二) List 类型的操作 1、 向列表左侧添加数据 Long leftPush = redisTemplate.opsForList().leftPush("name", name); 2、 向列表右......

TcWong
今天
5
0
排序––快速排序(二)

根据排序––快速排序(一)的描述,现准备写一个快速排序的主体框架: 1、首先需要设置一个枢轴元素即setPivot(int i); 2、然后需要与枢轴元素进行比较即int comparePivot(int j); 3、最后...

FAT_mt
昨天
4
0
mysql概览

学习知识,首先要有一个总体的认识。以下为mysql概览 1-架构图 2-Detail csdn |简书 | 头条 | SegmentFault 思否 | 掘金 | 开源中国 |

程序员深夜写bug
昨天
10
0
golang微服务框架go-micro 入门笔记2.2 micro工具之微应用利器micro web

micro web micro 功能非常强大,本文将详细阐述micro web 命令行的功能 阅读本文前你可能需要进行如下知识储备 golang分布式微服务框架go-micro 入门笔记1:搭建go-micro环境, golang微服务框架...

非正式解决方案
昨天
8
0
前端——使用base64编码在页面嵌入图片

因为页面中插入一个图片都要写明图片的路径——相对路径或者绝对路径。而除了具体的网站图片的图片地址,如果是在自己电脑文件夹里的图片,当我们的HTML文件在别人电脑上打开的时候图片则由于...

被毒打的程序猿
昨天
9
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部