深刻Spring Boot：ClassLoader的繼承關係和影響

前言

對spring boot自己啓動原理的分析，請參考：hengyunabc.github.io/spring-boot…

Spring boot裏的ClassLoader繼承關係

能夠運行下面提供的demo，分別在不一樣的場景下運行，能夠知道不一樣場景下的Spring boot應用的ClassLoader繼承關係。

github.com/hengyunabc/…

分三種狀況：

在IDE裏，直接run main函數

則Spring的ClassLoader直接是SystemClassLoader。ClassLoader的urls包含所有的jar和本身的target/classes

========= Spring Boot Application ClassLoader Urls =============
ClassLoader urls: sun.misc.Launcher$AppClassLoader@2a139a55
file:/Users/hengyunabc/code/java/spring-boot-inside/demo-classloader-context/target/classes/
file:/Users/hengyunabc/.m2/repository/org/springframework/cloud/spring-cloud-starter/1.1.9.RELEASE/spring-cloud-starter-1.1.9.RELEASE.jar
file:/Users/hengyunabc/.m2/repository/org/springframework/boot/spring-boot-starter/1.4.7.RELEASE/spring-boot-starter-1.4.7.RELEASE.jar
...
複製代碼

以fat jar運行

mvn clean package
java -jar target/demo-classloader-context-0.0.1-SNAPSHOT.jar
複製代碼

執行應用的main函數的ClassLoader是LaunchedURLClassLoader，它的parent是SystemClassLoader。

========= ClassLoader Tree=============
org.springframework.boot.loader.LaunchedURLClassLoader@1218025c
- sun.misc.Launcher$AppClassLoader@6bc7c054
-- sun.misc.Launcher$ExtClassLoader@85ede7b
複製代碼

而且LaunchedURLClassLoader的urls是 fat jar裏的BOOT-INF/classes!/目錄和BOOT-INF/lib裏的全部jar。

========= Spring Boot Application ClassLoader Urls =============
ClassLoader urls: org.springframework.boot.loader.LaunchedURLClassLoader@1218025c
jar:file:/Users/hengyunabc/code/java/spring-boot-inside/demo-classloader-context/target/demo-classloader-context-0.0.1-SNAPSHOT.jar!/BOOT-INF/classes!/
jar:file:/Users/hengyunabc/code/java/spring-boot-inside/demo-classloader-context/target/demo-classloader-context-0.0.1-SNAPSHOT.jar!/BOOT-INF/lib/spring-boot-1.4.7.RELEASE.jar!/
jar:file:/Users/hengyunabc/code/java/spring-boot-inside/demo-classloader-context/target/demo-classloader-context-0.0.1-SNAPSHOT.jar!/BOOT-INF/lib/spring-web-4.3.9.RELEASE.jar!/
...
複製代碼

SystemClassLoader的urls是demo-classloader-context-0.0.1-SNAPSHOT.jar自己。

========= System ClassLoader Urls =============
ClassLoader urls: sun.misc.Launcher$AppClassLoader@6bc7c054
file:/Users/hengyunabc/code/java/spring-boot-inside/demo-classloader-context/target/demo-classloader-context-0.0.1-SNAPSHOT.jar
複製代碼

以解壓目錄運行

mvn clean package
cd target
unzip demo-classloader-context-0.0.1-SNAPSHOT.jar -d demo
cd demo
java org.springframework.boot.loader.PropertiesLauncher
複製代碼

執行應用的main函數的ClassLoader是LaunchedURLClassLoader，它的parent是SystemClassLoader。

========= ClassLoader Tree=============
org.springframework.boot.loader.LaunchedURLClassLoader@4aa298b7
- sun.misc.Launcher$AppClassLoader@2a139a55
-- sun.misc.Launcher$ExtClassLoader@1b6d3586
複製代碼

LaunchedURLClassLoader的urls是解壓目錄裏的BOOT-INF/classes/和/BOOT-INF/lib/下面的jar包。

========= Spring Boot Application ClassLoader Urls =============
ClassLoader urls: org.springframework.boot.loader.LaunchedURLClassLoader@4aa298b7
file:/Users/hengyunabc/code/java/spring-boot-inside/demo-classloader-context/target/demo/BOOT-INF/classes/
jar:file:/Users/hengyunabc/code/java/spring-boot-inside/demo-classloader-context/target/demo/BOOT-INF/lib/bcpkix-jdk15on-1.55.jar!/
jar:file:/Users/hengyunabc/code/java/spring-boot-inside/demo-classloader-context/target/demo/BOOT-INF/lib/bcprov-jdk15on-1.55.jar!/
jar:file:/Users/hengyunabc/code/java/spring-boot-inside/demo-classloader-context/target/demo/BOOT-INF/lib/classmate-1.3.3.jar!/
複製代碼

SystemClassLoader的urls只有當前目錄：

========= System ClassLoader Urls =============
ClassLoader urls: sun.misc.Launcher$AppClassLoader@2a139a55
file:/Users/hengyunabc/code/java/spring-boot-inside/demo-classloader-context/target/demo/
複製代碼

其實還有兩種運行方式：mvn spring-boot:run 和 mvn spring-boot:run -Dfork=true，可是比較少使用，不單獨討論。感受興趣的話能夠自行跑下。

總結spring boot裏ClassLoader的繼承關係

• 在IDE裏main函數執行時，只有一個ClassLoader，也就是SystemClassLoader

• 在以fat jar運行時，有一個LaunchedURLClassLoader，它的parent是SystemClassLoader

  LaunchedURLClassLoader的urls是fat jar裏的BOOT-INF/classes和BOOT-INF/lib下的jar。SystemClassLoader的urls是fat jar自己。

