Springboot - Fat Jar範例詳解

2023-02-03 18:00:37

導讀

Spring Boot應用可以使用spring-boot-maven-plugin快速打包，構建一個可執行jar。Spring Boot內嵌容器，通過java -jar命令便可以直接啟動應用。

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

JAR 是什麼。首先需要了解jar是什麼，才知道java -jar做了什麼事情。
FatJar 有什麼不同。 Spring Boot提供的可執行jar與普通的jar有什麼區別。
啟動時的類載入原理。啟動過程中類載入器做了什麼？Spring Boot又如何通過自定義類載入器解決內嵌包的載入問題。
啟動的整個流程。最後整合前面三部分的內容，解析原始碼看如何完成啟動。

JAR 是什麼

JAR簡介

JAR檔案（Java歸檔，英語: Java ARchive）是一種軟體包檔案格式，通常用於將大量的Java類檔案、相關的後設資料和資源（文字、圖片等）檔案聚合到一個檔案，以便分發Java平臺應用軟體或庫。簡單點理解其實就是一個壓縮包，既然是壓縮包那麼為了提取JAR檔案的內容，可以使用任何標準的unzip解壓縮軟體提取內容。或者使用Java虛擬機器器自帶命令jar -xf foo.jar來解壓相應的jar檔案。

JAR 可以簡單分為兩類：

非可執行JAR。打包時，不用指定main-class，也不可執行。普通jar包可以供其它專案進行依賴。
可執行JAR。打jar包時，指定了main-class類，可以通過java -jar xxx.jar命令，執行main-class的main方法，執行jar包。可執行jar包不可被其他專案進行依賴。

JAR結構

包結構

不管是非可行JAR還是可執行JAR解壓後都包含兩部分：META-INF目錄(後設資料)和package目錄(編譯後的class)。這種普通的jar不包含第三方依賴包，只包含應用自身的組態檔、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：應用程式或者類裝載器使用該值來構建內部的類搜尋路徑，可執行jar包裡需要設定這個。

上面是普通jar包的屬性，可執行jar包的.MF檔案中，還會有mian-class或start-class等屬性。如果依賴了外部jar包，還會在MF檔案中設定lib路徑等資訊。更多資訊參見：maven為MANIFEST.MF檔案新增內容的方法

至於可執行jar包和普通jar包的目錄結構，沒有什麼特別固定的模式，總之，無論是什麼結構，在.MF檔案中，設定好jar包的資訊，即可正常使用jar包了。

FatJar有什麼不同

什麼是FatJar？

普通的jar只包含當前 jar的資訊，不含有第三方 jar。當內部依賴第三方jar時，直接執行則會報錯，這時候需要將第三方jar內嵌到可執行jar裡。將一個jar及其依賴的三方jar全部打到一個包中，這個包即為 FatJar。

SpringBoot FatJar解決方案

Spring Boot為了解決內嵌jar問題，提供了一套FatJar解決方案，分別定義了jar目錄結構和 MANIFEST.MF。在編譯生成可執行 jar 的基礎上，使用spring-boot-maven-plugin按Spring Boot 的可執行包標準repackage，得到可執行的Spring Boot jar。根據可執行jar型別，分為兩種：可執行Jar和可執行war。

spring-boot-maven-plugin打包過程

因為在新建的空的 SpringBoot 工程中並沒有任何地方顯示的引入或者編寫相關的類。實際上，對於每個新建的 SpringBoot 工程，可以在其 pom.xml 檔案中看到如下外掛：

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

這個是SpringBoot官方提供的用於打包FatJar的外掛，org.springframework.boot.loader下的類其實就是通過這個外掛打進去的；

下面是此外掛將 loader 相關類打入 FatJar 的一個執行流程：

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

最終的執行方法就是下面這個方法，通過註釋可以看出，該方法的作用就是將 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);
}

打包結果

Spring Boot專案被編譯以後，在targert目錄下存在兩個jar檔案：一個是xxx.jar和xxx.jar.original。

