SpringBoot為何可以使用Jar包啟動(dòng)詳解
引言
很多初學(xué)者會(huì)比較困惑,Spring Boot 是如何做到將應(yīng)用代碼和所有的依賴打包成一個(gè)獨(dú)立的 Jar 包,因?yàn)閭鹘y(tǒng)的 Java 項(xiàng)目打包成 Jar 包之后,需要通過 -classpath 屬性來指定依賴,才能夠運(yùn)行。我們今天就來分析講解一下 SpringBoot 的啟動(dòng)原理。
Spring Boot 打包插件
Spring Boot 提供了一個(gè)名叫 spring-boot-maven-plugin 的 maven 項(xiàng)目打包插件,如下:
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>可以方便的將 Spring Boot 項(xiàng)目打成 jar 包。 這樣我們就不再需要部署 Tomcat 、Jetty等之類的 Web 服務(wù)器容器啦。
我們先看一下 Spring Boot 打包后的結(jié)構(gòu)是什么樣的,打開 target 目錄我們發(fā)現(xiàn)有兩個(gè)jar包:

其中,springboot-0.0.1-SNAPSHOT.jar 是通過 Spring Boot 提供的打包插件采用新的格式打成 Fat Jar,包含了所有的依賴;
而 springboot-0.0.1-SNAPSHOT.jar.original 則是Java原生的打包方式生成的,僅僅只包含了項(xiàng)目本身的內(nèi)容。
SpringBoot FatJar 的組織結(jié)構(gòu)
我們將 Spring Boot 打的可執(zhí)行 Jar 展開后的結(jié)構(gòu)如下所示:

- BOOT-INF目錄:包含了我們的項(xiàng)目代碼(classes目錄),以及所需要的依賴(lib 目錄);
- META-INF目錄:通過
MANIFEST.MF文件提供 Jar包的元數(shù)據(jù),聲明了 jar 的啟動(dòng)類; org.springframework.boot.loader:Spring Boot 的加載器代碼,實(shí)現(xiàn)的 Jar in Jar 加載的魔法源。
我們看到,如果去掉BOOT-INF目錄,這將是一個(gè)非常普通且標(biāo)準(zhǔn)的Jar包,包括元信息以及可執(zhí)行的代碼部分,其/META-INF/MAINFEST.MF指定了Jar包的啟動(dòng)元信息,org.springframework.boot.loader 執(zhí)行對應(yīng)的邏輯操作。
MAINFEST.MF 元信息
元信息內(nèi)容如下所示:
Manifest-Version: 1.0 Spring-Boot-Classpath-Index: BOOT-INF/classpath.idx Implementation-Title: springboot Implementation-Version: 0.0.1-SNAPSHOT Spring-Boot-Layers-Index: BOOT-INF/layers.idx Start-Class: com.listenvision.SpringbootApplication Spring-Boot-Classes: BOOT-INF/classes/ Spring-Boot-Lib: BOOT-INF/lib/ Build-Jdk-Spec: 1.8 Spring-Boot-Version: 2.5.6 Created-By: Maven Jar Plugin 3.2.0 Main-Class: org.springframework.boot.loader.JarLauncher
它相當(dāng)于一個(gè) Properties 配置文件,每一行都是一個(gè)配置項(xiàng)目。重點(diǎn)來看看兩個(gè)配置項(xiàng):
- Main-Class 配置項(xiàng):Java 規(guī)定的 jar 包的啟動(dòng)類,這里設(shè)置為 spring-boot-loader 項(xiàng)目的 JarLauncher 類,進(jìn)行 Spring Boot 應(yīng)用的啟動(dòng)。
- Start-Class 配置項(xiàng):Spring Boot 規(guī)定的主啟動(dòng)類,這里設(shè)置為我們定義的 Application 類。
- Spring-Boot-Classes 配置項(xiàng):指定加載應(yīng)用類的入口。
- Spring-Boot-Lib 配置項(xiàng): 指定加載應(yīng)用依賴的庫。
啟動(dòng)原理
Spring Boot 的啟動(dòng)原理如下圖所示:

源碼分析
JarLauncher
JarLauncher 類是針對 Spring Boot jar 包的啟動(dòng)類, 完整的類圖如下所示:

