位元組二面:為什麼SpringBoot的 jar 可以直接執行?我說因為內嵌了Tomcat容器,他讓我出門左轉。。

码农Academy發表於2024-04-04

引言

在傳統的Java應用程式開發和部署場景中,開發者往往需要經歷一系列複雜的步驟才能將應用成功部署到生產環境。例如,對於基於Servlet規範的Java Web應用,開發完成後通常會被打包成WAR格式,然後部署到像Apache Tomcat、Jetty這樣的Web容器中。這一過程中,不僅要管理應用本身的編譯產物,還需要處理各種第三方依賴庫的版本和載入順序,同時在伺服器端進行相應的配置以確保應用正常執行。

隨著Spring Boot產生,它以其開箱即用、約定優於配置的理念徹底改變了Java應用的開發體驗。其中一個標誌性特徵便是Spring Boot應用可以被打包成一個可直接執行的jar檔案,無需外部容器的支援。

當提及“Spring Boot的jar可以直接執行”,我們不禁好奇:這背後究竟是怎樣的機制讓一個簡單的命令列操作就能啟動一個完整的Web服務或任何型別的Java應用呢?本文將深入剖析Spring Boot的打包過程和執行原理,揭示其jar包是如何巧妙地整合了依賴、嵌入了Web容器、實現了自動配置等功能,從而使得開發人員能夠迅速地將應用部署到任何支援Java的環境中。

springboot的jar包為什麼可以直接執行.png

SpringBoot JAR包基礎概念

Fat JAR(也稱作Uber JAR,也被戲稱為胖Jar)是一種特殊的Java歸檔(JAR)檔案,它將應用程式所需的全部依賴庫與應用程式自身的類檔案合併到了同一個JAR檔案中。在Spring Boot上下文中,Fat JAR被用於構建一種完全自包含且可獨立執行的應用程式包。這樣的jar檔案不僅僅包含專案的主程式碼,還包括了所有必要的第三方庫、資原始檔等一切執行時所需要的元件。

Fat JAR的核心特點是“自包含”,意味著只需分發這一個檔案即可部署應用,無需再額外處理眾多的依賴庫。這種形式極大地方便了應用的快速部署與遷移,尤其適合於雲端部署或者無網路環境下的安裝。

而對於普通jar包來說,它通常僅包含一個模組或應用程式的一部分,主要用來封裝和組織Java類及相關資源。在Java生態系統中,一個普通的jar包可能僅是一個庫,或者一組相關功能的集合,但它不會包含其他依賴的jar包,因此在執行時需要與之相關的其他庫一起存在於類路徑中。

相比之下,Fat JAR則解決了依賴管理的問題,透過將所有的依賴都納入其中,避免了由於類路徑設定不正確導致的“缺失類”或“找不到類”的問題。在Spring Boot專案中,透過Maven或Gradle外掛可以輕易地構建出這樣的Fat JAR,使得最終生成的jar檔案成為一個真正的“一站式”解決方案,只需使用java -jar命令就可以啟動整個應用程式,無需預先配置複雜的類路徑環境。

Spring Boot應用打包機制

Spring Boot應用打包機制充分利用了Maven或Gradle構建工具的強大功能,旨在簡化傳統Java應用的構建與部署流程。其核心在於建立一個可執行的Fat JAR,使得開發者能夠輕鬆地將整個Spring Boot應用及其依賴項打包成單個檔案,從而實現一鍵啟動和便捷部署。

我們以Maven打包為例:

對於使用Maven構建的Spring Boot應用,spring-boot-maven-plugin是關鍵外掛,負責處理Fat JAR的構建。在pom.xml檔案中,通常會看到如下配置:

<build>
	<plugins>
		<plugin>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-maven-plugin</artifactId>
			<version>${spring-boot.version}</version>
			<configuration>
				<!-- 可選配置項,如mainClass屬性指定入口類 -->
				<mainClass>${start-class}</mainClass>
			</configuration>
			<executions>
				<execution>
					<goals>
						<goal>repackage</goal>
					</goals>
				</execution>
			</executions>
		</plugin>
	</plugins>
</build>

透過mvn package命令,Maven首先會按照標準流程構建專案,隨後spring-boot-maven-plugin會執行repackage目標,該目標會重新包裝已生成的標準JAR檔案,將其轉換為包含所有依賴項和適當的啟動器資訊的Fat JAR。這樣生成的JAR可以直接透過java -jar命令啟動。

