SpringBoot的java -jar命令啟動原理解讀

更新時間：2024年02月26日 11:03:40 作者：寒山道杳

這篇文章主要介紹了SpringBoot的java -jar命令啟動原理,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

導(dǎo)語

在運用Spring Boot 后，我們基本上擺脫之前項目每次上線的時候把項目打成war包。

當(dāng)然也不排除一些奇葩的規(guī)定，必須要用war包上線，不過很多時候，我們對一些東西只是處在使用的階段，并不會去深入的研究使用的原理是什么，這貌似也是大多數(shù)人的固定思維。

或許正是如此，總會有些沒有固定思維的人會去積極的探索原理，當(dāng)然這話不是說我是積極的，我其實也是只原理的搬運工。

今天和大家來簡單的說下Spring Boot 的項目在運行Java -jar的原理。

jar包目錄和jar命令啟動入口

在正式開始之前，我們先來看看把jar包進行解壓。

然后用tree /f命令查看目錄結(jié)構(gòu)（由于筆者寫博文時用的是window，所以用的是tree /f命令），由于目錄結(jié)構(gòu)太長，這里做了相應(yīng)省略，如下：

├─BOOT-INF
│  ├─classes
│  │  │  application.properties
│  │  │
│  │  └─com
│  │      └─spring
│  │          └─boot
│  │              └─test
│  │                      SpringBootTestApplication.class
│  │
│  └─lib
│          classmate-1.5.1.jar
│          hibernate-validator-6.0.18.Final.jar
│          …………此處省略…………
│
├─META-INF
│  │  MANIFEST.MF
│  │
│  └─maven
│      └─com.spring.boot.test
│          └─spring-boot-test
│                  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
                │      Archive$Entry.class
                │      …………此處省略…………
                │
                ├─data
                │      RandomAccessData.class
                │      …………此處省略…………
                │
                ├─jar
                │      AsciiBytes.class
                │      Bytes.class
                │      …………此處省略…………
                │
                └─util
                        SystemPropertyUtils.class

先簡單說下上面目錄結(jié)構(gòu)，大體目錄分三層：BOOT-INF、META-INF、org，BOOT-INF是存放對應(yīng)的應(yīng)用服務(wù)的.class文件和Maven依賴的jar包，包括啟動類SpringBootTestApplication，META-INF下存放的是Maven相關(guān)的pom信息和MANIFEST.MF文件，org文件夾下存放的是Spring boot loader模塊編譯的.class文件，也就是jar啟動的關(guān)鍵代碼所在。

在執(zhí)行java -jar命令的時候，它的啟動類配置實在jar包目錄下META-INF文件夾下的名MANIFEST.MF文件中，在這個文件中有一個名為Main-Class的屬性，我們來看下這個文件的具體內(nèi)容：

Manifest-Version: 1.0
Implementation-Title: spring-boot-test
Implementation-Version: 0.0.1-SNAPSHOT
Start-Class: com.spring.boot.test.SpringBootTestApplication
Spring-Boot-Classes: BOOT-INF/classes/
Spring-Boot-Lib: BOOT-INF/lib/
Build-Jdk-Spec: 1.8
Spring-Boot-Version: 2.2.3.RELEASE
Created-By: Maven Archiver 3.4.0
Main-Class: org.springframework.boot.loader.JarLauncher

從上面的配置文件中，可以看到Main-Class屬性指向的Class為org.springframework.boot.loader.JarLauncher，而JarLauncher是JAR的啟動器，這個類是在org/springframework/boot/loader/,然后可以看到項目所定義的啟動類是指向Start-Class這個屬性的。

JAR文件啟動器——JarLauncher

在上面我們說了JarLauncher是JAR可執(zhí)行的啟動器，那么它和項目的啟動類SpringBootTestApplication有什么關(guān)聯(lián)呢？

先給大家來個示例，先來到解壓目錄下執(zhí)行命令：java org.springframework.boot.loader.JarLauncher ，然后便是如下界面：

C:\Users\elisha\Desktop\spring-boot-test-0.0.1-SNAPSHOT>java org.springframework.boot.loader.JarLauncher
 
  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v2.2.3.RELEASE)
2020-01-18 14:28:19.866  INFO 3644 --- [           main] c.s.boot.test.SpringBootTestApplication  : Starting SpringBootTestApplication on LAPTOP-R2NNI9CM with PID 3644 (C:\Users\elisha\Desktop\spring-boot-test-0.0.1-SNAPSHOT\BOOT-INF\classes started by elisha in C:\Users\elisha\Desktop\spring-boot-test-0.0.1-SNAPSHOT)