其中xxx.jar.original是maven編譯後的原始jar檔案，即標準的java jar。該檔案僅包含應用本地資源。如果單純使用這個jar，無法正常執行，因為缺少依賴的第三方資源。
因此spring-boot-maven-plugin外掛對這個xxx.jar.original再做一層加工，引入第三方依賴的jar包等資源，將其 "repackage" 為xxx.jar。可執行Jar的檔案結構如下圖所示：

.
├── BOOT-INF
│   ├── classes
│   │   ├── application.properties  # 使用者-組態檔
│   │   └── com
│   │       └── glmapper
│   │           └── bridge
│   │               └── boot
│   │                   └── BootStrap.class  # 使用者-啟動類
│   └── lib
│       ├── jakarta.annotation-api-1.3.5.jar
│       ├── jul-to-slf4j-1.7.28.jar
│       ├── log4j-xxx.jar # 表示 log4j 相關的依賴簡寫
├── 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: 存放後設資料。MANIFEST.MF 是 jar 規範，Spring Boot 為了便於載入第三方 jar 對內容做了修改；
org: 存放Spring Boot 相關類，比如啟動時所需的 Launcher 等；
BOOT-INF/class： 存放應用編譯後的 class 檔案；
BOOT-INF/lib： 存放應用依賴的 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啟動引導類，但這裡不是專案中的類，而是Spring Boot內部的JarLauncher。
Start-Class： 這個才是正在要執行的應用內部主類

所以java -jar啟動的時候，載入執行的是JarLauncher。Spring Boot內部如何通過JarLauncher 載入Start-Class 執行呢？為了更清楚載入流程，我們先介紹下java -jar是如何完成類載入邏輯的。

啟動時的類載入原理

這裡簡單說下java -jar啟動時是如何完成記載類載入的。Java 採用了雙親委派機制，Java語言系統自帶有三個類載入器：

Bootstrap CLassloder： 最頂層的載入類，主要載入核心類庫
Extention ClassLoader： 擴充套件的類載入器，載入目錄%JRE_HOME%/lib/ext目錄下的jar包和class檔案。還可以載入-D java.ext.dirs選項指定的目錄。
AppClassLoader: 是應用載入器。

預設情況下通過java -classpath，java -cp，java -jar使用的類載入器都是AppClassLoader。普通可執行jar通過java -jar啟動後，使用AppClassLoader載入Main-class類。如果第三方jar不在AppClassLoader裡，會導致啟動時候會報ClassNotFoundException。

例如在Spring Boot可執行jar的解壓目錄下，執行應用的主函數，就直接報該錯誤：

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

從異常堆疊來看，是因為找不到SpringApplication這個類；這裡其實還是比較好理解的，BootStrap類中引入了SpringApplication，但是這個類是在BOOT-INF/lib下的，而java指令在啟動時未指明classpath，依賴的第三方jar無法被載入。

Spring Boot JarLauncher啟動時，會將所有依賴的內嵌 jar (BOOT-INF/lib 目錄下) 和class（BOOT-INF/classes 目錄）都加入到自定義的類載入器LaunchedURLClassLoader中，並用這個ClassLoder去載入MANIFEST.MF設定Start-Class，則不會出現類找不到的錯誤。

LaunchedURLClassLoader是URLClassLoader的子類， URLClassLoader會通過URL[] 來搜尋類所在的位置。Spring Boot 則將所需要的內嵌檔案組裝成URL[]，最終構建LaunchedURLClassLoader類。

啟動的整個流程

有了以上知識的鋪墊，我們看下整個 FatJar 啟動的過程會是怎樣。為了以便檢視原始碼和遠端偵錯，可以在 pom.xml 引入下面的設定：

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

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

java -jar 啟動，AppClassLoader 則會載入 MANIFEST.MF 設定的Main-Class, JarLauncher。
JarLauncher啟動時，註冊URL關聯協定。
獲取所有內嵌的存檔(內嵌jar和class)
根據存檔的URL[]構建類載入器。
然後用這個類載入器載入Start-Class。保證這些類都在同一個ClassLoader中。

參考資料

聊一聊 SpringBoot 中 FatJar 啟動原理
 Spring Boot 解析（二）：FatJar 啟動原理
 Springboot - Fat Jar

到此這篇關於Springboot - Fat Jar詳解的文章就介紹到這了,更多相關Springboot Fat Jar內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！