字節(jié)二面:為什么SpringBoot的 jar 可以直接運(yùn)行?
引言
在傳統(tǒng)的Java應(yīng)用程序開發(fā)和部署場(chǎng)景中,開發(fā)者往往需要經(jīng)歷一系列復(fù)雜的步驟才能將應(yīng)用成功部署到生產(chǎn)環(huán)境。例如,對(duì)于基于Servlet規(guī)范的Java Web應(yīng)用,開發(fā)完成后通常會(huì)被打包成WAR格式,然后部署到像Apache Tomcat、Jetty這樣的Web容器中。這一過程中,不僅要管理應(yīng)用本身的編譯產(chǎn)物,還需要處理各種第三方依賴庫的版本和加載順序,同時(shí)在服務(wù)器端進(jìn)行相應(yīng)的配置以確保應(yīng)用正常運(yùn)行。
隨著Spring Boot產(chǎn)生,它以其開箱即用、約定優(yōu)于配置的理念徹底改變了Java應(yīng)用的開發(fā)體驗(yàn)。其中一個(gè)標(biāo)志性特征便是Spring Boot應(yīng)用可以被打包成一個(gè)可直接運(yùn)行的jar文件,無需外部容器的支持。
當(dāng)提及“Spring Boot的jar可以直接運(yùn)行”,我們不禁好奇:這背后究竟是怎樣的機(jī)制讓一個(gè)簡(jiǎn)單的命令行操作就能啟動(dòng)一個(gè)完整的Web服務(wù)或任何類型的Java應(yīng)用呢?本文將深入剖析Spring Boot的打包過程和運(yùn)行原理,揭示其jar包是如何巧妙地集成了依賴、嵌入了Web容器、實(shí)現(xiàn)了自動(dòng)配置等功能,從而使得開發(fā)人員能夠迅速地將應(yīng)用部署到任何支持Java的環(huán)境中。
圖片
SpringBoot JAR包基礎(chǔ)概念
Fat JAR(也稱作Uber JAR,也被戲稱為胖Jar)是一種特殊的Java歸檔(JAR)文件,它將應(yīng)用程序所需的全部依賴庫與應(yīng)用程序自身的類文件合并到了同一個(gè)JAR文件中。在Spring Boot上下文中,F(xiàn)at JAR被用于構(gòu)建一種完全自包含且可獨(dú)立運(yùn)行的應(yīng)用程序包。這樣的jar文件不僅僅包含項(xiàng)目的主代碼,還包括了所有必要的第三方庫、資源文件等一切運(yùn)行時(shí)所需要的組件。
Fat JAR的核心特點(diǎn)是“自包含”,意味著只需分發(fā)這一個(gè)文件即可部署應(yīng)用,無需再額外處理眾多的依賴庫。這種形式極大地方便了應(yīng)用的快速部署與遷移,尤其適合于云端部署或者無網(wǎng)絡(luò)環(huán)境下的安裝。
而對(duì)于普通jar包來說,它通常僅包含一個(gè)模塊或應(yīng)用程序的一部分,主要用來封裝和組織Java類及相關(guān)資源。在Java生態(tài)系統(tǒng)中,一個(gè)普通的jar包可能僅是一個(gè)庫,或者一組相關(guān)功能的集合,但它不會(huì)包含其他依賴的jar包,因此在運(yùn)行時(shí)需要與之相關(guān)的其他庫一起存在于類路徑中。
相比之下,F(xiàn)at JAR則解決了依賴管理的問題,通過將所有的依賴都納入其中,避免了由于類路徑設(shè)置不正確導(dǎo)致的“缺失類”或“找不到類”的問題。在Spring Boot項(xiàng)目中,通過Maven或Gradle插件可以輕易地構(gòu)建出這樣的Fat JAR,使得最終生成的jar文件成為一個(gè)真正的“一站式”解決方案,只需使用java -jar命令就可以啟動(dòng)整個(gè)應(yīng)用程序,無需預(yù)先配置復(fù)雜的類路徑環(huán)境。
Spring Boot應(yīng)用打包機(jī)制
Spring Boot應(yīng)用打包機(jī)制充分利用了Maven或Gradle構(gòu)建工具的強(qiáng)大功能,旨在簡(jiǎn)化傳統(tǒng)Java應(yīng)用的構(gòu)建與部署流程。其核心在于創(chuàng)建一個(gè)可執(zhí)行的Fat JAR,使得開發(fā)者能夠輕松地將整個(gè)Spring Boot應(yīng)用及其依賴項(xiàng)打包成單個(gè)文件,從而實(shí)現(xiàn)一鍵啟動(dòng)和便捷部署。
我們以Maven打包為例:
對(duì)于使用Maven構(gòu)建的Spring Boot應(yīng)用,spring-boot-maven-plugin是關(guān)鍵插件,負(fù)責(zé)處理Fat JAR的構(gòu)建。在pom.xml文件中,通常會(huì)看到如下配置:
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>${spring-boot.version}</version>
<configuration>
<!-- 可選配置項(xiàng),如mainClass屬性指定入口類 -->
<mainClass>${start-class}</mainClass>
</configuration>
<executions>
<execution>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
通過mvn package命令,Maven首先會(huì)按照標(biāo)準(zhǔn)流程構(gòu)建項(xiàng)目,隨后spring-boot-maven-plugin會(huì)執(zhí)行repackage目標(biāo),該目標(biāo)會(huì)重新包裝已生成的標(biāo)準(zhǔn)JAR文件,將其轉(zhuǎn)換為包含所有依賴項(xiàng)和適當(dāng)?shù)膯?dòng)器信息的Fat JAR。這樣生成的JAR可以直接通過java -jar命令啟動(dòng)。
Spring Boot應(yīng)用打包機(jī)制均確保了生成的包不僅包含了項(xiàng)目本身的類,還包含了運(yùn)行時(shí)所必需的所有依賴庫,以及一些特定的元數(shù)據(jù)(如MANIFEST.MF中的啟動(dòng)類信息)。這一特性大大簡(jiǎn)化了部署過程,并有助于提升應(yīng)用的可移植性和維護(hù)性。Fat jar中的內(nèi)容:
圖片
- META-INF/: 包含MANIFEST.MF文件和其他元數(shù)據(jù)信息,其中Main-Class屬性指向Spring Boot的啟動(dòng)類加載器。
- BOOT-INF/classes/: 存放項(xiàng)目自身的類文件和資源文件。
- BOOT-INF/lib/: 放置所有依賴的jar包,包括Spring Boot starter依賴以及其他第三方庫。(如果項(xiàng)目中有靜態(tài)資源文件,也會(huì)在BOOT-INF下有對(duì)應(yīng)的static、templates等目錄)
Spring Boot啟動(dòng)器與Loader機(jī)制
Spring Boot應(yīng)用的jar包可以直接運(yùn)行主要依賴于它的啟動(dòng)器以及Loader機(jī)制,而對(duì)于Loader機(jī)制主要利用MANIFEST.MF文件以及其內(nèi)部類加載邏輯。
MANIFEST.MF文件是什么?
MANIFEST.MF是JAR文件內(nèi)的一個(gè)標(biāo)準(zhǔn)元數(shù)據(jù)文件,它包含了關(guān)于JAR包的基本信息和運(yùn)行指令。在Spring Boot應(yīng)用的jar包中,MANIFEST.MF尤為重要,因?yàn)樗O(shè)置了Main-Class屬性,指示了用于啟動(dòng)整個(gè)應(yīng)用程序的類,這個(gè)類通常是org.springframework.boot.loader.JarLauncher或其他由Spring Boot提供的啟動(dòng)器類。
圖片
Main-Class屬性指向的JarLauncher類是Spring Boot自定義的類加載器體系的一部分。JarLauncher繼承自org.springframework.boot.loader.Launcher,專門用于啟動(dòng)以Fat JAR形式發(fā)布的Spring Boot應(yīng)用。JarLauncher負(fù)責(zé)創(chuàng)建一個(gè)類加載器LaunchedURLClassLoader。
圖片
圖片
當(dāng)通過java -jar命令執(zhí)行Spring Boot jar包時(shí),JVM會(huì)依據(jù)MANIFEST.MF中的Main-Class啟動(dòng)指定的啟動(dòng)器。
JarLauncher獲取MainClass源碼
Spring Boot的啟動(dòng)器類加載器LaunchedURLClassLoader首先會(huì)讀取MANIFEST.MF中的附加屬性,如Start-Class(標(biāo)識(shí)應(yīng)用的實(shí)際主類)和Spring-Boot-Lib(指向內(nèi)部依賴庫的位置)。
圖片
圖片
啟動(dòng)類加載器工作流程如下:
- 當(dāng)啟動(dòng)器類加載器啟動(dòng)時(shí),它會(huì)根據(jù)MANIFEST.MF中的信息來組織類路徑,保證所有內(nèi)部的依賴庫都能正確地被加載。
- 加載器會(huì)區(qū)分出 BOOT-INF/classes中的應(yīng)用程序類和 BOOT-INF/lib 下的依賴庫,分別處理并加入到類加載器的搜索路徑中。
- 加載器加載并執(zhí)行實(shí)際的Start-Class,即應(yīng)用的主類,觸發(fā)Spring Boot框架的初始化和應(yīng)用的啟動(dòng)流程。比如示例中的應(yīng)用主類:com.springboot.base.SpringBootBaseApplication
Spring Boot的啟動(dòng)器和加載器機(jī)制有效地實(shí)現(xiàn)了對(duì)自包含jar包的管理和執(zhí)行,我們無需關(guān)心復(fù)雜的類路徑配置和依賴加載,只需通過一個(gè)簡(jiǎn)單的命令即可啟動(dòng)一個(gè)完整、獨(dú)立運(yùn)行的應(yīng)用程序。
內(nèi)嵌Web容器
Spring Boot的一大特色就是能夠無縫整合并內(nèi)嵌多種輕量級(jí)Web容器,比如:Apache Tomcat、Jetty、Undertow以及Reactor Netty(對(duì)于響應(yīng)式編程模型)。內(nèi)嵌Web容器的引入極大地簡(jiǎn)化了Web應(yīng)用的部署流程,我們不再需要在本地或服務(wù)器上獨(dú)立安裝和配置Web服務(wù)器(比如以前還要在本地安裝tomcat)。
當(dāng)Spring Boot應(yīng)用引入了spring-boot-starter-web依賴時(shí),默認(rèn)情況下會(huì)自動(dòng)配置并啟動(dòng)一個(gè)內(nèi)嵌的Web容器。在Spring Boot啟動(dòng)的過程中,內(nèi)嵌容器作為應(yīng)用的一部分被初始化并綁定到特定端口上,以便對(duì)外提供HTTP服務(wù)。
Spring Boot內(nèi)嵌web容器的優(yōu)點(diǎn)在于簡(jiǎn)化部署,通過將Web容器內(nèi)置于應(yīng)用中,只需分發(fā)單一的JAR文件,就能在干凈的環(huán)境中運(yùn)行應(yīng)用,避免了與現(xiàn)有Web服務(wù)器版本沖突或配置不當(dāng)?shù)葐栴};同時(shí)加快了啟動(dòng)速度,尤其在開發(fā)和測(cè)試階段,實(shí)現(xiàn)近乎即時(shí)的熱重啟;提高了應(yīng)用的穩(wěn)定性,因?yàn)殚_發(fā)環(huán)境和生產(chǎn)環(huán)境使用相同的Web容器,降低了因環(huán)境差異導(dǎo)致的問題;此外,雖然容器是內(nèi)嵌的,但仍然可以進(jìn)行全面的配置調(diào)整,如端口、連接數(shù)、SSL設(shè)置等,以滿足不同場(chǎng)景的需求。通過內(nèi)嵌Web容器,Spring Boot真正實(shí)現(xiàn)了“開箱即用”的理念。
自動(dòng)配置與類路徑掃描
Spring Boot的核心特性之一就是其強(qiáng)大的自動(dòng)配置能力,它允許應(yīng)用在幾乎零配置的情況下快速啟動(dòng)并運(yùn)行。
當(dāng)應(yīng)用啟動(dòng)時(shí),Spring Boot會(huì)讀取resource/META-INF/spring.factories文件,該文件列出了所有可用的自動(dòng)配置類。當(dāng)它檢測(cè)到應(yīng)用環(huán)境中對(duì)應(yīng)的自動(dòng)配置類就會(huì)生效,通過@Configuration注解的類創(chuàng)建并注冊(cè)Bean到Spring容器中,從而實(shí)現(xiàn)Bean的自動(dòng)裝配。
這里說明下,在springboot3.x以后,就不在從resource/META-INF/spring.factories讀取自動(dòng)配置類了,而是從org.springframework.boot.autoconfigure.AutoConfiguration.imports中讀取,這一點(diǎn)請(qǐng)參考文章:華為二面:SpringBoot如何自定義Starter?
并且Spring Boot還采用條件注解(如@ConditionalOnClass、@ConditionalOnMissingBean等)來智能判斷何時(shí)應(yīng)用特定的配置。這些注解可以根據(jù)類路徑中是否存在特定類、系統(tǒng)屬性或環(huán)境變量的值等因素,決定是否應(yīng)該激活某個(gè)自動(dòng)配置類。這意味著只有當(dāng)滿足特定條件時(shí),相應(yīng)的Bean才會(huì)被創(chuàng)建和注入。
而對(duì)于應(yīng)用主類則是用@SpringBootApplication注解標(biāo)識(shí)。@SpringBootApplication是一個(gè)復(fù)合注解,包含了@SpringBootConfiguration、@EnableAutoConfiguration和@ComponentScan三個(gè)注解的功能。其中
- @SpringBootConfiguration是一個(gè)Spring配置類,可以替代@Configuration注解,聲明當(dāng)前類是Spring配置類,里面包含了一系列@Bean方法或@ConfigurationProperties等配置。
- @EnableAutoConfiguration啟用自動(dòng)配置特性,告訴Spring Boot根據(jù)應(yīng)用類路徑中的依賴來自動(dòng)配置Bean。Spring Boot會(huì)根據(jù)類路徑掃描的結(jié)果,智能地決定哪些自動(dòng)配置類應(yīng)當(dāng)生效。
- @ComponentScan會(huì)自動(dòng)掃描和管理Spring組件,包括@Service、@Repository、@Controller和@Component等注解標(biāo)注的類。通過該注解,Spring Boot能自動(dòng)發(fā)現(xiàn)和管理應(yīng)用中的各個(gè)組件,并將其注冊(cè)為Spring容器中的Bean。
通過上述機(jī)制,Spring Boot能夠智能識(shí)別項(xiàng)目依賴、自動(dòng)配置Bean,并結(jié)合類路徑掃描確保所有相關(guān)的組件和服務(wù)都被正確地初始化和管理,我們就可以專注于業(yè)務(wù)邏輯的開發(fā),而不必過多考慮基礎(chǔ)設(shè)施層面的配置問題。
總結(jié)
Spring Boot 應(yīng)用程序被打包成的jar包之所以可以直接通過 java -jar 命令運(yùn)行,是因?yàn)镾pring Boot在構(gòu)建過程中做了一些特殊的設(shè)計(jì)和配置。具體原因:
- Fat/Uber JAR: Spring Boot使用maven插件spring-boot-maven-plugin(或Gradle對(duì)應(yīng)的插件)將項(xiàng)目及其所有依賴項(xiàng)打包成一個(gè)單一的、自包含的jar文件,通常稱為“Fat JAR”或“Uber JAR”。這意味著不僅包含了自己的類文件,還包含了運(yùn)行應(yīng)用所需的所有第三方庫。
- Manifest.MF: 在打包過程中,此插件會(huì)修改MANIFEST.MF文件,這是jar包中的一個(gè)元數(shù)據(jù)文件。在MANIFEST.MF中,特別指定了Main-Class屬性,該屬性指向Spring Boot的一個(gè)內(nèi)置的啟動(dòng)類(如org.springframework.boot.loader.JarLauncher),這個(gè)啟動(dòng)器類知道如何正確啟動(dòng)Spring Boot應(yīng)用程序。
- 嵌入式Servlet容器:Spring Boot默認(rèn)集成了諸如Tomcat、Jetty或Undertow等嵌入式Web容器,使得無需外部服務(wù)器環(huán)境也能運(yùn)行Web應(yīng)用。
- 啟動(dòng)器類加載器:當(dāng)通過java -jar運(yùn)行Spring Boot應(yīng)用時(shí),JVM會(huì)根據(jù)MANIFEST.MF中的Main-Class找到并運(yùn)行指定的啟動(dòng)器類。這個(gè)啟動(dòng)器類加載器能夠解壓并加載內(nèi)部的依賴庫,并定位到實(shí)際的應(yīng)用主類(在spring-boot-starter-parent或@SpringBootApplication注解標(biāo)記的類),進(jìn)而執(zhí)行其main方法。
- 類路徑掃描和自動(dòng)配置:Spring Boot應(yīng)用通過特定的類路徑掃描機(jī)制和自動(dòng)配置功能,能夠在啟動(dòng)時(shí)識(shí)別出應(yīng)用所依賴的服務(wù)和組件,并自動(dòng)配置它們,大大簡(jiǎn)化了傳統(tǒng)Java應(yīng)用的配置和部署過程。
Spring Boot通過精心設(shè)計(jì)的打包流程和啟動(dòng)器類,使得生成的jar包可以直接作為一個(gè)獨(dú)立的應(yīng)用程序運(yùn)行,極大地簡(jiǎn)化了部署和運(yùn)維復(fù)雜度。