ServletContainerInitializer加载机制

心已赠人 2021-06-10 20:38 490阅读 0赞

最近优化项目架构针对Logback日志框架需要结合Spring的profiles配置文件达到不同运行环境自动配置参数.

最开始想法是使用ServletContextListener监听器实现在项目初始化时读取Spring的profiles配置文件手动放入当前环境变量中但在测试过程中发现问题!

环境变量还没有开始加载, Logback框架已经开始被加载!

![format_png][]

跟踪日志信息发现一个类LogbackServletContainerInitializer, Logback是通过该类进行Web环境初始化的!该类实现了javax.servlet.ServletContainerInitializer接口

![format_png 1][]

第一次接触ServletContainerInitializer查找了一下相关规范, 于是自己也写了一个ServletContainerInitializer接口的类LogInitializer在但发现放置WebContent/META-INF/services/javax.servlet.ServletContainerInitializer文件无法被读取, 网上说只有放置在WebContent/WEB-INF/lib下的Jar包中才能被读取!

单独建立一个新的项目通过Maven引入到原有项目中, 忽然发现LogbackServletContainerInitializer和LogInitializer存在先后加载顺序问题, 经过几次测试发现跟Jar包名称的先后顺序有关, 于是开始跟踪Tomcat运行时的Debug调试看看Tomcat是怎么加载ServletContainerInitializer实例的!

开发工具: IDEA 2017.2.6版

Servlet容器: Tomcat 8.5.20

在LogInitializer\#onStartup()方法第一行打断点等待

![format_png 2][]

进入断点后观察调用堆栈, 发现是org.apache.catalina.core.StandardContext\#startInternal() 调用了LogInitializer\#onStartup()

![format_png 3][]

进入org.apache.catalina.core.StandardContext\#startInternal()方法, 发现一个成员变量迭代调用

![format_png 4][]

跟踪成员属性**initializers**发现是一个链表哈希映射

![format_png 5][]

继续根据**initializers**被调用情况, 发现org.apache.catalina.core.StandardContext\#addServletContainerInitializer()向成员属性中放入实例

![format_png 6][]

查找org.apache.catalina.core.StandardContext\#addServletContainerInitializer()方法被调用情况, 发现在org.apache.catalina.startup.ContextConfig\#webConfig()方法中一个成员属性迭代调用

![format_png 7][]

跟踪**initializerClassMap**成员属性发现类似于刚才的initializers

![format_png 8][]

跟踪**initializerClassMap**被放入对象, 发现org.apache.catalina.startup.ContextConfig\#processServletContainerInitializers()方法

![format_png 9][]

进入org.apache.catalina.startup.WebappServiceLoader\#load()方法观察ServletContainerInitializer实例被加载情况

![format_png 10][]

![format_png 11][]

![format_png 12][]

![format_png 13][]

观察了一下**javax.servlet.ServletContext.ORDERED\_LIBS**静态常量发现与web.xml中的<absolute-ordering>元素相关, 因为没有配置所以先不考虑, 这样判断**orderedLibs!=null**不会被执行类加载器loader的引用就是当前项目Servlet容器的类加载器去加载资源

![format_png 14][]

查找到五个资源, Tomcat容器自身2个, LogInitializer, LogbackServletContainerInitializer, SpringServletContainerInitializer(Spring的)  这个时候已经明了ServletContainerInitializer一般情况下是基于类加载器加载资源的枚举迭代顺序, 因为委托加载机制会从最顶级类加载向下一直加载到当前项目Web容器类加载器下的资源, 到此基本已经弄清楚ServletContainerInitializer加载流程!

![format_png 15][]

因为看见了**ORDERED\_LIBS**常量所以想继续研究一下<absolute-ordering>元素, 大概看了一下相关规范文档定义, 该元素是Servlet3.0出现的为第三方插件Jar包自动配置一些Servlet, Filter时所有第三方插件按照指定绝对顺序加载Jar包资源

1. 在Jar包的META-INF目录下建立web-fragment.xml

![format_png 16][]

2, 配置web.xml

![format_png 17][]

在org.apache.catalina.startup.WebappServiceLoader\#load()方法打断点, 发现找到一个jar包

![format_png 18][]

![format_png 19][]

将当前项目**Web容器类加载器**替换为**Tomca容器类加载器**是因为委托加载机制从最顶级类加载器加载到当前类加载器所以会导致当前项目Web容器不会被加载到, 就会跳过当前项目下WEB-INF/lib中的Jar包查找所以只有log-initializer-0.1.jar中的ServletContainerInitializer被加载, **LogbackServletContainerInitializer, SpringServletContainerInitializer的配置丢失**

![format_png 20][]

不符合预期结果, 继续看<absolute-ordering>文档, 发现一个<others />元素, 在<absolute-ordering>中追加

![format_png 21][]

重新开始在org.apache.catalina.startup.WebappServiceLoader\#load()方法断点Debug

![format_png 22][]

这次就有所有Jar包了, 但很好奇去项目部署的Tomcat下WEB-INF/lib 看了一下Jar包数量 44个  而非37个逐一匹配发现缺少这些Jar包

![format_png 23][]

非常好奇为什么会丢失Jar包, 如果只是丢失apache相关的也可能Tomcat排除自身lib下相关的, 但是slf4j, aspecj居然也没有, 本着求知的好奇心继续调试, 找出缺少Jar包的原因

因为是通过**ORDERED\_LIBS**常量获取的容器属性值, 所以直接在org.apache.catalina.core.ApplicationContext\#setAttribute()使用条件断点

![format_png 24][]

![format_png 25][]

查看堆栈信息, 发现被org.apache.tomcat.util.descriptor.web.WebXml\#orderWebFragments()方法调用

![format_png 26][]

跟踪局部变量**orderedFragments**

![format_png 27][]

发现是局部变量**fragments**映射迭代放入, 而**fragments**是由外部传递

![format_png 28][]

继续向上跟踪堆栈

![format_png 29][]

![format_png 30][]

![format_png 31][]

找到org.apache.tomcat.**JarScanner**实现类org.apache.tomcat.util.scan.**StandardJarScanner**\#scan()方法

![format_png 32][]

找到org.apache.tomcat.**JarScanFilter**实现类org.apache.tomcat.util.scan.**StandardJarScanFilter**\#check()方法

![format_png 33][]

至此基本上算是了解ServletContainerInitializer加载机制!

作者：\_期待  
链接：https://www.jianshu.com/p/118c146b3384  
来源：简书  
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

[format_png]: /images/20210527/44b3a7f648264eca856eebe2ed8efdf0.png
[format_png 1]: /images/20210527/be1c1479c3f94c04bb81366d9fcb6a74.png
[format_png 2]: /images/20210527/2dbda88124f1488c91bdcf8bc13352f7.png
[format_png 3]: /images/20210527/b49df738f01a42f08c1cf0ef2437f1d5.png
[format_png 4]: /images/20210527/a7d2a07e3bd1486ca95a387574ae504f.png
[format_png 5]: /images/20210527/ef965124061547f2b1fc6f576dd99a7a.png
[format_png 6]: /images/20210527/bcc7e422c41647c2ac0329306ede1c42.png
[format_png 7]: /images/20210527/36445b79b8df4a13814595f6a6cf455d.png
[format_png 8]: /images/20210527/d1bad3ea27ce4eb39c150a837e50a905.png
[format_png 9]: /images/20210527/c24e098d55a24160b3795a1f51802d4d.png
[format_png 10]: /images/20210527/21adb2179b0f45928b22d7c484484db2.png
[format_png 11]: /images/20210527/8da90dd282d84f7eae099aa88a1a2c7d.png
[format_png 12]: /images/20210527/043e88ee92ee4c59a14fdab98901d39a.png
[format_png 13]: /images/20210527/58fd778497a04f61949d3c3d0d1ed0d2.png
[format_png 14]: /images/20210527/29a19eb2bb1743bda5ffe8dbef221d50.png
[format_png 15]: /images/20210527/a2bbfb95e55f4ffe8ab5835682cdd43e.png
[format_png 16]: /images/20210527/98ac02ea5b754a43b7b52cb3b23d6361.png
[format_png 17]: /images/20210527/e9db8e1b0cc64d37b618746ae3f3ca57.png
[format_png 18]: /images/20210527/72fdf5155f984650b0e3094a0539e8b2.png
[format_png 19]: /images/20210527/ec7ed6bfc7f847dc8d3a48efd96af7a2.png
[format_png 20]: /images/20210527/15d519348ce040b7b6f6bffa43879da3.png
[format_png 21]: /images/20210527/b34f3b92acb0444c8099c5842f8d436d.png
[format_png 22]: /images/20210527/f86da8401e1348fcb9b34c128c493929.png
[format_png 23]: /images/20210527/ac6acae646304fcda8ae4d56382cc8a2.png
[format_png 24]: /images/20210527/d03d2244386b42ebae92744559d95251.png
[format_png 25]: /images/20210527/898db33a280d4724b91cb21d549c0a46.png
[format_png 26]: /images/20210527/cf0308798524474586dca7a39b4870ee.png
[format_png 27]: /images/20210527/65acd461552043b48a899bc9ea771199.png
[format_png 28]: /images/20210527/583820bcfaf84ce1a0d50c9761d67660.png
[format_png 29]: /images/20210527/a94f870a7d884c549cd3013298da3291.png
[format_png 30]: /images/20210527/352c3f5cd355416dbdfb993186281925.png
[format_png 31]: /images/20210527/c6f1fd82cb3f48c7bf77618a4276c245.png
[format_png 32]: /images/20210527/2ac9954f70504a83bcad57d5c6104455.png
[format_png 33]: /images/20210527/1242f3c5356c4032866c5e4a199eced9.png