• 在解壓目錄（exploded directory）運行時，和fat jar相似，不過url都是目錄形式。目錄形式會有更好的兼容性。

spring boot 1.3.* 和 1.4.* 版本的區別

在spring boot 1.3.* 版本里

• 應用的類和spring boot loader的類都是打包在一個fat jar裏
• 應用依賴的jar放在fat jar裏的/lib下面。

在spring boot 1.4.* 版本後

• spring boot loader的類放在fat jar裏
• 應用的類打包放在fat jar的BOOT-INF/classes目錄裏
• 應用依賴的jar放在fat jar裏的/lib下面。

spring boot 1.4的打包結構改動是這個commit引入的 github.com/spring-proj…

這個commit的本意是簡化classloader的繼承關係，以一種直觀的parent優先的方式來實現LaunchedURLClassLoader，同時打包結構和傳統的war包應用更接近。

可是這個改動引發了不少複雜的問題，從上面咱們分析的ClassLoader繼承關係就有點頭暈了。

目前的ClassLoader繼承關係帶來的一些影響

有不少用戶可能會發現，一些代碼在IDE裏跑得很好，可是在實際部署運行時不工做。不少時候就是ClassLoader的結構引發的，下面分析一些案例。

demo.jar!/BOOT-INF/classes!/ 這樣子url不工做

由於spring boot是擴展了標準的jar協議，讓它支持多層的jar in jar，還有directory in jar。參考spring boot應用啓動原理分析

在spring boot 1.3的時候儘管會有jar in jar，可是一些比較健壯的代碼能夠處理這種狀況，好比tomcat8本身就支持jar in jar。

可是絕大部分代碼都不會支持像demo.jar!/BOOT-INF/classes!/ 這樣子directory in jar的多重url，因此在spring boot1.4裏，不少庫的代碼都會失效。

demo.jar!/META-INF/resources 下的資源問題

在servlet 3.0規範裏，應用能夠把靜態資源放在META-INF/resources下面，servlet container會支持讀取。可是從上面的繼承結果，咱們能夠發現一個問題：

• 應用以fat jar來啓動，啓動embedded tomcat的ClassLoader是LaunchedURLClassLoader
• LaunchedURLClassLoader的urls並無fat jar自己
• 應用的main函數所在的模塊的src/main/resources/META-INF/resources目錄被打包到了fat jar裏，也就是demo.jar!/META-INF/resources
• 應用的fat jar是SystemClassLoader的url，也就是LaunchedURLClassLoader的parent

這樣子就形成了一些奇怪的現象：

• 應用直接用本身的ClassLoader.getResources()是能夠獲取到META-INF/resources的資源的
• 可是embedded tomcat並無把fat jar自己加入到它的 ResourcesSet 裏，由於它在啓動時ClassLoader是LaunchedURLClassLoader，它只掃描本身的ClassLoader的urls
• 應用把資源放在其它的jar包的META-INF/resources下能夠訪問到，把資源放在本身的main函數的src/main/resources/META-INF/resources下時，訪問不到了

另外，spring boot的官方jsp的例子只支持war的打包格式，不支持fat jar，也是由這個引發的。

getResource("") 和 getResources("") 的返回值的問題

getResource("")的語義是返回ClassLoader的urls的第一個url，不少時候使用者覺得這個就是它們本身的classes的目錄，或者是jar的url。

可是實際上，由於ClassLoader加載urls列表時，有隨機性，和OS低層實現有關，並不能保證urls的順序都是同樣的。因此getResource("")不少時候返回的結果並不同。

可是不少庫，或者應用依賴這個代碼來定位掃描資源，這樣子在spring boot下就不工做了。

另外，值得注意的是spring boot在三種不一樣形式下運行，getResources("")返回的結果也不同。用戶能夠本身改下demo裏的代碼，打印下結果。

簡而言之，不要依賴這兩個API，最好本身放一個資源來定位。或者直接利用spring自身提供的資源掃描機制。

相似 classpath*:**-service.xml 的通配問題

用戶有多個代碼模塊，在不一樣模塊下都放了多個*-service.xml的spring配置文件。

用戶若是使用相似classpath*:**-service.xml的通配符來加載資源的話，頗有可能出如今IDE裏跑時，能夠正確加載，可是在fat jar下，卻加載不到的問題。

從spring本身的文檔能夠看到相關的解析：

docs.spring.io/spring/docs…

WARNING: Note that "classpath*:" when combined with Ant-style patterns will only work reliably with at least one root directory before the pattern starts, unless the actual target files reside in the file system. This means that a pattern like "classpath*:*.xml" will not retrieve files from the root of jar files but rather only from the root of expanded directories. This originates from a limitation in the JDK's ClassLoader.getResources() method which only returns file system locations for a passed-in empty String (indicating potential roots to search). This ResourcePatternResolver implementation is trying to mitigate the jar root lookup limitation through URLClassLoader introspection and "java.class.path" manifest evaluation; however, without portability guarantees.

就是說使用 classpath*來匹配其它的jar包時，須要有一層目錄在前面，否則的話是匹配不到的，這個是ClassLoader.getResources() 函數致使的。

由於在IDE裏跑時，應用所依賴的其它模塊一般就是一個classes目錄，因此一般沒有問題。

可是當以fat jar來跑時，其它的模塊都被打包爲一個jar，放在BOOT-INF/lib下面，因此這時通配就會失敗。

總結

• 這個新的BOOT-INF打包格式有它的明顯好處：更清晰，更接近war包的格式。
• spring boot的ClassLoader的結構修改帶來的複雜問題，並不是當初修改的人所能預見的
• 不少問題須要理解spring boot的ClassLoader結構，不然不能找到根本緣由

微信公衆號

橫雲斷嶺的專欄