struts2拦截器详解 下载本文

由此,我们就可以通过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的接口来实现的。 Java代码

1. public interface PreResultListener { 2.

3. /**

4. * This callback method will be called after the Action execution and before the Result execution. 5. *

6. * @param invocation 7. * @param resultCode 8. */

9. void beforeResult(ActionInvocation invocation, String resultCode); 10.}

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

downpour 写道

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

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

Interceptor执行顺序

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

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

1.

2. 3. 4. 5. 6.

那么,整个执行的顺序大概像这样:

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

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

源码解析

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

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

1. /**

2. * @throws ConfigurationException If no result can be found with the returned code 3. */

4. public String invoke() throws Exception { 5. String profileKey = \6. try {

7. UtilTimerStack.push(profileKey); 8.

9. if (executed) {

10. throw new IllegalStateException(\ executed\11. }

12. // 依次调用拦截器堆栈中的拦截器代码执行 13. if (interceptors.hasNext()) {

14. final InterceptorMapping interceptor = (InterceptorMapping) interceptors.next();

15. UtilTimerStack.profile(\getName(),

16. new UtilTimerStack.ProfilingBlock() {

17. public String doProfiling() throws Exception {

18. // 将ActionInvocation作为参数,调用interceptor中的intercept方法执行

19. resultCode = interceptor.getInterceptor().intercept(DefaultActionInvocation.this); 20. return null; 21. } 22. }); 23. } else {

24. resultCode = invokeActionOnly(); 25. } 26.

27. // this is needed because the result will be executed, then control will return to the Interceptor, which will 28. // return above and flow through again 29. if (!executed) {

30. // 执行PreResultListener

31. if (preResultListeners != null) {

32. for (Iterator iterator = preResultListeners.iterator();

33. iterator.hasNext();) {

34. PreResultListener listener = (PreResultListener) iterator.next(); 35.

36. String _profileKey=\

37. try {

38. UtilTimerStack.push(_profileKey);

39. listener.beforeResult(this, resultCode);

40. }

41. finally {

42. UtilTimerStack.pop(_profileKey); 43. } 44. } 45. } 46.

47. // now execute the result, if we're supposed to 48. // action与interceptor执行完毕,执行Result 49. if (proxy.getExecuteResult()) { 50. executeResult(); 51. } 52.

53. executed = true;