快捷導(dǎo)航

Springboot?-?Fat?Jar示例詳解

更新時(shí)間：2023年02月01日 17:16:44 作者：光陰迷客

這篇文章主要介紹了Springboot?-?Fat?Jar詳解,Spring?Boot內(nèi)嵌容器，通過java?-jar命令便可以直接啟動(dòng)應(yīng)用，今天帶著大家探索FAT?JAR啟動(dòng)的背后原理，需要的朋友可以參考下

導(dǎo)讀

Spring Boot應(yīng)用可以使用spring-boot-maven-plugin快速打包，構(gòu)建一個(gè)可執(zhí)行jar。Spring Boot內(nèi)嵌容器，通過java -jar命令便可以直接啟動(dòng)應(yīng)用。

雖然是一個(gè)簡單的啟動(dòng)命令，背后卻藏著很多知識(shí)。今天帶著大家探索FAT JAR啟動(dòng)的背后原理。本文主要包含以下幾個(gè)部分：

JAR 是什么。首先需要了解jar是什么，才知道java -jar做了什么事情。
FatJar 有什么不同。 Spring Boot提供的可執(zhí)行jar與普通的jar有什么區(qū)別。
啟動(dòng)時(shí)的類加載原理。啟動(dòng)過程中類加載器做了什么？Spring Boot又如何通過自定義類加載器解決內(nèi)嵌包的加載問題。
啟動(dòng)的整個(gè)流程。最后整合前面三部分的內(nèi)容，解析源碼看如何完成啟動(dòng)。

JAR 是什么

JAR簡介

JAR文件（Java歸檔，英語: Java ARchive）是一種軟件包文件格式，通常用于將大量的Java類文件、相關(guān)的元數(shù)據(jù)和資源（文本、圖片等）文件聚合到一個(gè)文件，以便分發(fā)Java平臺(tái)應(yīng)用軟件或庫。簡單點(diǎn)理解其實(shí)就是一個(gè)壓縮包，既然是壓縮包那么為了提取JAR文件的內(nèi)容，可以使用任何標(biāo)準(zhǔn)的unzip解壓縮軟件提取內(nèi)容?；蛘呤褂肑ava虛擬機(jī)自帶命令jar -xf foo.jar來解壓相應(yīng)的jar文件。

JAR 可以簡單分為兩類：

非可執(zhí)行JAR。打包時(shí)，不用指定main-class，也不可運(yùn)行。普通jar包可以供其它項(xiàng)目進(jìn)行依賴。
可執(zhí)行JAR。打jar包時(shí)，指定了main-class類，可以通過java -jar xxx.jar命令，執(zhí)行main-class的main方法，運(yùn)行jar包。可運(yùn)行jar包不可被其他項(xiàng)目進(jìn)行依賴。

JAR結(jié)構(gòu)

包結(jié)構(gòu)

不管是非可行JAR還是可執(zhí)行JAR解壓后都包含兩部分：META-INF目錄(元數(shù)據(jù))和package目錄(編譯后的class)。這種普通的jar不包含第三方依賴包，只包含應(yīng)用自身的配置文件、class 等。

.
├── META-INF
│   ├── MANIFEST.MF  #定義
└── org  # 包路徑(存放編譯后的class)
    └── springframework

描述文件MANIFEST.MF

JAR包的配置文件是META-INF文件夾下的MANIFEST.MF文件。主要配置信息如下：

Manifest-Version：用來定義manifest文件的版本，例如：Manifest-Version: 1.0
Created-By：聲明該文件的生成者，一般該屬性是由jar命令行工具生成的，例如：Created-By: Apache Ant 1.5.1
Signature-Version：定義jar文件的簽名版本
Class-Path：應(yīng)用程序或者類裝載器使用該值來構(gòu)建內(nèi)部的類搜索路徑，可執(zhí)行jar包里需要設(shè)置這個(gè)。

上面是普通jar包的屬性，可運(yùn)行jar包的.MF文件中，還會(huì)有mian-class或start-class等屬性。如果依賴了外部jar包，還會(huì)在MF文件中配置lib路徑等信息。更多信息參見：maven為MANIFEST.MF文件添加內(nèi)容的方法

至于可運(yùn)行jar包和普通jar包的目錄結(jié)構(gòu)，沒有什么特別固定的模式，總之，無論是什么結(jié)構(gòu)，在.MF文件中，配置好jar包的信息，即可正常使用jar包了。

FatJar有什么不同

什么是FatJar？

普通的jar只包含當(dāng)前 jar的信息，不含有第三方 jar。當(dāng)內(nèi)部依賴第三方j(luò)ar時(shí)，直接運(yùn)行則會(huì)報(bào)錯(cuò)，這時(shí)候需要將第三方j(luò)ar內(nèi)嵌到可執(zhí)行jar里。將一個(gè)jar及其依賴的三方j(luò)ar全部打到一個(gè)包中，這個(gè)包即為 FatJar。

SpringBoot FatJar解決方案

Spring Boot為了解決內(nèi)嵌jar問題，提供了一套FatJar解決方案，分別定義了jar目錄結(jié)構(gòu)和 MANIFEST.MF。在編譯生成可執(zhí)行 jar 的基礎(chǔ)上，使用spring-boot-maven-plugin按Spring Boot 的可執(zhí)行包標(biāo)準(zhǔn)repackage，得到可執(zhí)行的Spring Boot jar。根據(jù)可執(zhí)行jar類型，分為兩種：可執(zhí)行Jar和可執(zhí)行war。

spring-boot-maven-plugin打包過程

因?yàn)樵谛陆ǖ目盏?SpringBoot 工程中并沒有任何地方顯示的引入或者編寫相關(guān)的類。實(shí)際上，對(duì)于每個(gè)新建的 SpringBoot 工程，可以在其 pom.xml 文件中看到如下插件：

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

這個(gè)是SpringBoot官方提供的用于打包FatJar的插件，org.springframework.boot.loader下的類其實(shí)就是通過這個(gè)插件打進(jìn)去的；

下面是此插件將 loader 相關(guān)類打入 FatJar 的一個(gè)執(zhí)行流程：

org.springframework.boot.maven#execute->
org.springframework.boot.maven#repackage -> org.springframework.boot.loader.tools.Repackager#repackage->
org.springframework.boot.loader.tools.Repackager#writeLoaderClasses->
org.springframework.boot.loader.tools.JarWriter#writeLoaderClasses

最終的執(zhí)行方法就是下面這個(gè)方法，通過注釋可以看出，該方法的作用就是將 spring-boot-loader 的classes 寫入到 FatJar 中。

/**
 * Write the required spring-boot-loader classes to the JAR.
 * @throws IOException if the classes cannot be written
 */
@Override
public void writeLoaderClasses() throws IOException {
	writeLoaderClasses(NESTED_LOADER_JAR);
}

打包結(jié)果

Spring Boot項(xiàng)目被編譯以后，在targert目錄下存在兩個(gè)jar文件：一個(gè)是xxx.jar和xxx.jar.original。

其中xxx.jar.original是maven編譯后的原始jar文件，即標(biāo)準(zhǔn)的java jar。該文件僅包含應(yīng)用本地資源。如果單純使用這個(gè)jar，無法正常運(yùn)行，因?yàn)槿鄙僖蕾嚨牡谌劫Y源。
因此spring-boot-maven-plugin插件對(duì)這個(gè)xxx.jar.original再做一層加工，引入第三方依賴的jar包等資源，將其 "repackage" 為xxx.jar。可執(zhí)行Jar的文件結(jié)構(gòu)如下圖所示：

.
├── BOOT-INF
│   ├── classes
│   │   ├── application.properties  # 用戶-配置文件
│   │   └── com
│   │       └── glmapper
│   │           └── bridge
│   │               └── boot
│   │                   └── BootStrap.class  # 用戶-啟動(dòng)類
│   └── lib
│       ├── jakarta.annotation-api-1.3.5.jar
│       ├── jul-to-slf4j-1.7.28.jar
│       ├── log4j-xxx.jar # 表示 log4j 相關(guān)的依賴簡寫
├── META-INF
│   ├── MANIFEST.MF
│   └── maven
│       └── com.glmapper.bridge.boot
│           └── guides-for-jarlaunch
│               ├── pom.properties
│               └── pom.xml
└── org
    └── springframework
        └── boot
            └── loader
                ├── ExecutableArchiveLauncher.class
                ├── JarLauncher.class
                ├── LaunchedURLClassLoader$UseFastConnectionExceptionsEnumeration.class
                ├── LaunchedURLClassLoader.class
                ├── Launcher.class
                ├── MainMethodRunner.class
                ├── PropertiesLauncher$1.class
                ├── PropertiesLauncher$ArchiveEntryFilter.class
                ├── PropertiesLauncher$PrefixMatchingArchiveFilter.class
                ├── PropertiesLauncher.class
                ├── WarLauncher.class
                ├── archive
                │   ├── # 省略
                ├── data
                │   ├── # 省略
                ├── jar
                │   ├── # 省略
                └── util
                    └── SystemPropertyUtils.class