Spring Boot應用打包機制均確保了生成的包不僅包含了專案本身的類,還包含了執行時所必需的所有依賴庫,以及一些特定的後設資料(如MANIFEST.MF中的啟動類資訊)。這一特性大大簡化了部署過程,並有助於提升應用的可移植性和維護性。Fat jar中的內容:

image.png

  • META-INF/: 包含MANIFEST.MF檔案和其他後設資料資訊,其中Main-Class屬性指向Spring Boot的啟動類載入器。
  • BOOT-INF/classes/: 存放專案自身的類檔案和資原始檔。
  • BOOT-INF/lib/: 放置所有依賴的jar包,包括Spring Boot starter依賴以及其他第三方庫。(如果專案中有靜態資原始檔,也會在BOOT-INF下有對應的static、templates等目錄)

Spring Boot啟動器與Loader機制

Spring Boot應用的jar包可以直接執行主要依賴於它的啟動器以及Loader機制,而對於Loader機制主要利用MANIFEST.MF檔案以及其內部類載入邏輯。

MANIFEST.MF檔案是什麼?

MANIFEST.MFJAR檔案內的一個標準後設資料檔案,它包含了關於JAR包的基本資訊和執行指令。在Spring Boot應用的jar包中,MANIFEST.MF尤為重要,因為它設定了Main-Class屬性,指示了用於啟動整個應用程式的類,這個類通常是org.springframework.boot.loader.JarLauncher或其他由Spring Boot提供的啟動器類。

image.png

Main-Class屬性指向的JarLauncher類是Spring Boot自定義的類載入器體系的一部分。JarLauncher繼承自org.springframework.boot.loader.Launcher,專門用於啟動以Fat JAR形式釋出的Spring Boot應用。JarLauncher負責建立一個類載入器LaunchedURLClassLoader

image.png
image.png

當透過java -jar命令執行Spring Boot jar包時,JVM會依據MANIFEST.MF中的Main-Class啟動指定的啟動器。

JarLauncher獲取MainClass原始碼.png

Spring Boot的啟動器類載入器LaunchedURLClassLoader首先會讀取MANIFEST.MF中的附加屬性,如Start-Class(標識應用的實際主類)和Spring-Boot-Lib(指向內部依賴庫的位置)。

image.png

image.png

啟動類載入器工作流程如下:

  1. 當啟動器類載入器啟動時,它會根據MANIFEST.MF中的資訊來組織類路徑,保證所有內部的依賴庫都能正確地被載入。

  2. 載入器會區分出 BOOT-INF/classes中的應用程式類和 BOOT-INF/lib 下的依賴庫,分別處理並加入到類載入器的搜尋路徑中。

  3. 載入器載入並執行實際的Start-Class,即應用的主類,觸發Spring Boot框架的初始化和應用的啟動流程。比如示例中的應用主類:com.springboot.base.SpringBootBaseApplication

Spring Boot的啟動器和載入器機制有效地實現了對自包含jar包的管理和執行,我們無需關心複雜的類路徑配置和依賴載入,只需透過一個簡單的命令即可啟動一個完整、獨立執行的應用程式。

內嵌Web容器

Spring Boot的一大特色就是能夠無縫整合並內嵌多種輕量級Web容器,比如:Apache TomcatJettyUndertow以及Reactor Netty(對於響應式程式設計模型)。內嵌Web容器的引入極大地簡化了Web應用的部署流程,我們不再需要在本地或伺服器上獨立安裝和配置Web伺服器(比如以前還要在本地安裝tomcat)。

當Spring Boot應用引入了spring-boot-starter-web依賴時,預設情況下會自動配置並啟動一個內嵌的Web容器。在Spring Boot啟動的過程中,內嵌容器作為應用的一部分被初始化並繫結到特定埠上,以便對外提供HTTP服務。

Spring Boot內嵌web容器的優點在於簡化部署,透過將Web容器內建於應用中,只需分發單一的JAR檔案,就能在乾淨的環境中執行應用,避免了與現有Web伺服器版本衝突或配置不當等問題;同時加快了啟動速度,尤其在開發和測試階段,實現近乎即時的熱重啟;提高了應用的穩定性,因為開發環境和生產環境使用相同的Web容器,降低了因環境差異導致的問題;此外,雖然容器是內嵌的,但仍然可以進行全面的配置調整,如埠、連線數、SSL設定等,以滿足不同場景的需求。透過內嵌Web容器,Spring Boot真正實現了“開箱即用”的理念。

自動配置與類路徑掃描

