1. Maven生命周期

Maven的生命周期有三種：

1. clean：清除項(xiàng)目構(gòu)建數(shù)據(jù)，較為簡(jiǎn)單，不深入探討；
2. site：建立和部署項(xiàng)目站點(diǎn)，使用的較少，也不深入探討；
3. default：定義了項(xiàng)目構(gòu)建時(shí)所需要的所有步驟，是Maven生命周期中最核心最重要的的部分。

本次要深入了解的便是default流程。其生命周期如下：

其中可以在Maven常見(jiàn)的Lifecycle中直接執(zhí)行的有validate、compile、test、package、verify和deploy七種，一般在Maven的plugin標(biāo)簽中，可以通過(guò)配置如下配置來(lái)指定插件在某個(gè)階段生效，需要注意的是不可隨意配置，每個(gè)插件可處理的階段都是不同的。（不配置則執(zhí)行插件默認(rèn)的）

<executions>
    <execution>
        <phase>XX</phase>
        <goals>
            <goal>XXXX</goal>
        </goals>
    </execution>
</executions>

今天要深入了解的spring-boot-maven-plugin插件就是在package階段中生效的。

2. jar包結(jié)構(gòu)

通常而言，jar包分為可執(zhí)行jar包和不可執(zhí)行jar包，顧名思義，可執(zhí)行jar包即可通過(guò)命令java -jar直接執(zhí)行，不可執(zhí)行jar包通過(guò)命令java -jar執(zhí)行則會(huì)報(bào)錯(cuò)。

2.1 不可執(zhí)jar包結(jié)構(gòu)

|-- _jar包根目錄
    |-- 原項(xiàng)目class文件和resource文件
    |-- _META-INF
        |-- MANIFEST.MF
        |-- _maven
            |-- _項(xiàng)目目錄
                |-- pom.properties
                |-- pom.xml

上面是經(jīng)典的不可執(zhí)行jar包目錄，其中MANIFEST.MF文件內(nèi)容如下：

Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Built-By: xxxxx
Created-By: Apache Maven 3.5.0
Build-Jdk: 1.8.0_151

這五項(xiàng)是最基本的，如果使用java -jar執(zhí)行這些jar包，將會(huì)拋出錯(cuò)誤碼java.launcher.jar.error3，意為沒(méi)找到Main-Class屬性。不同語(yǔ)言展示的最終描述不同，由launcher+對(duì)應(yīng)語(yǔ)言類(lèi)轉(zhuǎn)換，簡(jiǎn)體中文在launcher_zh_CN類(lèi)中轉(zhuǎn)換，{0}為jar包名稱，內(nèi)容如下：

{0}中沒(méi)有主清單屬性

英文在launcher類(lèi)中轉(zhuǎn)換，{0}為jar包名稱，內(nèi)容如下：

no main manifest attribute, in {0}

2.2 可執(zhí)行jar包結(jié)構(gòu)

可執(zhí)行jar包結(jié)構(gòu)挑選經(jīng)典的springboot啟動(dòng)包來(lái)做示范：

|-- _jar包根目錄
    |-- _BOOT-INF
        |-- _classes
            |-- 原項(xiàng)目class文件和resource文件
        |-- _lib
            |--原項(xiàng)目依賴的jar庫(kù)文件
    |-- _META-INF
        |-- MANIFEST.MF
        |-- spring-configuration-metadata.json（springboot項(xiàng)目特有）
        |-- build-info.properties
        |-- _maven
            |-- _項(xiàng)目目錄
                |-- pom.properties
                |-- pom.xml

上一節(jié)我們得知了如果在MANIFEST.MF中沒(méi)有Main-Class屬性，使用java -jar命令執(zhí)行jar包會(huì)報(bào)錯(cuò)，接下來(lái)看看在可執(zhí)行jar包的結(jié)構(gòu)，MANIFEST.MF中具體有什么屬性：

Manifest-Version: 1.0
Spring-Boot-Classpath-Index: BOOT-INF/classpath.idx
Implementation-Title: XXXX
Implementation-Version: 1.0-SNAPSHOT
Spring-Boot-Layers-Index: BOOT-INF/layers.idx
Spring-Boot-Classes: BOOT-INF/classes/
Spring-Boot-Lib: BOOT-INF/lib/
Build-Jdk-Spec: 1.8
Spring-Boot-Version: 2.1.6.RELEASE
Created-By: Maven Archiver 3.4.0
Start-Class: XXX.XXX.XXX.XXXX
Main-Class: org.springframework.boot.loader.JarLauncher

