- 浏览: 17066 次
- 性别:
- 来自: 长沙
文章分类
最新评论
在之前的文章中,我们已经涉及到了拦截器(Interceptor)的概念。
downpour 写道
拦截器是AOP中的概念,它本身是一段代码,可以通过定义“织入点”,来指定拦截器的代码在“织入点”的前后执行,从而起到拦截的作用。正如上面 Struts2的Reference中讲述的,Struts2的Interceptor,其拦截的对象是Action代码,可以定义在Action代码之前或者之后执行拦截器的代码。
接下来,我们将重点讨论一下Struts2中的拦截器的内部结构和执行顺序,并结合源码进行分析。
Interceptor结构
让我们再来回顾一下之前我们曾经用过的一张Action LifeCycle的图:
图中,我们可以发现,Struts2的Interceptor一层一层,把Action包裹在最里面。这样的结构,大概有以下一些特点:
1. 整个结构就如同一个堆栈,除了Action以外,堆栈中的其他元素是Interceptor
2. Action位于堆栈的底部。由于堆栈"先进后出"的特性,如果我们试图把Action拿出来执行,我们必须首先把位于Action上端的Interceptor拿出来执行。这样,整个执行就形成了一个递归调用
3. 每个位于堆栈中的Interceptor,除了需要完成它自身的逻辑,还需要完成一个特殊的执行职责。这个执行职责有3种选择:
1) 中止整个执行,直接返回一个字符串作为resultCode
2) 通过递归调用负责调用堆栈中下一个Interceptor的执行
3) 如果在堆栈内已经不存在任何的Interceptor,调用Action
Struts2的拦截器结构的设计,实际上是一个典型的责任链模式的应用。首先将整个执行划分成若干相同类型的元素,每个元素具备不同的逻辑责任,并将他们纳入到一个链式的数据结构中(我们可以把堆栈结构也看作是一个递归的链式结构),而每个元素又有责任负责链式结构中下一个元素的执行调用。
这样的设计,从代码重构的角度来看,实际上是将一个复杂的系统,分而治之,从而使得每个部分的逻辑能够高度重用并具备高度可扩展性。所以,Interceptor结构实在是Struts2/Xwork设计中的精华之笔。
Interceptor执行分析
Interceptor的定义
我们来看一下Interceptor的接口的定义:
Java代码
1.public interface Interceptor extends Serializable {
2.
3. /**
4. * Called to let an interceptor clean up any resources it has allocated.
5. */
6. void destroy();
7.
8. /**
9. * Called after an interceptor is created, but before any requests are processed using
10. * {@link #intercept(com.opensymphony.xwork2.ActionInvocation) intercept} , giving
11. * the Interceptor a chance to initialize any needed resources.
12. */
13. void init();
14.
15. /**
16. * Allows the Interceptor to do some processing on the request before and/or after the rest of the processing of the
17. * request by the {@link ActionInvocation} or to short-circuit the processing and just return a String return code.
18. *
19. * @return the return code, either returned from {@link ActionInvocation#invoke()}, or from the interceptor itself.
20. * @throws Exception any system-level error, as defined in {@link com.opensymphony.xwork2.Action#execute()}.
21. */
22. String intercept(ActionInvocation invocation) throws Exception;
23.}
Java代码
1.public interface Interceptor extends Serializable {
2.
3. /**
4. * Called to let an interceptor clean up any resources it has allocated.
5. */
6. void destroy();
7.
8. /**
9. * Called after an interceptor is created, but before any requests are processed using
10. * {@link #intercept(com.opensymphony.xwork2.ActionInvocation) intercept} , giving
11. * the Interceptor a chance to initialize any needed resources.
12. */
13. void init();
14.
15. /**
16. * Allows the Interceptor to do some processing on the request before and/or after the rest of the processing of the
17. * request by the {@link ActionInvocation} or to short-circuit the processing and just return a String return code.
18. *
19. * @return the return code, either returned from {@link ActionInvocation#invoke()}, or from the interceptor itself.
20. * @throws Exception any system-level error, as defined in {@link com.opensymphony.xwork2.Action#execute()}.
21. */
22. String intercept(ActionInvocation invocation) throws Exception;
23.}
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的抽象实现类:
Java代码
1.public abstract class AroundInterceptor extends AbstractInterceptor {
2.
3. /* (non-Javadoc)
4. * @see com.opensymphony.xwork2.interceptor.AbstractInterceptor#intercept(com.opensymphony.xwork2.ActionInvocation)
5. */
6. @Override
7. public String intercept(ActionInvocation invocation) throws Exception {
8. String result = null;
9.
10. before(invocation);
11. // 调用下一个拦截器,如果拦截器不存在,则执行Action
12. result = invocation.invoke();
13. after(invocation, result);
14.
15. return result;
16. }
17.
18. public abstract void before(ActionInvocation invocation) throws Exception;
19.
20. public abstract void after(ActionInvocation invocation, String resultCode) throws Exception;
21.
22.}
Java代码
1.public abstract class AroundInterceptor extends AbstractInterceptor {
2.
3. /* (non-Javadoc)
4. * @see com.opensymphony.xwork2.interceptor.AbstractInterceptor#intercept(com.opensymphony.xwork2.ActionInvocation)
5. */
6. @Override
7. public String intercept(ActionInvocation invocation) throws Exception {
8. String result = null;
9.
10. before(invocation);
11. // 调用下一个拦截器,如果拦截器不存在,则执行Action
12. result = invocation.invoke();
13. after(invocation, result);
14.
15. return result;
16. }
17.
18. public abstract void before(ActionInvocation invocation) throws Exception;
19.
20. public abstract void after(ActionInvocation invocation, String resultCode) throws Exception;
21.
22.}
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的接口来实现的。
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.}
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.}
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能够支持如此多的拦截类型,与其本身的数据结构和整体设计有很大的关系。正如我在之前的文章中所提到的:
downpour 写道
因为Action是一个普通的Java类,而不是一个Servlet类,完全脱离于Web容器,所以我们就能够更加方便地对Control层进行合理的层次设计,从而抽象出许多公共的逻辑,并将这些逻辑脱离出Action对象本身。
我们可以看到,Struts2对于整个执行的划分,从Interceptor到Action一直到Result,每一层都职责明确。不仅如此,Struts2还为每一个层次之前都设立了恰如其分的插入点。使得整个Action层的扩展性得到了史无前例的提升。
Interceptor执行顺序
Interceptor的执行顺序或许是我们在整个过程中最最关心的部分。根据上面所提到的概念,我们实际上已经能够大致明白了Interceptor的执行机理。我们来看看Struts2的Reference对Interceptor执行顺序的一个形象的例子。
如果我们有一个interceptor-stack的定义如下:
Xml代码
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>
Xml代码
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>
<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()方法,它将向我们展示一切。
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 = "invoke: ";
6. try {
7. UtilTimerStack.push(profileKey);
8.
9. if (executed) {
10. throw new IllegalStateException("Action has already executed");
11. }
12. // 依次调用拦截器堆栈中的拦截器代码执行
13. if (interceptors.hasNext()) {
14. final InterceptorMapping interceptor = (InterceptorMapping) interceptors.next();
15. UtilTimerStack.profile("interceptor: "+interceptor.getName(),
16. new UtilTimerStack.ProfilingBlock<String>() {
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="preResultListener: ";
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;
54. }
55.
56. return resultCode;
57. }
58. finally {
59. UtilTimerStack.pop(profileKey);
60. }
61.}
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 = "invoke: ";
6. try {
7. UtilTimerStack.push(profileKey);
8.
9. if (executed) {
10. throw new IllegalStateException("Action has already executed");
11. }
12. // 依次调用拦截器堆栈中的拦截器代码执行
13. if (interceptors.hasNext()) {
14. final InterceptorMapping interceptor = (InterceptorMapping) interceptors.next();
15. UtilTimerStack.profile("interceptor: "+interceptor.getName(),
16. new UtilTimerStack.ProfilingBlock<String>() {
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="preResultListener: ";
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;
54. }
55.
56. return resultCode;
57. }
58. finally {
59. UtilTimerStack.pop(profileKey);
60. }
61.}
/**
* @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的行为。
在这里,需要特别强调的,是其中拦截器部分的执行调用:
Java代码
1.resultCode = interceptor.getInterceptor().intercept(DefaultActionInvocation.this);
Java代码
1.resultCode = interceptor.getInterceptor().intercept(DefaultActionInvocation.this);
resultCode = interceptor.getInterceptor().intercept(DefaultActionInvocation.this);
表面上,它只是执行了拦截器中的intercept方法,如果我们结合拦截器来看,就能看出点端倪来:
Java代码
1.public String intercept(ActionInvocation invocation) throws Exception {
2. String result = null;
3.
4. before(invocation);
5. // 调用invocation的invoke()方法,在这里形成了递归调用
6. result = invocation.invoke();
7. after(invocation, result);
8.
9. return result;
10.}
Java代码
1.public String intercept(ActionInvocation invocation) throws Exception {
2. String result = null;
3.
4. before(invocation);
5. // 调用invocation的invoke()方法,在这里形成了递归调用
6. result = invocation.invoke();
7. after(invocation, result);
8.
9. return result;
10.}
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基础。
downpour 写道
拦截器是AOP中的概念,它本身是一段代码,可以通过定义“织入点”,来指定拦截器的代码在“织入点”的前后执行,从而起到拦截的作用。正如上面 Struts2的Reference中讲述的,Struts2的Interceptor,其拦截的对象是Action代码,可以定义在Action代码之前或者之后执行拦截器的代码。
接下来,我们将重点讨论一下Struts2中的拦截器的内部结构和执行顺序,并结合源码进行分析。
Interceptor结构
让我们再来回顾一下之前我们曾经用过的一张Action LifeCycle的图:
图中,我们可以发现,Struts2的Interceptor一层一层,把Action包裹在最里面。这样的结构,大概有以下一些特点:
1. 整个结构就如同一个堆栈,除了Action以外,堆栈中的其他元素是Interceptor
2. Action位于堆栈的底部。由于堆栈"先进后出"的特性,如果我们试图把Action拿出来执行,我们必须首先把位于Action上端的Interceptor拿出来执行。这样,整个执行就形成了一个递归调用
3. 每个位于堆栈中的Interceptor,除了需要完成它自身的逻辑,还需要完成一个特殊的执行职责。这个执行职责有3种选择:
1) 中止整个执行,直接返回一个字符串作为resultCode
2) 通过递归调用负责调用堆栈中下一个Interceptor的执行
3) 如果在堆栈内已经不存在任何的Interceptor,调用Action
Struts2的拦截器结构的设计,实际上是一个典型的责任链模式的应用。首先将整个执行划分成若干相同类型的元素,每个元素具备不同的逻辑责任,并将他们纳入到一个链式的数据结构中(我们可以把堆栈结构也看作是一个递归的链式结构),而每个元素又有责任负责链式结构中下一个元素的执行调用。
这样的设计,从代码重构的角度来看,实际上是将一个复杂的系统,分而治之,从而使得每个部分的逻辑能够高度重用并具备高度可扩展性。所以,Interceptor结构实在是Struts2/Xwork设计中的精华之笔。
Interceptor执行分析
Interceptor的定义
我们来看一下Interceptor的接口的定义:
Java代码
1.public interface Interceptor extends Serializable {
2.
3. /**
4. * Called to let an interceptor clean up any resources it has allocated.
5. */
6. void destroy();
7.
8. /**
9. * Called after an interceptor is created, but before any requests are processed using
10. * {@link #intercept(com.opensymphony.xwork2.ActionInvocation) intercept} , giving
11. * the Interceptor a chance to initialize any needed resources.
12. */
13. void init();
14.
15. /**
16. * Allows the Interceptor to do some processing on the request before and/or after the rest of the processing of the
17. * request by the {@link ActionInvocation} or to short-circuit the processing and just return a String return code.
18. *
19. * @return the return code, either returned from {@link ActionInvocation#invoke()}, or from the interceptor itself.
20. * @throws Exception any system-level error, as defined in {@link com.opensymphony.xwork2.Action#execute()}.
21. */
22. String intercept(ActionInvocation invocation) throws Exception;
23.}
Java代码
1.public interface Interceptor extends Serializable {
2.
3. /**
4. * Called to let an interceptor clean up any resources it has allocated.
5. */
6. void destroy();
7.
8. /**
9. * Called after an interceptor is created, but before any requests are processed using
10. * {@link #intercept(com.opensymphony.xwork2.ActionInvocation) intercept} , giving
11. * the Interceptor a chance to initialize any needed resources.
12. */
13. void init();
14.
15. /**
16. * Allows the Interceptor to do some processing on the request before and/or after the rest of the processing of the
17. * request by the {@link ActionInvocation} or to short-circuit the processing and just return a String return code.
18. *
19. * @return the return code, either returned from {@link ActionInvocation#invoke()}, or from the interceptor itself.
20. * @throws Exception any system-level error, as defined in {@link com.opensymphony.xwork2.Action#execute()}.
21. */
22. String intercept(ActionInvocation invocation) throws Exception;
23.}
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的抽象实现类:
Java代码
1.public abstract class AroundInterceptor extends AbstractInterceptor {
2.
3. /* (non-Javadoc)
4. * @see com.opensymphony.xwork2.interceptor.AbstractInterceptor#intercept(com.opensymphony.xwork2.ActionInvocation)
5. */
6. @Override
7. public String intercept(ActionInvocation invocation) throws Exception {
8. String result = null;
9.
10. before(invocation);
11. // 调用下一个拦截器,如果拦截器不存在,则执行Action
12. result = invocation.invoke();
13. after(invocation, result);
14.
15. return result;
16. }
17.
18. public abstract void before(ActionInvocation invocation) throws Exception;
19.
20. public abstract void after(ActionInvocation invocation, String resultCode) throws Exception;
21.
22.}
Java代码
1.public abstract class AroundInterceptor extends AbstractInterceptor {
2.
3. /* (non-Javadoc)
4. * @see com.opensymphony.xwork2.interceptor.AbstractInterceptor#intercept(com.opensymphony.xwork2.ActionInvocation)
5. */
6. @Override
7. public String intercept(ActionInvocation invocation) throws Exception {
8. String result = null;
9.
10. before(invocation);
11. // 调用下一个拦截器,如果拦截器不存在,则执行Action
12. result = invocation.invoke();
13. after(invocation, result);
14.
15. return result;
16. }
17.
18. public abstract void before(ActionInvocation invocation) throws Exception;
19.
20. public abstract void after(ActionInvocation invocation, String resultCode) throws Exception;
21.
22.}
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的接口来实现的。
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.}
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.}
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能够支持如此多的拦截类型,与其本身的数据结构和整体设计有很大的关系。正如我在之前的文章中所提到的:
downpour 写道
因为Action是一个普通的Java类,而不是一个Servlet类,完全脱离于Web容器,所以我们就能够更加方便地对Control层进行合理的层次设计,从而抽象出许多公共的逻辑,并将这些逻辑脱离出Action对象本身。
我们可以看到,Struts2对于整个执行的划分,从Interceptor到Action一直到Result,每一层都职责明确。不仅如此,Struts2还为每一个层次之前都设立了恰如其分的插入点。使得整个Action层的扩展性得到了史无前例的提升。
Interceptor执行顺序
Interceptor的执行顺序或许是我们在整个过程中最最关心的部分。根据上面所提到的概念,我们实际上已经能够大致明白了Interceptor的执行机理。我们来看看Struts2的Reference对Interceptor执行顺序的一个形象的例子。
如果我们有一个interceptor-stack的定义如下:
Xml代码
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>
Xml代码
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>
<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()方法,它将向我们展示一切。
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 = "invoke: ";
6. try {
7. UtilTimerStack.push(profileKey);
8.
9. if (executed) {
10. throw new IllegalStateException("Action has already executed");
11. }
12. // 依次调用拦截器堆栈中的拦截器代码执行
13. if (interceptors.hasNext()) {
14. final InterceptorMapping interceptor = (InterceptorMapping) interceptors.next();
15. UtilTimerStack.profile("interceptor: "+interceptor.getName(),
16. new UtilTimerStack.ProfilingBlock<String>() {
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="preResultListener: ";
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;
54. }
55.
56. return resultCode;
57. }
58. finally {
59. UtilTimerStack.pop(profileKey);
60. }
61.}
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 = "invoke: ";
6. try {
7. UtilTimerStack.push(profileKey);
8.
9. if (executed) {
10. throw new IllegalStateException("Action has already executed");
11. }
12. // 依次调用拦截器堆栈中的拦截器代码执行
13. if (interceptors.hasNext()) {
14. final InterceptorMapping interceptor = (InterceptorMapping) interceptors.next();
15. UtilTimerStack.profile("interceptor: "+interceptor.getName(),
16. new UtilTimerStack.ProfilingBlock<String>() {
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="preResultListener: ";
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;
54. }
55.
56. return resultCode;
57. }
58. finally {
59. UtilTimerStack.pop(profileKey);
60. }
61.}
/**
* @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的行为。
在这里,需要特别强调的,是其中拦截器部分的执行调用:
Java代码
1.resultCode = interceptor.getInterceptor().intercept(DefaultActionInvocation.this);
Java代码
1.resultCode = interceptor.getInterceptor().intercept(DefaultActionInvocation.this);
resultCode = interceptor.getInterceptor().intercept(DefaultActionInvocation.this);
表面上,它只是执行了拦截器中的intercept方法,如果我们结合拦截器来看,就能看出点端倪来:
Java代码
1.public String intercept(ActionInvocation invocation) throws Exception {
2. String result = null;
3.
4. before(invocation);
5. // 调用invocation的invoke()方法,在这里形成了递归调用
6. result = invocation.invoke();
7. after(invocation, result);
8.
9. return result;
10.}
Java代码
1.public String intercept(ActionInvocation invocation) throws Exception {
2. String result = null;
3.
4. before(invocation);
5. // 调用invocation的invoke()方法,在这里形成了递归调用
6. result = invocation.invoke();
7. after(invocation, result);
8.
9. return result;
10.}
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基础。
相关推荐
在Struts2中,拦截器(Interceptors)扮演着核心角色,增强了框架的功能和灵活性。这篇文章将深入探讨Struts2拦截器的概念、工作原理以及如何在实际应用中使用它们。 **一、什么是Struts2拦截器** 拦截器是基于AOP...
标题“struts2拦截器”指的是Struts2框架中的拦截器机制,这是一个关键的组件,可以让我们在不修改实际业务代码的情况下,实现对请求处理流程的扩展和定制。 描述中提到的“基于struts2的拦截器测试,实现了页面的...
Struts2拦截器(Interceptor) Struts2拦截器(Interceptor)
拦截器是Struts2框架的核心特性之一,它们扮演着处理请求、增强功能和实现业务逻辑的角色。在Struts2中,拦截器就像过滤器一样工作,通过链式调用在动作执行前后进行预处理和后处理。 首先,我们来理解一下拦截器的...
### Struts2拦截器详解 #### 一、Struts2拦截器概述 Struts2框架作为Java Web开发中的一种流行框架,其核心组件之一便是**拦截器**。拦截器不仅在Struts2中扮演着重要角色,更是整个框架灵活性与扩展性的基石。...
在Struts2中,拦截器(Interceptor)扮演着核心角色,它们允许开发者在Action执行前后插入自定义的逻辑,如日志、权限检查、事务管理等。现在我们将深入探讨Struts2的拦截器机制及其实例应用。 ### 一、Struts2拦截...
在这个“Struts2拦截器实现权限控制demo”中,我们将深入探讨如何利用拦截器来实现细粒度的用户权限管理。 首先,我们需要了解Struts2中的拦截器工作原理。拦截器是基于Java的动态代理模式实现的,它们按照配置的...
### Struts2拦截器的使用方法 #### 一、Struts2拦截器概述 Struts2框架中的拦截器(Interceptor)是一种重要的机制,用于在Action执行前后进行一系列处理,比如参数验证、数据预处理等。它能够帮助开发者更加灵活...
当请求到达控制器时,Struts2会依次调用这个栈中的拦截器,每个拦截器都有机会处理请求,然后决定是否将请求传递给下一个拦截器或直接返回响应。 创建一个简单的Struts2拦截器,你需要遵循以下步骤: 1. 创建拦截...
Struts2拦截器.ppt Struts2拦截器.ppt Struts2拦截器.ppt
拦截器是Struts2框架的核心组成部分,它们在请求处理流程中起到了关键的作用。在本文中,我们将深入探讨Struts2拦截器的工作原理。 ### 一、拦截器概念 拦截器是基于Java的动态代理机制实现的,它允许我们在Action...
拦截器是Struts2框架的一个重要组成部分,能够帮助开发者实现一些在请求处理前后执行的通用逻辑,如日志记录、权限验证、数据校验等。在本场景中,我们将探讨如何使用Struts2拦截器来实现对不文明字迹或者敏感词汇的...
拦截器是Struts2框架的核心组件之一,它允许开发者在动作执行前后插入自定义逻辑,实现如权限验证、日志记录、性能优化等多种功能。在"Struts2 拦截器注解"这个主题中,我们将深入探讨如何利用注解来简化拦截器的...
这篇博客“Struts2 拦截器的执行顺序(二十九)”可能探讨了Struts2拦截器链的工作原理和它们的执行顺序,这对于理解Struts2的内部机制至关重要。 首先,让我们深入理解Struts2的拦截器。拦截器是在Action调用前后...
这篇博客“struts2 拦截器实现登录控制”显然会探讨如何利用拦截器来实现用户登录验证,从而保护应用程序的受保护资源。 首先,我们了解下Struts2拦截器的工作原理。拦截器是基于AOP(面向切面编程)的概念,它位于...
### Struts2 拦截器与验证框架详解 #### 一、Struts2概述 Struts2是一个基于Java的企业级Web应用开发框架,它继承了Struts1的优点,并在此基础上进行了很多改进,使得开发更加灵活高效。Struts2的核心是拦截器...
在Struts2中,拦截器扮演着至关重要的角色,它们是实现MVC(Model-View-Controller)架构的关键组件之一。拦截器允许开发者在动作执行前后插入自定义逻辑,比如日志记录、权限检查、数据验证等,而无需修改核心业务...