第五讲Struts2拦截器

第五讲Struts2拦截器一、Interceptor结构图中，我们可以发现，Struts2的Interceptor一层一层，把Action包裹在最里面。这样的结构，大概有以下一些特点：1.整个结构就如同一个堆栈，除了Action以外，堆栈中的其他元素是Interceptor2.Action位于堆栈的底部。由于堆栈先进后出的特性，如果我们试图把Action拿出来执行，我们必须首先把位于Action上端的Interceptor拿出来执行。这样，整个执行就形成了一个递归调用3.每个位于堆栈中的Interceptor，除了需要完成它自身的逻辑，还需要完成一个特殊的执行职责。这个执行职责有3种选择：1)中止整个执行，直接返回一个字符串作为resultCode2)通过递归调用负责调用堆栈中下一个Interceptor的执行3)如果在堆栈内已经不存在任何的Interceptor，调用ActionStruts2的拦截器结构的设计，实际上是一个典型的责任链模式的应用。首先将整个执行划分成若干相同类型的元素，每个元素具备不同的逻辑责任，并将他们纳入到一个链式的数据结构中（我们可以把堆栈结构也看作是一个递归的链式结构），而每个元素又有责任负责链式结构中下一个元素的执行调用。这样的设计，从代码重构的角度来看，实际上是将一个复杂的系统，分而治之，从而使得每个部分的逻辑能够高度重用并具备高度可扩展性。所以，Interceptor结构实在是Struts2/Xwork设计中的精华之笔。二、Interceptor执行分析Interceptor的定义我们来看一下Interceptor的接口的定义：publicinterfaceInterceptorextendsSerializable{voiddestroy();voidinit();Stringintercept(ActionInvocationinvocation)throwsException;}Interceptor的接口定义没有什么特别的地方，除了init和destory方法以外，intercept方法是实现整个拦截器机制的核心方法。而它所依赖的参数ActionInvocation则是我们之前曾经提到过的著名的Action调度者。我们再来看看一个典型的Interceptor的抽象实现类：publicabstractclassAroundInterceptorextendsAbstractInterceptor{/*(non-Javadoc)*@seecom.opensymphony.xwork2.interceptor.AbstractInterceptor#intercept(com.opensymphony.xwork2.ActionInvocation)*/@OverridepublicStringintercept(ActionInvocationinvocation)throwsException{Stringresult=null;before(invocation);//调用下一个拦截器，如果拦截器不存在，则执行Actionresult=invocation.invoke();after(invocation,result);returnresult;}publicabstractvoidbefore(ActionInvocationinvocation)throwsException;publicabstractvoidafter(ActionInvocationinvocation,StringresultCode)throwsException;}在这个实现类中，实际上已经实现了最简单的拦截器的雏形。或许大家对这样的代码还比较陌生，这没有关系。我在这里需要指出的是一个很重要的方法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.beforebefore拦截，是指在拦截器中定义的代码，它们存在于invocation.invoke()代码执行之前。这些代码，将依照拦截器定义的顺序，顺序执行。2.afterafter拦截，是指在拦截器中定义的代码，它们存在于invocation.invoke()代码执行之后。这些代码，将依照拦截器定义的顺序，逆序执行。3.PreResultListener有的时候，before拦截和after拦截对我们来说是不够的，因为我们需要在Action执行完之后，但是还没有回到视图层之前，做一些事情。Struts2同样支持这样的拦截，这种拦截方式，是通过在拦截器中注册一个PreResultListener的接口来实现的。publicinterfacePreResultListener{/***ThiscallbackmethodwillbecalledaftertheActionexecutionandbeforetheResultexecution.**@paraminvocation*@paramresultCode*/voidbeforeResult(ActionInvocationinvocation,StringresultCode);}在这里，我们看到，Struts2能够支持如此多的拦截类型，与其本身的数据结构和整体设计有很大的关系。因为Action是一个普通的Java类，而不是一个Servlet类，完全脱离于Web容器，所以我们就能够更加方便地对Control层进行合理的层次设计，从而抽象出许多公共的逻辑，并将这些逻辑脱离出Action对象本身。我们可以看到，Struts2对于整个执行的划分，从Interceptor到Action一直到Result，每一层都职责明确。不仅如此，Struts2还为每一个层次之前都设立了恰如其分的插入点。使得整个Action层的扩展性得到了史无前例的提升。四、Interceptor执行顺序Interceptor的执行顺序或许是我们在整个过程中最最关心的部分。根据上面所提到的概念，我们实际上已经能够大致明白了Interceptor的执行机理。我们来看看Struts2的Reference对Interceptor执行顺序的一个形象的例子。如果我们有一个interceptor-stack的定义如下：interceptor-stackname=xaStackinterceptor-refname=thisWillRunFirstInterceptor/interceptor-refname=thisWillRunNextInterceptor/interceptor-refname=followedByThisInterceptor/interceptor-refname=thisWillRunLastInterceptor//interceptor-stack那么，整个执行的顺序大概像这样：请注意在这里，每个拦截器中的代码的执行顺序，在Action之前，拦截器的执行顺序与堆栈中定义的一致；而在Action和Result之后，拦截器的执行顺序与堆栈中定义的顺序相反。