一、概述

SpringBoot FatJar 的設(shè)計(jì)，打破了標(biāo)準(zhǔn) jar 的結(jié)構(gòu)，在 jar 包內(nèi)攜帶了其所依賴的 jar 包，通過(guò)在標(biāo)準(zhǔn) jar 包中指定的 Main-Class 的 main 方法啟動(dòng)后，創(chuàng)建自己的類加載器，來(lái)識(shí)別、加載、運(yùn)行其非規(guī)范的目錄下的代碼（BOOT-INF/classes/...）和依賴（BOOT-INF/lib/...）。BOOT-INF/classes/ 目錄下有 SpringBoot 上下文的啟動(dòng)類的 class 文件，自定義類加載器加載這個(gè)啟動(dòng)類后，開始進(jìn)入 SpringBoot 的上下文中運(yùn)行我們所寫的程序代碼。執(zhí)行的流程可概括為：

1. 通過(guò) java -jar xxx.jar 啟動(dòng)應(yīng)用
2. 執(zhí)行 xxx.jar 中 META-INF/MANIFEST.MF 里 Main-Class 所指定的 JarLauncher  類的 main 方法
3.  main 方法中創(chuàng)建自定義的 ClassLoader 即 LaunchedURLClassLoader，并將其設(shè)置為線程上下文類加載器
4. 由 LaunchedURLClassLoader 加載 META-INF/MANIFEST.MF 里 Start-Class 所指定的 SpringBoot 應(yīng)用的啟動(dòng)類（在 BOOT-INF/classes/目錄下），調(diào)用其 main 方法，開始執(zhí)行 SpringApplication.run(...)

二、標(biāo)準(zhǔn)的 jar 包結(jié)構(gòu)

打開 Java 的 jar 文件我們經(jīng)?？梢钥吹轿募邪粋€(gè)META-INF目錄，這個(gè)目錄下會(huì)有一些文件，其中必有一個(gè)MANIFEST.MF，這個(gè)文件描述了該 Jar 文件的很多信息 其中 Main-Class 定義 Jar 文件的入口類，該類必須是一個(gè)可執(zhí)行的類，一旦定義了該屬性即可通過(guò)  java -jar xxx.jar來(lái)運(yùn)行該 jar 文件。

在生產(chǎn)環(huán)境中，是使用java -jar xxx.jar 的方式來(lái)運(yùn)行 SpringBoot 程序。這種情況下，SpringBoot 應(yīng)用真實(shí)的啟動(dòng)類并不是我們所定義的帶有 main 方法的啟動(dòng)類，而是其內(nèi)置的 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_131

JAR 包中的 MANIFEST.MF 文件詳解以及編寫規(guī)范[1]

三、探索 JarLauncher

org.springframework.boot.loader.JarLauncher這個(gè)類是哪里來(lái)的呢？答案在 spring-boot-loader-***.jar 包中，可找到這個(gè) JarLauncher 類的源碼。在項(xiàng)目中加入 maven 依賴，以便查看源碼和遠(yuǎn)程調(diào)試。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-loader</artifactId>
</dependency>

圖片

認(rèn)真比較可以看出，這個(gè) spring-boot-loader 包中的內(nèi)容與 SpringBoot 的 FatJar 包中的一部分內(nèi)容幾乎一樣。JarLauncher 在 jar 中的位置如下:

圖片

3.1 只能拷貝出來(lái)一份兒

重點(diǎn)重點(diǎn)重點(diǎn)：因 jar 規(guī)范要求 Main-Class 所指定的類必須位于 jar 包的頂層目錄下，即 org.springframework.boot.loader.JarLauncher 這個(gè) org 必須位于 jar 包中的第一級(jí)目錄，不能放置在其他的目錄下。所以 所以 所以（重點(diǎn)）只能將 spring-boot-loader 這個(gè) jar 包的內(nèi)容拷貝出來(lái)，而不是整個(gè) jar 直接放置于執(zhí)行 Jar 中。

3.2 攜帶程序所依賴的 jar 而非僅 class

圖片

上邊 JarLauncher 的這個(gè) org.springframework.xx 以及 META-INF 這兩個(gè)目錄是符合 jar 包規(guī)范的。但是 BOOT-INF 這個(gè)目錄里邊有點(diǎn)像我們開發(fā)中的一些用法：

• 依賴的  jar 包在 lib 目錄下

• 但按照 jar 包規(guī)范 jar 中不能有 jar 包的情況下

• 程序.class 文件在 classes 目錄下
• 但 xxx.class 文件應(yīng)該按照 org.springframework.xx 這樣放置在 jar 中的根目錄中

所以classes 和 lib 你也能意識(shí)到，這個(gè)設(shè)計(jì)是獨(dú)特的。早期 jar 包內(nèi)攜帶依賴是采用如 maven-shade-plugin 的做法，把依賴的 class 文件拷貝到目標(biāo) jar 中，但也會(huì)造成重名(全限定名)的類會(huì)出現(xiàn)覆蓋的情況。后來(lái) SpringBoot 為了避免提取覆蓋的情況，修改了打包機(jī)制，放棄了maven-shade-plugin那種拷貝 class 的方式，調(diào)整為依賴原始 jar 包；這同時(shí)意味著改變了 jar 標(biāo)準(zhǔn)的運(yùn)行機(jī)制，那么要想讓classes和lib中代碼能夠正常運(yùn)行，你試想一下如果沒有自定義的類加載器來(lái)加載這些類文件，可以嘛？答案是：不可以，需要自定義類加載器。

四、 自定義類加載器的運(yùn)行機(jī)制

通常自定義類加載器完成資源加載的核心邏輯為：

1. 指定資源
2. 指定委托關(guān)系
3. 指定線程上下文類加載器
4. 調(diào)用邏輯入口方法

所以 SpringBoot FatJar 中自定義 ClassLoader 中的核心邏輯也是如此。

4.1 指定資源

構(gòu)造方法中基于 jar 包的文件系統(tǒng)信息，構(gòu)造 Archive 對(duì)象

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目錄下的歸檔文件。后邊創(chuàng)建 ClassLoader 的時(shí)候作為參數(shù)傳入

@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 創(chuàng)建自定義 ClassLoader

protected void launch(String[] args) throws Exception {
 JarFile.registerUrlProtocolHandler();
        //創(chuàng)建類加載器, 并指定歸檔文件
 ClassLoader classLoader = createClassLoader(getClassPathArchives());
 launch(args, getMainClass(), classLoader);
}
//創(chuàng)建類加載器, 將歸檔文件轉(zhuǎn)換為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() 是系統(tǒng)類加載器,因?yàn)槟J(rèn)情況下main方法所在類是由SystemClassLoader加載的,默認(rèn)情況下是AppClassLoader.
 return new LaunchedURLClassLoader(urls, getClass().getClassLoader());
}

4.3 設(shè)置線程上下文類加載器，調(diào)用程序中的 main 方法

public static void main(String[] args) throws Exception {
 new JarLauncher().launch(args);
}
protected void launch(String[] args, String mainClass, ClassLoader classLoader)
  throws Exception {
        //設(shè)置線程上下文類加載器
 Thread.currentThread().setContextClassLoader(classLoader);
 //調(diào)用MANIFEST.MF 中配置的Start-Class: xxx的main方法,還帶入了參數(shù)
        createMainMethodRunner(mainClass, args, classLoader).run();

本文轉(zhuǎn)載自微信公眾號(hào)「架構(gòu)染色」，可以通過(guò)以下二維碼關(guān)注。轉(zhuǎn)載本文請(qǐng)聯(lián)系【架構(gòu)染色】公眾號(hào)作者。