Structs ActionProxy深度阅读

ActionProxy是Action的一个代理类，也就是说Action的调用是通过ActionProxy实现的，其实就是调用了ActionProxy.execute()方法，而该方法又调用了ActionInvocation.invoke()方法。归根到底，最后调用的是DefaultActionInvocation.invokeAction()方法。

DefaultActionInvocation()->init()->createAction()。

最后通过调用ActionProxy.exute()-->ActionInvocation.invoke()-->Intercepter.intercept()-->ActionInvocation.invokeActionOnly()-->invokeAction()

这里的步骤是先由ActionProxyFactory创建ActionInvocation和ActionProxy.

Java代码  

1. public ActionProxy createActionProxy(String namespace, String actionName, String methodName, Map<String, Object> extraContext, boolean executeResult, boolean cleanupContext) {
2. ActionInvocation inv = new DefaultActionInvocation(extraContext, true);
3. container.inject(inv);
4. return createActionProxy(inv, namespace, actionName, methodName, executeResult, cleanupContext);
5. }

下面先看DefaultActionInvocation的init方法

Java代码  

1. public void init(ActionProxy proxy) {
2. this.proxy = proxy;
3. Map<String, Object> contextMap = createContextMap();
4. // Setting this so that other classes, like object factories, can use the ActionProxy and other
5. // contextual information to operate
6. ActionContext actionContext = ActionContext.getContext();
7. if (actionContext != null) {
8. actionContext.setActionInvocation(this);
9. }
10. //创建Action,struts2中每一个Request都会创建一个新的Action
11. createAction(contextMap);
12. if (pushAction) {
13. stack.push(action);
14. contextMap.put("action", action);
15. }
16. invocationContext = new ActionContext(contextMap);
17. invocationContext.setName(proxy.getActionName());
18. // get a new List so we don‘t get problems with the iterator if someone changes the list
19. List<InterceptorMapping> interceptorList = new ArrayList<InterceptorMapping>(proxy.getConfig().getInterceptors());
20. interceptors = interceptorList.iterator();
21. }
22. protected void createAction(Map<String, Object> contextMap) {
23. // load action
24. String timerKey = "actionCreate: " + proxy.getActionName();
25. try {
26. UtilTimerStack.push(timerKey);
27. //默认为SpringObjectFactory:struts.objectFactory=spring.这里非常巧妙,在struts.properties中可以重写这个属性
28. //在前面BeanSelectionProvider中通过配置文件为ObjectFactory设置实现类
29. //这里以Spring为例,这里会调到SpringObjectFactory的buildBean方法,可以通过ApplicationContext的getBean()方法得到Spring的Bean
30. action = objectFactory.buildAction(proxy.getActionName(), proxy.getNamespace(), proxy.getConfig(), contextMap);
31. } catch (InstantiationException e) {
32. throw new XWorkException("Unable to intantiate Action!", e, proxy.getConfig());
33. } catch (IllegalAccessException e) {
34. throw new XWorkException("Illegal access to constructor, is it public?", e, proxy.getConfig());
35. } catch (Exception e) {
36. ...
37. } finally {
38. UtilTimerStack.pop(timerKey);
39. }
40. if (actionEventListener != null) {
41. action = actionEventListener.prepare(action, stack);
42. }
43. }
44. //SpringObjectFactory
45. public Object buildBean(String beanName, Map<String, Object> extraContext, boolean injectInternal) throws Exception {
46. Object o = null;
47. try {
48. //SpringObjectFactory会通过web.xml中的context-param:contextConfigLocation自动注入ClassPathXmlApplicationContext
49. o = appContext.getBean(beanName);
50. } catch (NoSuchBeanDefinitionException e) {
51. Class beanClazz = getClassInstance(beanName);
52. o = buildBean(beanClazz, extraContext);
53. }
54. if (injectInternal) {
55. injectInternalBeans(o);
56. }
57. return o;
58. }

Java代码  

