震驚!你還不知道SpringBoot真正的啟動引導類

風平浪靜如碼發表於2020-11-02
Spring Boot

引言

SpringBoot專案中的啟動類，一般都是XXApplication,例如「StatsApplication」，「UnionApplication」。

每個專案的啟動類名稱都不一樣。但是它的啟動類真的是XXApplication嗎？

META-INF/****Manifest.mf檔案

jar檔案實際上是class檔案的zip壓縮存檔。jar並不能表達應用程式的便籤資訊.

「META-INF/Manifest.mf檔案提供存檔的便籤資訊.」

Manifest.mf有 「Main-Class，用來標明jar檔案的入口類。」

解壓jar包，檢視META-INF/Manifest.mf過程如下：

重要資訊如下

Main-Class: org.springframework.boot.loader.JarLauncher
Start-Class: com.shanyuan.StatsApplication

也就是說：「org.springframework.boot.loader.JarLauncher 是 SpringBoot 的啟動類！」

下面瀏覽下 JarLauncher

瀏覽JarLauncher

3.1 找到JarLauncher

進入IDEA，Ctrl+N查詢JarLauncher，竟然找不到！！

進入 https://search.maven.org/classic/#advancedsearch 查詢JarLauncher

在查詢結果找到spring下的專案

確定 JarLauncher 位於 spring-boot-loader 下。為了方便檢視原始碼，在 pom 中引入

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

3.2.JarLauncher說明

JarLauncher作為引導類 ，當呼叫java -jar 命令時，將呼叫 main 方法，實際上呼叫的是 「JarLauncher#launch」方法，該方法繼承於 org.springframework.boot.loader.Launcher

簡化層次關係為：

JarLauncher#launch程式碼如下

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

「聚句解析」

「1,.JarFile.registerUrlProtocolHandler();」

Spring Boot 生成的 FAT jar，在被 java -jar 引導時，其內部的 jar 檔案無法被 sun.net.www.protocol.jar.Handler 處理。微信公眾號搜尋, [Java學習之道] ,回覆 '福利' 2T 資料等你來拿~

所以 SpringBoot 實現了，org.springframework.boot.loader.jar.Handler

JarFile.registerUrlProtocolHandler(), 就註冊 org.springframework.boot.loader.jar.Handler

「2.ClassLoader classLoader = createClassLoader(getClassPathArchives());」

建立ClassLoader。

getClassPathArchives 核心判斷是 isNestedArchive 方法。

isNestedArchive 被 JarLauncher 覆寫了。其實現如下：

static final String BOOT_INF_CLASSES = "BOOT-INF/classes/";

static final String BOOT_INF_LIB = "BOOT-INF/lib/";
@Override
protected boolean isNestedArchive(Archive.Entry entry) {
   if (entry.isDirectory()) {
      return entry.getName().equals(BOOT_INF_CLASSES);
   }
   return entry.getName().startsWith(BOOT_INF_LIB);
}

也就是說，只要 「滿足以BOOT-INF/classes/和BOOT-INF/lib/都是classLoader載入」的範圍。

解壓的jar，檢視也與只對應

3. launch(args, getMainClass(), classLoader);

protected void launch(String[] args, String mainClass, 
                ClassLoader classLoader)
      throws Exception {
   Thread.currentThread().setContextClassLoader(classLoader);
   createMainMethodRunner(mainClass, args, classLoader).run();
}

檢視 createMainMethodRunner 的 run 方法，如下：

public class MainMethodRunner {
    // 省略部分程式碼
    public void run() throws Exception {
   Class<?> mainClass = Thread.currentThread().getContextClassLoader()
         .loadClass(this.mainClassName);
       Method mainMethod = 
           mainClass.getDeclaredMethod("main", String[].class);
       mainMethod.invoke(null, new Object[] { this.args });
    }
}

其中 mainClass，來自 /META-INF/MANIFEST.MF 中的 Start-Class 屬性。

「即，JarLauncher 是同程式內，通過反射呼叫 Start-Class 對應類，即 XXXApplication 的 main 方法。」

4.總結

SpringBoot 專案的實際啟動類是 org.springframework.boot.loader.JarLauncher。

「在 JarLauncher 內部通過反射呼叫 XXApplication 類的 main 方法。具體實現位於 MainMethodRunner中。」

寫在最後

歡迎大家關注我的公眾號【風平浪靜如碼】，海量Java相關文章，學習資料都會在裡面更新，整理的資料也會放在裡面。

覺得寫的還不錯的就點個贊，加個關注唄！點關注，不迷路，持續更新！！！

相關文章