其中的 WarLauncher 類,是針對 Spring Boot war 包的啟動(dòng)類。 啟動(dòng)類 org.springframework.boot.loader.JarLauncher 并非為項(xiàng)目中引入類,而是 spring-boot-maven-plugin 插件 repackage 追加進(jìn)去的。
接下來我們先來看一下 JarLauncher 的源碼,比較簡單,如下圖所示:
public class JarLauncher extends ExecutableArchiveLauncher {
private static final String DEFAULT_CLASSPATH_INDEX_LOCATION = "BOOT-INF/classpath.idx";
static final EntryFilter NESTED_ARCHIVE_ENTRY_FILTER = (entry) -> {
if (entry.isDirectory()) {
return entry.getName().equals("BOOT-INF/classes/");
}
return entry.getName().startsWith("BOOT-INF/lib/");
};
public JarLauncher() {
}
protected JarLauncher(Archive archive) {
super(archive);
}
@Override
protected ClassPathIndexFile getClassPathIndex(Archive archive) throws IOException {
// Only needed for exploded archives, regular ones already have a defined order
if (archive instanceof ExplodedArchive) {
String location = getClassPathIndexFileLocation(archive);
return ClassPathIndexFile.loadIfPossible(archive.getUrl(), location);
}
return super.getClassPathIndex(archive);
}
private String getClassPathIndexFileLocation(Archive archive) throws IOException {
Manifest manifest = archive.getManifest();
Attributes attributes = (manifest != null) ? manifest.getMainAttributes() : null;
String location = (attributes != null) ? attributes.getValue(BOOT_CLASSPATH_INDEX_ATTRIBUTE) : null;
return (location != null) ? location : DEFAULT_CLASSPATH_INDEX_LOCATION;
}
@Override
protected boolean isPostProcessingClassPathArchives() {
return false;
}
@Override
protected boolean isSearchCandidate(Archive.Entry entry) {
return entry.getName().startsWith("BOOT-INF/");
}
@Override
protected boolean isNestedArchive(Archive.Entry entry) {
return NESTED_ARCHIVE_ENTRY_FILTER.matches(entry);
}
public static void main(String[] args) throws Exception {
//調(diào)用基類 Launcher 定義的 launch 方法
new JarLauncher().launch(args);
}
}主要看它的 main 方法,調(diào)用的是基類 Launcher 定義的 launch 方法,而 Launcher 是ExecutableArchiveLauncher 的父類。下面我們來看看Launcher基類源碼:
Launcher
public abstract class Launcher {
private static final String JAR_MODE_LAUNCHER = "org.springframework.boot.loader.jarmode.JarModeLauncher";
protected void launch(String[] args) throws Exception {
if (!isExploded()) {
JarFile.registerUrlProtocolHandler();
}
ClassLoader classLoader = createClassLoader(getClassPathArchivesIterator());
String jarMode = System.getProperty("jarmode");
String launchClass = (jarMode != null && !jarMode.isEmpty()) ? JAR_MODE_LAUNCHER : getMainClass();
launch(args, launchClass, classLoader);
}
@Deprecated
protected ClassLoader createClassLoader(List<Archive> archives) throws Exception {
return createClassLoader(archives.iterator());
}
protected ClassLoader createClassLoader(Iterator<Archive> archives) throws Exception {
List<URL> urls = new ArrayList<>(50);
while (archives.hasNext()) {
urls.add(archives.next().getUrl());
}
return createClassLoader(urls.toArray(new URL[0]));
}
protected ClassLoader createClassLoader(URL[] urls) throws Exception {
return new LaunchedURLClassLoader(isExploded(), getArchive(), urls, getClass().getClassLoader());
}
protected void launch(String[] args, String launchClass, ClassLoader classLoader) throws Exception {
Thread.currentThread().setContextClassLoader(classLoader);
createMainMethodRunner(launchClass, args, classLoader).run();
}
protected MainMethodRunner createMainMethodRunner(String mainClass, String[] args, ClassLoader classLoader) {
return new MainMethodRunner(mainClass, args);
}
protected abstract String getMainClass() throws Exception;
protected Iterator<Archive> getClassPathArchivesIterator() throws Exception {
return getClassPathArchives().iterator();
}
@Deprecated
protected List<Archive> getClassPathArchives() throws Exception {
throw new IllegalStateException("Unexpected call to getClassPathArchives()");
}
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));
}
protected boolean isExploded() {
return false;
}
protected Archive getArchive() {
return null;
}
}launch 方法會(huì)首先創(chuàng)建類加載器,而后判斷是否 jar 是否在
MANIFEST.MF文件中設(shè)置了jarmode屬性。如果沒有設(shè)置,launchClass 的值就來自
getMainClass()返回,該方法由PropertiesLauncher子類實(shí)現(xiàn),返回 MANIFEST.MF 中配置的Start-Class屬性值。調(diào)用
createMainMethodRunner方法,構(gòu)建一個(gè)MainMethodRunner對象并調(diào)用其 run 方法。
PropertiesLauncher
@Override
protected String getMainClass() throws Exception {
//加載 jar包 target目錄下的 MANIFEST.MF 文件中 Start-Class配置,找到springboot的啟動(dòng)類
String mainClass = getProperty(MAIN, "Start-Class");
if (mainClass == null) {
throw new IllegalStateException("No '" + MAIN + "' or 'Start-Class' specified");
}
return mainClass;
}MainMethodRunner
目標(biāo)類main方法的執(zhí)行器,此時(shí)的 mainClassName 被賦值為 MANIFEST.MF 中配置的 Start-Class 屬性值,也就是 com.listenvision.SpringbootApplication,之后便是通過反射執(zhí)行 SpringbootApplication 的 main 方法,從而達(dá)到啟動(dòng) Spring Boot 的效果。
public class MainMethodRunner {
private final String mainClassName;
private final String[] args;
public MainMethodRunner(String mainClass, String[] args) {
this.mainClassName = mainClass;
this.args = (args != null) ? args.clone() : null;
}
public void run() throws Exception {
Class<?> mainClass = Class.forName(this.mainClassName, false, Thread.currentThread().getContextClassLoader());
Method mainMethod = mainClass.getDeclaredMethod("main", String[].class);
mainMethod.setAccessible(true);
mainMethod.invoke(null, new Object[] { this.args });
}
}總結(jié)
jar 包類似于 zip 壓縮文件,只不過相比 zip 文件多了一個(gè)
META-INF/MANIFEST.MF文件,該文件在構(gòu)建 jar 包時(shí)自動(dòng)創(chuàng)建。Spring Boot 提供了一個(gè)插件 spring-boot-maven-plugin ,用于把程序打包成一個(gè)可執(zhí)行的jar包。
使用 java -jar 啟動(dòng) Spring Boot 的 jar 包,首先調(diào)用的入口類是
JarLauncher,內(nèi)部調(diào)用Launcher的 launch 后構(gòu)建MainMethodRunner對象,最終通過反射調(diào)用 SpringbootApplication 的 main 方法實(shí)現(xiàn)啟動(dòng)效果。
到此這篇關(guān)于SpringBoot為何可以使用Jar包啟動(dòng)的文章就介紹到這了,更多相關(guān)SpringBoot用Jar包啟動(dòng)內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
idea雙擊圖標(biāo)打不開,無反應(yīng)的解決
這篇文章主要介紹了idea雙擊圖標(biāo)打不開,無反應(yīng)的解決方案,具有很好的參考價(jià)值,希望對大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-09-09
Java程序結(jié)構(gòu)與常量變量難點(diǎn)解析
JAVA的基本結(jié)構(gòu)就是順序結(jié)構(gòu),除非特別指明,否則就按照順序一句一句執(zhí)行順序結(jié)構(gòu)是最簡單的算法結(jié)構(gòu),語句與語句之間,框與框之間是按從上到下的順序進(jìn)行的,它是由若干個(gè)依次執(zhí)行的處理步驟組成的,它是任何一個(gè)算法都離不開的一種基本算法結(jié)構(gòu)2021-10-10
如何在Java中實(shí)現(xiàn)一個(gè)散列表
這篇文章主要介紹了如何在Java中實(shí)現(xiàn)一個(gè)散列表,建一個(gè)HashMap,以String類型為Key,Int類型為Value,下文具體的操作過程需要的小伙伴可以參考一下2022-04-04
Springboot與vue實(shí)現(xiàn)文件導(dǎo)入方法具體介紹
文件導(dǎo)入時(shí)大多數(shù)項(xiàng)目無法回避的問題,這兩天深入學(xué)習(xí)了文件導(dǎo)入,在這里進(jìn)行記錄,使用到的技術(shù)是Springboot+Vue,前端組件使用el-upload2023-02-02
java實(shí)現(xiàn)微信支付結(jié)果通知
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)微信支付結(jié)果通知,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2019-01-01
Springboot使用zxing實(shí)現(xiàn)二維碼生成和解析
ZXing支持各種條形碼,二維碼掃描,由多個(gè)模塊組成,?而且支持PC端,移動(dòng)端,本文將利用zxing實(shí)現(xiàn)二維碼生成和解析,感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2023-10-10