1. //接下来看看DefaultActionInvocation 的invoke方法
2. public String invoke() throws Exception {
3. String profileKey = "invoke: ";
4. try {
5. UtilTimerStack.push(profileKey);
6. if (executed) {
7. throw new IllegalStateException("Action has already executed");
8. }
9. //递归执行interceptor
10. if (interceptors.hasNext()) {
11. //interceptors是InterceptorMapping实际上是像一个像FilterChain一样的Interceptor链
12. //通过调用Invocation.invoke()实现递归牡循环
13. final InterceptorMapping interceptor = (InterceptorMapping) interceptors.next();
14. String interceptorMsg = "interceptor: " + interceptor.getName();
15. UtilTimerStack.push(interceptorMsg);
16. try {
17. //在每个Interceptor的方法中都会return invocation.invoke()
18. resultCode = interceptor.getInterceptor().intercept(DefaultActionInvocation.this);
19. }
20. finally {
21. UtilTimerStack.pop(interceptorMsg);
22. }
23. } else {
24. //当所有interceptor都执行完,最后执行Action,invokeActionOnly会调用invokeAction()方法
25. resultCode = invokeActionOnly();
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. //在Result返回之前调用preResultListeners
30. //通过executed控制,只执行一次
31. if (!executed) {
32. if (preResultListeners != null) {
33. for (Object preResultListener : preResultListeners) {
34. PreResultListener listener = (PreResultListener) preResultListener;
35. String _profileKey = "preResultListener: ";
36. try {
37. UtilTimerStack.push(_profileKey);
38. listener.beforeResult(this, resultCode);
39. }
40. finally {
41. UtilTimerStack.pop(_profileKey);
42. }
43. }
44. }
45. // now execute the result, if we‘re supposed to
46. //执行Result
47. if (proxy.getExecuteResult()) {
48. executeResult();
49. }
50. executed = true;
51. }
52. return resultCode;
53. }
54. finally {
55. UtilTimerStack.pop(profileKey);
56. }
57. }
58. //invokeAction
59. protected String invokeAction(Object action,ActionConfig actionConfig)throws Exception{
60. String methodName = proxy.getMethod();
61. String timerKey = "invokeAction: " + proxy.getActionName();
62. try {
63. UtilTimerStack.push(timerKey);
64. boolean methodCalled = false;
65. Object methodResult = null;
66. Method method = null;
67. try {
68. //java反射机制得到要执行的方法
69. method = getAction().getClass().getMethod(methodName, new Class[0]);
70. } catch (NoSuchMethodException e) {
71. // hmm -- OK, try doXxx instead
72. //如果没有对应的方法，则使用do+Xxxx来再次获得方法
73. try {
74. String altMethodName = "do" + methodName.substring(0, 1).toUpperCase() + methodName.substring(1);
75. method = getAction().getClass().getMethod(altMethodName, new Class[0]);
76. } catch (NoSuchMethodException e1) {
77. // well, give the unknown handler a shot
78. if (unknownHandlerManager.hasUnknownHandlers()) {
79. try {
80. methodResult = unknownHandlerManager.handleUnknownMethod(action, methodName);
81. methodCalled = true;
82. } catch (NoSuchMethodException e2) {
83. // throw the original one
84. throw e;
85. }
86. } else {
87. throw e;
88. }
89. }
90. }
91. //执行Method
92. if (!methodCalled) {
93. methodResult = method.invoke(action, new Object[0]);
94. }
95. //从这里可以看出可以Action的方法可以返回String去匹配Result,也可以直接返回Result类
96. if (methodResult instanceof Result) {
97. this.explicitResult = (Result) methodResult;
98. // Wire the result automatically
99. container.inject(explicitResult);
100. return null;
101. } else {
102. return (String) methodResult;
103. }
104. } catch (NoSuchMethodException e) {
105. throw new IllegalArgumentException("The " + methodName + "() is not defined in action " + getAction().getClass() + "");
106. } catch (InvocationTargetException e) {
107. // We try to return the source exception.
108. Throwable t = e.getTargetException();
109. if (actionEventListener != null) {
110. String result = actionEventListener.handleException(t, getStack());
111. if (result != null) {
112. return result;
113. }
114. }
115. if (t instanceof Exception) {
116. throw (Exception) t;
117. } else {
118. throw e;
119. }
120. } finally {
121. UtilTimerStack.pop(timerKey);
122. }
123. }

action执行完了，还要根据ResultConfig返回到view，也就是在invoke方法中调用executeResult方法。

Java代码  

1. private void executeResult() throws Exception {
2. //根据ResultConfig创建Result
3. result = createResult();
4. String timerKey = "executeResult: " + getResultCode();
5. try {
6. UtilTimerStack.push(timerKey);
7. if (result != null) {
8. //开始执行Result,
9. //可以参考Result的实现，如用了比较多的ServletDispatcherResult,ServletActionRedirectResult,ServletRedirectResult
10. result.execute(this);
11. } else if (resultCode != null && !Action.NONE.equals(resultCode)) {
12. throw new ConfigurationException("No result defined for action " + getAction().getClass().getName()
13. + " and result " + getResultCode(), proxy.getConfig());
14. } else {
15. if (LOG.isDebugEnabled()) {
16. LOG.debug("No result returned for action " + getAction().getClass().getName() + " at " + proxy.getConfig().getLocation());
17. }
18. }
19. } finally {
20. UtilTimerStack.pop(timerKey);
21. }
22. }
23. public Result createResult() throws Exception {
24. //如果Action中直接返回的Result类型,在invokeAction()保存在explicitResult
25. if (explicitResult != null) {
26. Result ret = explicitResult;
27. explicitResult = null;
28. return ret;
29. }
30. //返回的是String则从config中得到当前Action的Results列表
31. ActionConfig config = proxy.getConfig();
32. Map<String, ResultConfig> results = config.getResults();
33. ResultConfig resultConfig = null;
34. synchronized (config) {
35. try {
36. //通过返回的String来匹配resultConfig
37. resultConfig = results.get(resultCode);
38. } catch (NullPointerException e) {
39. // swallow
40. }
41. if (resultConfig == null) {
42. // If no result is found for the given resultCode, try to get a wildcard ‘*‘ match.
43. //如果找不到对应name的ResultConfig，则使用name为*的Result
44. //说明可以用*通配所有的Result
45. resultConfig = results.get("*");
46. }
47. }
48. if (resultConfig != null) {
49. try {
50. //创建Result
51. return objectFactory.buildResult(resultConfig, invocationContext.getContextMap());
52. } catch (Exception e) {
53. LOG.error("There was an exception while instantiating the result of type " + resultConfig.getClassName(), e);
54. throw new XWorkException(e, resultConfig);
55. }
56. } else if (resultCode != null && !Action.NONE.equals(resultCode) && unknownHandlerManager.hasUnknownHandlers()) {
57. return unknownHandlerManager.handleUnknownResult(invocationContext, proxy.getActionName(), proxy.getConfig(), resultCode);
58. }
59. return null;
60. }
61. public Result buildResult(ResultConfig resultConfig, Map<String, Object> extraContext) throws Exception {
62. String resultClassName = resultConfig.getClassName();
63. Result result = null;
64. if (resultClassName != null) {
65. //buildBean中会用反射机制Class.newInstance来创建bean
66. result = (Result) buildBean(resultClassName, extraContext);
67. Map<String, String> params = resultConfig.getParams();
68. if (params != null) {
69. for (Map.Entry<String, String> paramEntry : params.entrySet()) {
70. try {
71. //reflectionProvider参见OgnlReflectionProvider；
72. //resultConfig.getParams()就是result配置文件里所配置的参数<param></param>
73. //setProperties方法最终调用的是Ognl类的setValue方法
74. //这句其实就是把param名值设置到根对象result上
75. reflectionProvider.setProperty(paramEntry.getKey(), paramEntry.getValue(), result, extraContext, true);
76. } catch (ReflectionException ex) {
77. if (LOG.isErrorEnabled())
78. LOG.error("Unable to set parameter [#0] in result of type [#1]", ex,
79. paramEntry.getKey(), resultConfig.getClassName());
80. if (result instanceof ReflectionExceptionHandler) {
81. ((ReflectionExceptionHandler) result).handle(ex);
82. }
83. }
84. }
85. }
86. }
87. return result;
88. }