Spring Boot的核心特性之一就是其強大的自動配置能力,它允許應用在幾乎零配置的情況下快速啟動並執行。

當應用啟動時,Spring Boot會讀取resource/META-INF/spring.factories檔案,該檔案列出了所有可用的自動配置類。當它檢測到應用環境中對應的自動配置類就會生效,透過@Configuration註解的類建立並註冊Bean到Spring容器中,從而實現Bean的自動裝配。

這裡說明下,在springboot3.x以後,就不在從resource/META-INF/spring.factories讀取自動配置類了,而是從org.springframework.boot.autoconfigure.AutoConfiguration.imports中讀取,這一點請參考文章:華為二面:SpringBoot如何自定義_Starter_?

並且Spring Boot還採用條件註解(如@ConditionalOnClass@ConditionalOnMissingBean等)來智慧判斷何時應用特定的配置。這些註解可以根據類路徑中是否存在特定類、系統屬性或環境變數的值等因素,決定是否應該啟用某個自動配置類。這意味著只有當滿足特定條件時,相應的Bean才會被建立和注入。

而對於應用主類則是用@SpringBootApplication註解標識。@SpringBootApplication是一個複合註解,包含了@SpringBootConfiguration@EnableAutoConfiguration@ComponentScan三個註解的功能。其中

  • @SpringBootConfiguration是一個Spring配置類,可以替代@Configuration註解,宣告當前類是Spring配置類,裡面包含了一系列@Bean方法或@ConfigurationProperties等配置。
  • @EnableAutoConfiguration啟用自動配置特性,告訴Spring Boot根據應用類路徑中的依賴來自動配置Bean。Spring Boot會根據類路徑掃描的結果,智慧地決定哪些自動配置類應當生效。
  • @ComponentScan會自動掃描和管理Spring元件,包括@Service、@Repository、@Controller和@Component等註解標註的類。透過該註解,Spring Boot能自動發現和管理應用中的各個元件,並將其註冊為Spring容器中的Bean。

透過上述機制,Spring Boot能夠智慧識別專案依賴、自動配置Bean,並結合類路徑掃描確保所有相關的元件和服務都被正確地初始化和管理,我們就可以專注於業務邏輯的開發,而不必過多考慮基礎設施層面的配置問題。

總結

Spring Boot 應用程式被打包成的jar包之所以可以直接透過 java -jar 命令執行,是因為Spring Boot在構建過程中做了一些特殊的設計和配置。具體原因:

  1. Fat/Uber JAR: Spring Boot使用maven外掛spring-boot-maven-plugin(或Gradle對應的外掛)將專案及其所有依賴項打包成一個單一的、自包含的jar檔案,通常稱為“Fat JAR”或“Uber JAR”。這意味著不僅包含了自己的類檔案,還包含了執行應用所需的所有第三方庫。

  2. Manifest.MF: 在打包過程中,此外掛會修改MANIFEST.MF檔案,這是jar包中的一個後設資料檔案。在MANIFEST.MF中,特別指定了Main-Class屬性,該屬性指向Spring Boot的一個內建的啟動類(如org.springframework.boot.loader.JarLauncher),這個啟動器類知道如何正確啟動Spring Boot應用程式。

  3. 嵌入式Servlet容器:Spring Boot預設整合了諸如Tomcat、Jetty或Undertow等嵌入式Web容器,使得無需外部伺服器環境也能執行Web應用。

  4. 啟動器類載入器:當透過java -jar執行Spring Boot應用時,JVM會根據MANIFEST.MF中的Main-Class找到並執行指定的啟動器類。這個啟動器類載入器能夠解壓並載入內部的依賴庫,並定位到實際的應用主類(在spring-boot-starter-parent@SpringBootApplication註解標記的類),進而執行其main方法。

  5. 類路徑掃描和自動配置:Spring Boot應用透過特定的類路徑掃描機制和自動配置功能,能夠在啟動時識別出應用所依賴的服務和元件,並自動配置它們,大大簡化了傳統Java應用的配置和部署過程。

Spring Boot透過精心設計的打包流程和啟動器類,使得生成的jar包可以直接作為一個獨立的應用程式執行,極大地簡化了部署和運維複雜度。

本文已收錄於我的個人部落格:碼農Academy的部落格,專注分享Java技術乾貨,包括Java基礎、Spring Boot、Spring Cloud、Mysql、Redis、Elasticsearch、中介軟體、架構設計、面試題、程式設計師攻略等

相關文章