從上面的執(zhí)行接口可以看到項目引導(dǎo)類SpringBootTestApplication會被JarLauncher類進行引導(dǎo)，但是如果我們到BOOT-INF/class目錄下，然后也執(zhí)行java com.spring.boot.test.SpringBootTestApplication,會報SpringApplication的ClassNotFoundException這個錯誤，由此可以得知這是因為java命令未指定Class Path。

不過當(dāng)前Spring Boot依賴的JAR文件都是存放在BOOT-INF/lib下，而org.springframework.boot.loader.JarLauncher會將JAR作為SpringBootTestApplication類庫的依賴，這也就是為什么JarLauncher能引導(dǎo)SpringBootTestApplication，反之則是不可以的，那么對于SpringBootTestApplication是JarLauncher的子進程，還是處于同一層級呢？

接下來我們來看看JarLauncher的原理。

JarLauncher實現(xiàn)引導(dǎo)原理

因為org.springframework.boot.loader.JarLauncher的類是在spring-boot-loader中，但是若想在IDEA中來看源碼，需要在pom文件中引入如下配置：

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

在引入上面的配置文件后，便可以在IDEA中查看源碼了，使用CTRL+N命令來搜索JarLauncher類，那就來看下源碼，如下：

public class JarLauncher extends ExecutableArchiveLauncher {
 
	static final String BOOT_INF_CLASSES = "BOOT-INF/classes/";
 
	static final String BOOT_INF_LIB = "BOOT-INF/lib/";
 
	public JarLauncher() {
	}
 
	protected JarLauncher(Archive archive) {
		super(archive);
	}
 
	@Override
	protected boolean isNestedArchive(Archive.Entry entry) {
		if (entry.isDirectory()) {
			return entry.getName().equals(BOOT_INF_CLASSES);
		}
		return entry.getName().startsWith(BOOT_INF_LIB);
	}
 
	public static void main(String[] args) throws Exception {
		new JarLauncher().launch(args);
	}
 
}

從上面的JarLauncher類中，可以看到兩個常量：BOOT_INF_CLASSES、BOOT_INF_LIB，而它們又分別指向如下路徑：BOOT-INF/classes/、BOOT-INF/lib/，并用isNestedArchive(Archive.Entry entry)方法進行判斷（在Spring Boot中Archive，抽象出了Archive的概念，一個Archive可以是一個Jar（JarFileArchive）、也可以是一個目錄（ExplodedArchive），在這里可以理解為Spring Boot抽象出來的同一訪問資源層。），從isNestedArchive方法的參數(shù)Archive.Entry對象貌似為一個JAR文件中的資源，譬如application.properties，同時這個對象和JarEntry是類似的，其name屬性（Archive.Entry#getName()）便是Jar資源的相對路徑。當(dāng)application.properties資源在FAT JAR目錄下時，其實Archive.Entry#getName()就是/BOOT-INF/classes/application.properties,此時便符合startsWith方法的判斷，所以isNestedArchive(Archive.Entry entry)便返回為true。

當(dāng)返回為false時，便說明FAT JAR被解壓到文件目錄了，由此也說明了Spring Boot應(yīng)用可以通過java org.springframework.boot.loader.JarLauncher 命令啟動的原因了。

Archive.Entry的實現(xiàn)

上面說了在Spring Boot中Archive，抽象出了Archive的概念，一個Archive可以是一個Jar（JarFileArchive）、也可以是一個目錄（ExplodedArchive），這里所說的JarFileArchive、ExplodedArchive便是Archive的兩種是想方式，對于這兩個類的實現(xiàn)代碼感興趣額同學(xué)可以自己去看看。

不過由此也說明了JarLauncher 既支持JAR啟動，又支持文件系統(tǒng)啟動。

同時JarLauncher 在作為引導(dǎo)類的時候，當(dāng)執(zhí)行java -jar 命令式，/META-INF/ 下MANIFEST.MF文件中的Main-Class屬性將調(diào)用它的,main(String [])方法，其實它還是調(diào)用JarLauncher #launch(args)方法，這個方法是實現(xiàn)基類Launcher，這里簡單看下這個方法的實現(xiàn)：

protected void launch(String[] args) throws Exception {
	JarFile.registerUrlProtocolHandler();
	ClassLoader classLoader = createClassLoader(getClassPathArchives());
	launch(args, getMainClass(), classLoader);
}

總結(jié)

本篇文章簡單的講解了一下，java -jar命令的一個執(zhí)行的原理，首先說了下jar包目錄和jar命令啟動入口，然后說了下JAR文件啟動器——JarLauncher和JarLauncher實現(xiàn)引導(dǎo)原理，最后說了下Archive.Entry的實現(xiàn)，這個實現(xiàn)的原理也是比較復(fù)雜，后面如果有機會，會再寫篇文章來進行說明。

這些僅為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: