最近優(yōu)化項(xiàng)目架構(gòu)針對(duì)Logback日志框架需要結(jié)合Spring的profiles配置文件達(dá)到不同運(yùn)行環(huán)境自動(dòng)配置參數(shù).
最開(kāi)始想法是使用ServletContextListener監(jiān)聽(tīng)器實(shí)現(xiàn)在項(xiàng)目初始化時(shí)讀取Spring的profiles配置文件手動(dòng)放入當(dāng)前環(huán)境變量中但在測(cè)試過(guò)程中發(fā)現(xiàn)問(wèn)題!
環(huán)境變量還沒(méi)有開(kāi)始加載, Logback框架已經(jīng)開(kāi)始被加載!
跟蹤日志信息發(fā)現(xiàn)一個(gè)類LogbackServletContainerInitializer,?Logback是通過(guò)該類進(jìn)行Web環(huán)境初始化的!該類實(shí)現(xiàn)了javax.servlet.ServletContainerInitializer接口
第一次接觸ServletContainerInitializer查找了一下相關(guān)規(guī)范, 于是自己也寫了一個(gè)ServletContainerInitializer接口的類LogInitializer在但發(fā)現(xiàn)放置WebContent/META-INF/services/javax.servlet.ServletContainerInitializer文件無(wú)法被讀取, 網(wǎng)上說(shuō)只有放置在WebContent/WEB-INF/lib下的Jar包中才能被讀取!
單獨(dú)建立一個(gè)新的項(xiàng)目通過(guò)Maven引入到原有項(xiàng)目中, 忽然發(fā)現(xiàn)LogbackServletContainerInitializer和LogInitializer存在先后加載順序問(wèn)題, 經(jīng)過(guò)幾次測(cè)試發(fā)現(xiàn)跟Jar包名稱的先后順序有關(guān), 于是開(kāi)始跟蹤Tomcat運(yùn)行時(shí)的Debug調(diào)試看看Tomcat是怎么加載ServletContainerInitializer實(shí)例的!
開(kāi)發(fā)工具: IDEA 2017.2.6版
Servlet容器: Tomcat 8.5.20
在LogInitializer#onStartup()方法第一行打斷點(diǎn)等待
進(jìn)入斷點(diǎn)后觀察調(diào)用堆棧, 發(fā)現(xiàn)是org.apache.catalina.core.StandardContext#startInternal() 調(diào)用了LogInitializer#onStartup()
進(jìn)入org.apache.catalina.core.StandardContext#startInternal()方法, 發(fā)現(xiàn)一個(gè)成員變量迭代調(diào)用
跟蹤成員屬性initializers發(fā)現(xiàn)是一個(gè)鏈表哈希映射
繼續(xù)根據(jù)initializers被調(diào)用情況, 發(fā)現(xiàn)org.apache.catalina.core.StandardContext#addServletContainerInitializer()向成員屬性中放入實(shí)例
查找org.apache.catalina.core.StandardContext#addServletContainerInitializer()方法被調(diào)用情況, 發(fā)現(xiàn)在org.apache.catalina.startup.ContextConfig#webConfig()方法中一個(gè)成員屬性迭代調(diào)用
跟蹤initializerClassMap成員屬性發(fā)現(xiàn)類似于剛才的initializers
跟蹤initializerClassMap被放入對(duì)象, 發(fā)現(xiàn)org.apache.catalina.startup.ContextConfig#processServletContainerInitializers()方法
進(jìn)入org.apache.catalina.startup.WebappServiceLoader#load()方法觀察ServletContainerInitializer實(shí)例被加載情況
觀察了一下javax.servlet.ServletContext.ORDERED_LIBS靜態(tài)常量發(fā)現(xiàn)與web.xml中的<absolute-ordering>元素相關(guān), 因?yàn)闆](méi)有配置所以先不考慮, 這樣判斷orderedLibs!=null不會(huì)被執(zhí)行類加載器loader的引用就是當(dāng)前項(xiàng)目Servlet容器的類加載器去加載資源
查找到五個(gè)資源, Tomcat容器自身2個(gè), LogInitializer,?LogbackServletContainerInitializer,?SpringServletContainerInitializer(Spring的) ?這個(gè)時(shí)候已經(jīng)明了ServletContainerInitializer一般情況下是基于類加載器加載資源的枚舉迭代順序, 因?yàn)槲屑虞d機(jī)制會(huì)從最頂級(jí)類加載向下一直加載到當(dāng)前項(xiàng)目Web容器類加載器下的資源, 到此基本已經(jīng)弄清楚ServletContainerInitializer加載流程!
因?yàn)榭匆?jiàn)了ORDERED_LIBS常量所以想繼續(xù)研究一下<absolute-ordering>元素, 大概看了一下相關(guān)規(guī)范文檔定義, 該元素是Servlet3.0出現(xiàn)的為第三方插件Jar包自動(dòng)配置一些Servlet, Filter時(shí)所有第三方插件按照指定絕對(duì)順序加載Jar包資源
1. 在Jar包的META-INF目錄下建立web-fragment.xml
2, 配置web.xml
在org.apache.catalina.startup.WebappServiceLoader#load()方法打斷點(diǎn), 發(fā)現(xiàn)找到一個(gè)jar包
將當(dāng)前項(xiàng)目Web容器類加載器替換為Tomca容器類加載器是因?yàn)槲屑虞d機(jī)制從最頂級(jí)類加載器加載到當(dāng)前類加載器所以會(huì)導(dǎo)致當(dāng)前項(xiàng)目Web容器不會(huì)被加載到, 就會(huì)跳過(guò)當(dāng)前項(xiàng)目下WEB-INF/lib中的Jar包查找所以只有l(wèi)og-initializer-0.1.jar中的ServletContainerInitializer被加載,?LogbackServletContainerInitializer, SpringServletContainerInitializer的配置丟失
不符合預(yù)期結(jié)果, 繼續(xù)看<absolute-ordering>文檔, 發(fā)現(xiàn)一個(gè)<others />元素, 在<absolute-ordering>中追加
重新開(kāi)始在org.apache.catalina.startup.WebappServiceLoader#load()方法斷點(diǎn)Debug
這次就有所有Jar包了, 但很好奇去項(xiàng)目部署的Tomcat下WEB-INF/lib 看了一下Jar包數(shù)量 44個(gè) ?而非37個(gè)逐一匹配發(fā)現(xiàn)缺少這些Jar包
非常好奇為什么會(huì)丟失Jar包, 如果只是丟失apache相關(guān)的也可能Tomcat排除自身lib下相關(guān)的, 但是slf4j, aspecj居然也沒(méi)有, 本著求知的好奇心繼續(xù)調(diào)試, 找出缺少Jar包的原因
因?yàn)槭峭ㄟ^(guò)ORDERED_LIBS常量獲取的容器屬性值, 所以直接在org.apache.catalina.core.ApplicationContext#setAttribute()使用條件斷點(diǎn)
查看堆棧信息, 發(fā)現(xiàn)被org.apache.tomcat.util.descriptor.web.WebXml#orderWebFragments()方法調(diào)用
跟蹤局部變量orderedFragments
發(fā)現(xiàn)是局部變量fragments映射迭代放入, 而fragments是由外部傳遞
繼續(xù)向上跟蹤堆棧
找到org.apache.tomcat.JarScanner實(shí)現(xiàn)類org.apache.tomcat.util.scan.StandardJarScanner#scan()方法
找到org.apache.tomcat.JarScanFilter實(shí)現(xiàn)類org.apache.tomcat.util.scan.StandardJarScanFilter#check()方法
至此基本上算是了解ServletContainerInitializer加載機(jī)制!