META-INF: 存放元數(shù)據(jù)。MANIFEST.MF 是 jar 規(guī)范，Spring Boot 為了便于加載第三方 jar 對(duì)內(nèi)容做了修改；
org: 存放Spring Boot 相關(guān)類，比如啟動(dòng)時(shí)所需的 Launcher 等；
BOOT-INF/class： 存放應(yīng)用編譯后的 class 文件；
BOOT-INF/lib： 存放應(yīng)用依賴的 JAR 包。

Spring Boot的MANIFEST.MF和普通jar有些不同：

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

Main-Class： 是java -jar啟動(dòng)引導(dǎo)類，但這里不是項(xiàng)目中的類，而是Spring Boot內(nèi)部的JarLauncher。
Start-Class： 這個(gè)才是正在要執(zhí)行的應(yīng)用內(nèi)部主類

所以java -jar啟動(dòng)的時(shí)候，加載運(yùn)行的是JarLauncher。Spring Boot內(nèi)部如何通過JarLauncher 加載Start-Class 執(zhí)行呢？為了更清楚加載流程，我們先介紹下java -jar是如何完成類加載邏輯的。

啟動(dòng)時(shí)的類加載原理

這里簡單說下java -jar啟動(dòng)時(shí)是如何完成記載類加載的。Java 采用了雙親委派機(jī)制，Java語言系統(tǒng)自帶有三個(gè)類加載器：

Bootstrap CLassloder： 最頂層的加載類，主要加載核心類庫
Extention ClassLoader： 擴(kuò)展的類加載器，加載目錄%JRE_HOME%/lib/ext目錄下的jar包和class文件。還可以加載-D java.ext.dirs選項(xiàng)指定的目錄。
AppClassLoader: 是應(yīng)用加載器。

默認(rèn)情況下通過java -classpath，java -cp，java -jar使用的類加載器都是AppClassLoader。普通可執(zhí)行jar通過java -jar啟動(dòng)后，使用AppClassLoader加載Main-class類。如果第三方j(luò)ar不在AppClassLoader里，會(huì)導(dǎo)致啟動(dòng)時(shí)候會(huì)報(bào)ClassNotFoundException。

例如在Spring Boot可執(zhí)行jar的解壓目錄下，執(zhí)行應(yīng)用的主函數(shù)，就直接報(bào)該錯(cuò)誤：

Exception in thread "main" java.lang.NoClassDefFoundError: org/springframework/boot/SpringApplication
at com.glmapper.bridge.boot.BootStrap.main(BootStrap.java:13)
Caused by: java.lang.ClassNotFoundException: org.springframework.boot.SpringApplication
at java.net.URLClassLoader.findClass(URLClassLoader.java:381)
at java.lang.ClassLoader.loadClass(ClassLoader.java:424)
at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:338)
at java.lang.ClassLoader.loadClass(ClassLoader.java:357)
... 1 more

從異常堆棧來看，是因?yàn)檎也坏?code>SpringApplication這個(gè)類；這里其實(shí)還是比較好理解的，BootStrap類中引入了SpringApplication，但是這個(gè)類是在BOOT-INF/lib下的，而java指令在啟動(dòng)時(shí)未指明classpath，依賴的第三方j(luò)ar無法被加載。

Spring Boot JarLauncher啟動(dòng)時(shí)，會(huì)將所有依賴的內(nèi)嵌 jar (BOOT-INF/lib 目錄下) 和class（BOOT-INF/classes 目錄）都加入到自定義的類加載器LaunchedURLClassLoader中，并用這個(gè)ClassLoder去加載MANIFEST.MF配置Start-Class，則不會(huì)出現(xiàn)類找不到的錯(cuò)誤。

LaunchedURLClassLoader是URLClassLoader的子類， URLClassLoader會(huì)通過URL[] 來搜索類所在的位置。Spring Boot 則將所需要的內(nèi)嵌文檔組裝成URL[]，最終構(gòu)建LaunchedURLClassLoader類。

啟動(dòng)的整個(gè)流程

有了以上知識(shí)的鋪墊，我們看下整個(gè) FatJar 啟動(dòng)的過程會(huì)是怎樣。為了以便查看源碼和遠(yuǎn)程調(diào)試，可以在 pom.xml 引入下面的配置：

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

簡單概括起來可以分為幾步：

java -jar 啟動(dòng)，AppClassLoader 則會(huì)加載 MANIFEST.MF 配置的Main-Class, JarLauncher。
JarLauncher啟動(dòng)時(shí)，注冊(cè)URL關(guān)聯(lián)協(xié)議。
獲取所有內(nèi)嵌的存檔(內(nèi)嵌jar和class)
根據(jù)存檔的URL[]構(gòu)建類加載器。
然后用這個(gè)類加載器加載Start-Class。保證這些類都在同一個(gè)ClassLoader中。