Struts2入门第十一讲——从源码角度分析Struts2的执行流程

太过爱你忘了你带给我的痛 2021-10-13 17:00 314阅读 0赞

这篇文章是在参考大量资料之下总结出来的，一是减少学习Struts2同学的疑惑，二是顺便自己总结一下提升自己的知识水平，三是抗遗忘。如果有不足之处，欢迎大家来讨论。笔者在写这篇文章的时候，也就是2019年8月15日晚上21:05，Struts2更新到了2.5.20，这个版本应该更新了不少东西，具体是啥，我也不知道，我只是想告诉大家我是基于Struts2 2.3.24这个版本来展开本讲的。  
首先，我给出Struts2官方的总体流程图，从战略上分析，对Struts2框架有一个全局观念的认识， 保证咱们的学习过程中不会出现走邪路的状况。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70]  
下面，我会结合Struts2官方给出的总体流程图来进行一步步的解析，其中必然会涉及到众多的类，所以我只会根据以上总体流程图来描述。  
**第一步，客户端向服务器发送一个Action的请求，比如说http://localhost:8080/struts2\_demo04/helloworldAction.action，请求经过一系列的过滤器，例如Struts2流程图中的ActionContextCleanUp（这个类只有在集成SiteMesh才会有用，其余时候可以不管）和Other filter(SiteMesh, etc)等，最后进入到Struts2的核心过滤器（也就是StrutsPrepareAndExecuteFilter）中。**  
StrutsPrepareAndExecuteFilter的字面意思就是Struts2准备并执行过滤器，其真正含义有两条与这句话差不多。

*  一是为Struts2的执行做一些准备工作，如加载相关的配置信息；
 *  二是为Struts2的request请求处理相关的信息，如设置编码格式和找到对应的action映射类。

相应地，StrutsPrepareAndExecuteFilter类包含以下两个主要方法：

*  init()方法：主要是读取Struts2的配置文件。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 1]
 *  doFilter()方法：主要是通过HttpServletRequest和HttpServletRespone创建ActionContext对象，用ActionContext对象包装请求和响应信息，然后提交各Action类。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 2]

温馨提示：Struts2流程图中的FilterDispatcher类在struts2.1.3中已经过时了，改为了StrutsPrepareAndExecuteFilter类了。在Struts2项目中所有的请求都需要经过它的处理，当每次启动服务器的时候第一次请求都会调用该类的init方法，随后的请求会调用doFilter方法。也就是说，此时，请求已经进入到Struts2流程图中的这个部位了。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 3]  
现在请求已经进入到了StrutsPrepareAndExecuteFilter类的doFilter()方法中了，这个方法可不简单，做的事情挺多的，例如设置编码格式啦！创建一个ActionContext（Action上下文）啦！包装请求信息啦！在这里，我们重点关注下面这行代码，这句代码干了啥？  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 4]  
根据官方的流程图可以看到请求通过FilterDispacther后会进入到ActionMapper，它是一个接口，用来匹配当前的请求是否有对应的action。该接口共有4个实现类，它们分别是RestfulActionMapper、DefaultActionMapper（默认使用）、CompositeActionMapper以及PrefixBasedActionMapper。说了这么多，那上面的代码干了啥啊？StrutsPrepareAndExecuteFilter通过ActionMapper来获取了一个ActionMapping对象，如果不相信，你可以进去findActionMapping()方法里面看看。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 5]  
ActionMapping又是个啥？ActionMapping对象是用来存放ActionMapper（默认为DefaultActionMapper）解析后得到的name、nameSpace、method、extension、params以及result的，具体可以查看官方文档，老子也没看过，故这边不再赘述。我们再进入到getMapping()方法里面看看，记住这个时候要进去ActionMapper接口的DefaultActionMapper默认实现类的getMapping()方法中哟！  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 6]  
可以清楚地看到DefaultActionMapper默认实现类中的getMapping()这个方法就是解析我们的请求来得到ActionMapping。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 7]  
值得一提的是在这个方法中最后调用到了parseActionName()方法，为了看清楚这个方法干了些啥？我们点进去看看，发现有个if判断条件为allowDynamicMethodCalls，这个值的意思就是说是否允许请求使用Struts DMI（动态方法访问，例如访问的形式为http://localhost:8080/struts2\_demo04/customer!update.action，意思就是访问customer这个对应action中的update方法），Struts2的default.properties配置文件中默认设置为false，如果你想要允许使用动态方法访问，那么就在struts.xml配置文件中将struts.enable.DynamicMethodInvocation这个常量设置为true即可。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 8]  
**第二步，StrutsPrepareAndExecuteFilter调用ExecuteOperations类的executeAction()方法。** 得到ActionMapping后接着执行ExecuteOperations类的executeAction()方法，如下图所示。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 9]  
在以上executeAction()方法中，StrutsPrepareAndExecuteFilter会调用Dispatcher这个类的serviceAction()方法。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 10]  
Dispatcher类中的这个serviceAction()方法会对ValueStatck等进行处理，重要的是会根据ActionMapping这个对象中的属性（前文提到过）以及configurationManager（加载Struts2的配置文件）来生成一个Action的代理，即ActionProxy。如果这个ActionProxy成功创建的话，那么会执行execute()方法；反之如果匹配不到action即无法生成相应的代理对象，那么会返回404页面。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 11]  
**第三步，通过ActionProxy接口调用ActionInvocation的invoke()方法执行所有的拦截器。** ActionProxy是一个接口，它有一个默认实现类，即DefaultActionProxy类，所以，我们要想查看ActionProxy接口的execute()方法，只须查看DefaultActionProxy实现类中的execute()方法即可。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 12]  
进入到DefaultActionProxy实现类中的execute()方法后，可以看到该方法中最后执行的是Actioninvocation（创建ActionProxy过程中默认生成的是它的子类DefaultActionInvocation）的invoke()方法。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 13]  
注意了，invoke()方法是整个Struts2框架最精华的地方。它里面到底干了些啥呢？我们是不是要点进去看一下？没想到，ActionInvocation也是一个接口，它也有一个实现类，即DefaultActionInvocation类，如果我们想要查看其里面的invoke()方法，那么可以查看DefaultActionInvocation类中的invoke()方法。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 14]  
下面就是DefaultActionInvocation类中的invoke()方法，可以看到Struts2从红框框中的代码处开始对拦截器进行处理，这边的interceptors集合在初始化ActionProxy的时候通过配置文件（即struts-default.xml文件中的`<interceptor-stack name="defaultStack">`）得到。在执行DefaultActionInvocation类中的invoke()方法时，Struts2会按照顺序把所有的拦截器执行一遍，如果没有下一个拦截器了，那么便会执行请求所指的action中的方法并且再按照倒序的方式执行先前的拦截器（这个你可以查看官方流程图）。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 15]  
在DefaultActionInvocation类中的invoke()方法中，Struts2到底是如何把所有的拦截器都执行了一遍的呢？这个咋也要分析一下，分析如下：

