淺析 SpringBoot FatJar 機制的設計與實現
一、概述
SpringBoot FatJar 的設計，打破了標準 jar 的結構，在 jar 包內攜帶了其所依賴的 jar 包，通過在標準 jar 包中指定的 Main-Class 的 main 方法啟動后，創建自己的類加載器，來識別、加載、運行其非規范的目錄下的代碼（BOOT-INF/classes/...）和依賴（BOOT-INF/lib/...）。BOOT-INF/classes/ 目錄下有 SpringBoot 上下文的啟動類的 class 文件，自定義類加載器加載這個啟動類后，開始進入 SpringBoot 的上下文中運行我們所寫的程序代碼。執行的流程可概括為：
- 通過 java -jar xxx.jar 啟動應用
- 執行 xxx.jar 中 META-INF/MANIFEST.MF 里 Main-Class 所指定的 JarLauncher 類的 main 方法
- main 方法中創建自定義的 ClassLoader 即 LaunchedURLClassLoader，并將其設置為線程上下文類加載器
- 由 LaunchedURLClassLoader 加載 META-INF/MANIFEST.MF 里 Start-Class 所指定的 SpringBoot 應用的啟動類（在 BOOT-INF/classes/目錄下），調用其 main 方法，開始執行 SpringApplication.run(...)
二、標準的 jar 包結構
打開 Java 的 jar 文件我們經?？梢钥吹轿募邪粋€META-INF目錄，這個目錄下會有一些文件，其中必有一個MANIFEST.MF，這個文件描述了該 Jar 文件的很多信息 其中 Main-Class 定義 Jar 文件的入口類，該類必須是一個可執行的類，一旦定義了該屬性即可通過 java -jar xxx.jar來運行該 jar 文件。
在生產環境中，是使用java -jar xxx.jar 的方式來運行 SpringBoot 程序。這種情況下，SpringBoot 應用真實的啟動類并不是我們所定義的帶有 main 方法的啟動類，而是其內置的 JarLauncher 類。查看 SpringBoot 所打成的 fat jar，其 Main-Class 是org.springframework.boot.loader.JarLauncher，這便是微妙之處。
Spring-Boot-Version: 2.1.3.RELEASE
Main-Class: org.springframework.boot.loader.JarLauncher
Start-Class: com.rock.springbootlearn.SpringbootLearnApplication
Spring-Boot-Classes: BOOT-INF/classes/
Spring-Boot-Lib: BOOT-INF/lib/
Build-Jdk: 1.8.0_131JAR 包中的 MANIFEST.MF 文件詳解以及編寫規范[1]
三、探索 JarLauncher
org.springframework.boot.loader.JarLauncher這個類是哪里來的呢？答案在 spring-boot-loader-***.jar 包中，可找到這個 JarLauncher 類的源碼。在項目中加入 maven 依賴，以便查看源碼和遠程調試。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-loader</artifactId>
</dependency>
圖片
認真比較可以看出，這個 spring-boot-loader 包中的內容與 SpringBoot 的 FatJar 包中的一部分內容幾乎一樣。JarLauncher 在 jar 中的位置如下:
圖片
3.1 只能拷貝出來一份兒
重點重點重點：因 jar 規范要求 Main-Class 所指定的類必須位于 jar 包的頂層目錄下，即 org.springframework.boot.loader.JarLauncher 這個 org 必須位于 jar 包中的第一級目錄，不能放置在其他的目錄下。所以 所以 所以（重點）只能將 spring-boot-loader 這個 jar 包的內容拷貝出來，而不是整個 jar 直接放置于執行 Jar 中。
3.2 攜帶程序所依賴的 jar 而非僅 class
圖片
上邊 JarLauncher 的這個 org.springframework.xx 以及 META-INF 這兩個目錄是符合 jar 包規范的。但是 BOOT-INF 這個目錄里邊有點像我們開發中的一些用法：
- 依賴的 jar 包在 lib 目錄下
- 但按照 jar 包規范 jar 中不能有 jar 包的情況下
- 程序.class 文件在 classes 目錄下
- 但 xxx.class 文件應該按照 org.springframework.xx 這樣放置在 jar 中的根目錄中
所以classes 和 lib 你也能意識到，這個設計是獨特的。早期 jar 包內攜帶依賴是采用如 maven-shade-plugin 的做法，把依賴的 class 文件拷貝到目標 jar 中，但也會造成重名(全限定名)的類會出現覆蓋的情況。后來 SpringBoot 為了避免提取覆蓋的情況，修改了打包機制，放棄了maven-shade-plugin那種拷貝 class 的方式，調整為依賴原始 jar 包；這同時意味著改變了 jar 標準的運行機制，那么要想讓classes和lib中代碼能夠正常運行，你試想一下如果沒有自定義的類加載器來加載這些類文件，可以嘛？答案是：不可以，需要自定義類加載器。
四、 自定義類加載器的運行機制
通常自定義類加載器完成資源加載的核心邏輯為：
- 指定資源
- 指定委托關系
- 指定線程上下文類加載器
- 調用邏輯入口方法
所以 SpringBoot FatJar 中自定義 ClassLoader 中的核心邏輯也是如此。
4.1 指定資源
構造方法中基于 jar 包的文件系統信息，構造 Archive 對象
public ExecutableArchiveLauncher() {
this.archive = createArchive();
}
protected final Archive createArchive() throws Exception {
ProtectionDomain protectionDomain = getClass().getProtectionDomain();
CodeSource codeSource = protectionDomain.getCodeSource();
URI location = (codeSource != null) ? codeSource.getLocation().toURI() : null;
String path = (location != null) ? location.getSchemeSpecificPart() : null;
if (path == null) {
throw new IllegalStateException("Unable to determine code source archive");
}
File root = new File(path);
if (!root.exists()) {
throw new IllegalStateException(
"Unable to determine code source archive from " + root);
}
return (root.isDirectory() ? new ExplodedArchive(root)
: new JarFileArchive(root));
}采集 jar 包中的 classes和lib目錄下的歸檔文件。后邊創建 ClassLoader 的時候作為參數傳入
@Override
protected List<Archive> getClassPathArchives() throws Exception {
List<Archive> archives = new ArrayList<>(
this.archive.getNestedArchives(this::isNestedArchive));
postProcessClassPathArchives(archives);
return archives;
}
protected boolean isNestedArchive(Archive.Entry entry) {
if (entry.isDirectory()) {
return entry.getName().equals(BOOT_INF_CLASSES);
}
return entry.getName().startsWith(BOOT_INF_LIB);
}4.2 創建自定義 ClassLoader
protected void launch(String[] args) throws Exception {
JarFile.registerUrlProtocolHandler();
//創建類加載器, 并指定歸檔文件
ClassLoader classLoader = createClassLoader(getClassPathArchives());
launch(args, getMainClass(), classLoader);
}
//創建類加載器, 將歸檔文件轉換為URL
protected ClassLoader createClassLoader(List<Archive> archives) throws Exception {
List<URL> urls = new ArrayList<>(archives.size());
for (Archive archive : archives) {
urls.add(archive.getUrl());
}
return createClassLoader(urls.toArray(new URL[0]));
}
//父加載器是AppClassLoader
protected ClassLoader createClassLoader(URL[] urls) throws Exception {
//getClass().getClassLoader() 是系統類加載器,因為默認情況下main方法所在類是由SystemClassLoader加載的,默認情況下是AppClassLoader.
return new LaunchedURLClassLoader(urls, getClass().getClassLoader());
}4.3 設置線程上下文類加載器，調用程序中的 main 方法
public static void main(String[] args) throws Exception {
new JarLauncher().launch(args);
}
protected void launch(String[] args, String mainClass, ClassLoader classLoader)
throws Exception {
//設置線程上下文類加載器
Thread.currentThread().setContextClassLoader(classLoader);
//調用MANIFEST.MF 中配置的Start-Class: xxx的main方法,還帶入了參數
createMainMethodRunner(mainClass, args, classLoader).run();本文轉載自微信公眾號「架構染色」，可以通過以下二維碼關注。轉載本文請聯系【架構染色】公眾號作者。