里面有兩個(gè)很重要的屬性：Start-Class和Main-Class，其中Start-Class指的是項(xiàng)目中springboot的SpringApplication啟動(dòng)類(lèi)，而Main-Class則是jar包的啟動(dòng)類(lèi)入口。

3. spring-boot-maven-plugin插件打包

springboot打包插件執(zhí)行原理：

1. 讀取原jar包：Maven插件都能讀MavenProject對(duì)象內(nèi)容，從中可以讀取到Artifact信息，調(diào)用該對(duì)象的getFile()方法即可獲取原jar包文件對(duì)象；
2. 讀取項(xiàng)目依賴jar庫(kù)：直接使用MavenProject對(duì)象的getArtifacts()方法即可獲取依賴的jar庫(kù)；
3. 加載launchScript：讀取embeddedLaunchScript配置，并構(gòu)建LaunchScript對(duì)象；
4. 重新改寫(xiě)MANIFEST.MF：到此步驟開(kāi)始為repackage的核心流程，改寫(xiě)清單文件時(shí)最主要的便是寫(xiě)入Start-Class和Main-Class屬性，除此之外還會(huì)寫(xiě)入jar庫(kù)和原項(xiàng)目文件目錄屬性；
5. 寫(xiě)入spring-boot-loader包文件：該包是springboot對(duì)接java -jar執(zhí)行命令的核心處理邏輯，springboot打包后加入的Main-Class: org.springframework.boot.loader.JarLauncher屬性指向的類(lèi)便是此包中的jar包啟動(dòng)類(lèi)，如果war包則會(huì)寫(xiě)入war包啟動(dòng)類(lèi)；
6. 寫(xiě)入原項(xiàng)目文件：原項(xiàng)目文件會(huì)被挪到BOOT-INF/classes/目錄下；
7. 寫(xiě)入項(xiàng)目依賴jar庫(kù)：原項(xiàng)目依賴的jar庫(kù)會(huì)被寫(xiě)入到BOOT-INF/lib/目錄下。

如果要看spring-boot-maven-plugin插件打包源碼以分析原理，可導(dǎo)入插件的依賴，此時(shí)就能看到該插件的源碼。

如果使用的是IDEA，下載源碼后打上斷點(diǎn)，在執(zhí)行package時(shí)，使用debug模式啟動(dòng)也能直接進(jìn)行調(diào)試。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <version>XXXXX</version>
</dependency>

4. 執(zhí)行jar原理

將會(huì)分析執(zhí)行java -jar命令后，Java程序調(diào)用到Springboot啟動(dòng)類(lèi)main方法的流程。

1. JVM啟動(dòng)，執(zhí)行加載主函數(shù)LoadMainClass：此時(shí)是在JVM底層實(shí)現(xiàn)的，里面指定了LauncherHelper類(lèi)；
2. 執(zhí)行LauncherHelper的checkAndLoadMain方法：JVM將會(huì)調(diào)用LauncherHelper的checkAndLoadMain方法，解析并校驗(yàn)jar包，并獲取主要的啟動(dòng)類(lèi)；
3. 解析jar的MANIFEST.MF文件：在此方法中會(huì)完成讀取MANIFEST.MF文件，主要是讀取其中的Main-Class屬性，并做jar包啟動(dòng)的校驗(yàn)；
4. GetStaticMethodID方法：JVM獲取到Main-Class類(lèi)對(duì)象，調(diào)用Main-Class類(lèi)對(duì)象的main方法；
5. 執(zhí)行JarLauncher的main方法：JarLauncher繼承自Launcher，main方法最后還是會(huì)調(diào)用到Launcher.launch()方法中；
6. 讀取jar的Start-Class：此時(shí)會(huì)讀取jar包的Start-Class屬性，該屬性就是原項(xiàng)目的SpringApplication啟動(dòng)類(lèi)；
7. 調(diào)用啟動(dòng)類(lèi)的main方法：調(diào)用MainMethodRunner的run方法，里面會(huì)調(diào)用Start-Class類(lèi)的main方法
8. 此時(shí)調(diào)入到自定義的啟動(dòng)類(lèi)中，完成啟動(dòng)Springboot程序的入口程序。

總結(jié)

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論