*  首先，通过interceptors.next()获取到的是struts-default.xml配置文件中的第一个拦截器，也即ExceptionMappingInterceptor对象，这个时候interceptors集合的指针下移也就是说下一次的interceptors.next()指向了第二个拦截器，也即AliasIntercepto对象；  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 16]
 *  然后，调用ExceptionMappingInterceptor拦截器对象的intercept方法并把当前的DefaultActionInvocation对象作为参数传递进去；  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 17]  
    而在intercept方法中又调用了DefaultActionInvocation的invoke方法。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 18]
 *  最后，在剩下的所有拦截器中重复调用invoke方法直到把所有的拦截器调用完毕为止（这应该就是所谓的递归调用了）。

**第四步，执行HttpServletRequest对应的Action方法并返回Result。** 当调用到了最后一个拦截器DeprecationInterceptor（默认配置情况下最后一个）的时候，此时interceptors.hasNext()为false，因此会执行invokeActionOnly方法。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 19]  
这个方法的作用是用来执行ActionProxy代理的那个Action方法并获得Result，在该方法中用到了Java的反射机制。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 20]  
最后按照后进先出的方式依次返回所有拦截器的值并最终返回Result视图。  
至此整个Struts2的执行流程到此就算是结束了，上述只是这个流程的主要一部分，其中还涉及到了许多的内容这边我就不再详细的去探讨了。最后，感谢阅读，希望读者能够看懂，有所疑问可以留言。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70]: /images/20211013/2e4f09d1513d4cd592f8004ebfc0857f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 1]: /images/20211013/18b66b5acee04c83970789ac418f60cf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 2]: /images/20211013/ed9f788d244245caa209ccfd6b79efa7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 3]: /images/20211013/564c415892934f238aaea29ce509413b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 4]: /images/20211013/3b2ce638cea34c40b5da97be449cd8b2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 5]: /images/20211013/4f1de1eb878b4f87a83b4572a3ff6de7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 6]: /images/20211013/659bb2c571104a0ea6d26dc44c9b4d1c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 7]: /images/20211013/b09c59adf4434b1ab7fc38efc0cc5862.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 8]: /images/20211013/d299f27e17904e47b2a8057903ed6527.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 9]: /images/20211013/7630d85c4e99458585d0e070cb7360ee.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 10]: /images/20211013/ec710bbd55774c369e06ddffa36d9460.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 11]: /images/20211013/36a899a91dd84caea9852b14b6fe80d6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 12]: /images/20211013/7ba8fdf055f84eefaa287986624ccc4d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 13]: /images/20211013/a98f1e7fcde34f3db09b2d15c7c711da.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 14]: /images/20211013/b1090ed2324f40b7af56286093d80d8d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 15]: /images/20211013/048c2f5ec3ed44b9a5e2f403814f3be8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 16]: /images/20211013/0f86aa795d9e4a519979e6c3a157989b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 17]: /images/20211013/5870b636ca344f7fad10a685201b6355.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 18]: /images/20211013/a86fe2fe54ac4ebb86c74da270de30cb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 19]: /images/20211013/f8307d21ea1a42f8ba7d8b616d19a23f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 20]: /images/20211013/3450d0182dbb4f8595a4b9a3c0895049.png