原文地址 https://docs.spring.io/spring-boot/docs/1.5.19.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar
Spring引導(dǎo)加載程序模塊允許Spring引導(dǎo)支持可執(zhí)行jar和war文件带污。如果您正在使用Maven或Gradle插件破镰,那么可執(zhí)行jar將自動(dòng)生成,您通常不需要知道它們?nèi)绾喂ぷ鞯募?xì)節(jié)。
如果您需要從不同的構(gòu)建系統(tǒng)創(chuàng)建可執(zhí)行jar,或者您只是對(duì)底層技術(shù)感興趣,那么本節(jié)將提供一些背景知識(shí)。
E.1嵌套的jar
Java沒(méi)有提供任何加載嵌套的jar文件(即包含在jar中的jar文件)的標(biāo)準(zhǔn)方法。如果您希望分發(fā)一個(gè)自包含的應(yīng)用程序稿静,您可以只從命令行運(yùn)行該應(yīng)用程序,而不需要解壓縮辕狰,那么這可能會(huì)有問(wèn)題改备。
為了解決這個(gè)問(wèn)題,許多開(kāi)發(fā)人員使用“shaded”jar蔓倍。shaded jar只是將所有jar中的所有類(lèi)打包到一個(gè)“uber jar”中悬钳。shaded
jar的問(wèn)題是,很難看到在應(yīng)用程序中實(shí)際使用的庫(kù)偶翅。如果在多個(gè)jar中使用相同的文件名(但內(nèi)容不同)默勾,也會(huì)出現(xiàn)問(wèn)題。Spring Boot采用了一種不同的方法聚谁,允許您直接嵌套jar母剥。
E.1.1 可執(zhí)行jar文件結(jié)構(gòu)
Spring引導(dǎo)加載程序兼容的jar文件的結(jié)構(gòu)應(yīng)該如下所示:
example.jar
|
+-META-INF
| +-MANIFEST.MF
+-org
| +-springframework
| +-boot
| +-loader
| +-<spring boot loader classes>
+-BOOT-INF
+-classes
| +-mycompany
| +-project
| +-YourClasses.class
+-lib
+-dependency1.jar
+-dependency2.jar
應(yīng)用程序類(lèi)應(yīng)該放在一個(gè)嵌套的BOOT-INF/classes目錄中. 依賴(lài)項(xiàng)應(yīng)該放在一個(gè)嵌套的BOOT-INF/lib目錄中。
E.1.2 可執(zhí)行的war文件結(jié)構(gòu)
兼容Spring Boot Loader的war文件的結(jié)構(gòu)應(yīng)該是這樣的:
example.war
|
+-META-INF
| +-MANIFEST.MF
+-org
| +-springframework
| +-boot
| +-loader
| +-<spring boot loader classes>
+-WEB-INF
+-classes
| +-com
| +-mycompany
| +-project
| +-YourClasses.class
+-lib
| +-dependency1.jar
| +-dependency2.jar
+-lib-provided
+-servlet-api.jar
+-dependency3.jar
依賴(lài)項(xiàng)應(yīng)該放在嵌套的WEB-INF/lib
目錄中形导。嵌入式運(yùn)行時(shí)需要但部署到傳統(tǒng)web容器時(shí)不需要的任何依賴(lài)項(xiàng)都應(yīng)該放在WEB-INF/lib-provide
中环疼。
E.2 Spring Boot’s “JarFile” class
用于支持加載嵌套jar的核心類(lèi)是org.springframework.boot.loader.jar.JarFile
。它允許您加載標(biāo)準(zhǔn)jar文件或嵌套的jar文件朵耕。第一次加載時(shí)炫隶,每個(gè)JarEntry
的位置都被映射成外部jar的文件偏移量
myapp.jar
+-------------------+-------------------------+
| /BOOT-INF/classes | /BOOT-INF/lib/mylib.jar |
|+-----------------+||+-----------+----------+|
|| A.class ||| B.class | C.class ||
|+-----------------+||+-----------+----------+|
+-------------------+-------------------------+
^ ^ ^
0063 3452 3980
上面的例子展示了A。類(lèi)可以在myapp.jar
中的/BOOT-INF/classes
中找到相當(dāng)于myapp.jar
的0063文件偏移量的位置阎曹。B class 可以在myapp嵌套jar的3452文件偏移量中找到伪阶,C class 可以再3980位置找到。
有了這些信息处嫌,我們可以通過(guò)查找外部jar的適當(dāng)部分來(lái)加載特定的嵌套jar栅贴。我們不需要解壓歸檔文件,也不需要將所有條目數(shù)據(jù)讀入內(nèi)存熏迹。
E.2.1 與標(biāo)準(zhǔn)Java“JarFile”的兼容性
Spring引導(dǎo)加載程序努力保持與現(xiàn)有代碼和庫(kù)的兼容性筹误。org.springframework.boot.loader.jar.JarFile
是java.util.jar.JarFile
的擴(kuò)展。是可替換的癣缅。getURL()方法將返回一個(gè)URL厨剪,該URL打開(kāi)一個(gè)兼容java.net.JarURLConnection
的連接,可以與Java的URLClassLoader
一起使用友存。
E.3 啟動(dòng)可執(zhí)行jar
org.springframework.boot.loader.Launcher
啟動(dòng)器類(lèi)是一個(gè)特殊的引導(dǎo)類(lèi)祷膳,它用作一個(gè)可執(zhí)行jar主入口點(diǎn)。它是jar文件中實(shí)際的主類(lèi)屡立,用于設(shè)置適當(dāng)?shù)?code>URLClassLoader并最終調(diào)用main()方法直晨。
有3個(gè)啟動(dòng)器子類(lèi)(JarLauncher
, WarLauncher
和PropertiesLauncher
)。它們的目的是加載資源(.class文件等)從目錄中的嵌套jar文件或war文件(與類(lèi)路徑中的顯式文件相反)獲取膨俐。在JarLauncher
和WarLauncher
的情況下勇皇,嵌套路徑是固定的。JarLauncher
在BOOT-INF/lib/
,WarLauncher
在WEB-INF/lib/和WEB-INF/lib-provide/
中查找焚刺,所以如果您想要更多敛摘,只需在這些位置添加額外的jar即可。默認(rèn)情況下乳愉,PropertiesLauncher
會(huì)出現(xiàn)在應(yīng)用程序存檔中的BOOT-INF/lib/
中兄淫,您可以通過(guò)設(shè)置環(huán)境變量LOADER_PATH
或loader
來(lái)添加其他位置。
E.3.1 啟動(dòng)程序清單(Launcher manifest)
您需要指定一個(gè)適當(dāng)?shù)膯?dòng)程序作為META-INF/MANIFEST.MF的主類(lèi)屬性蔓姚。應(yīng)該在start類(lèi)屬性中指定要啟動(dòng)的實(shí)際類(lèi)(即您編寫(xiě)的包含main方法的類(lèi))捕虽。
例如,下面是一個(gè)典型的清單坡脐。MF為可執(zhí)行jar文件:
Main-Class: org.springframework.boot.loader.JarLauncher
Start-Class: com.mycompany.project.MyApplication
對(duì)于war文件泄私,它應(yīng)該是:
Main-Class: org.springframework.boot.loader.WarLauncher
Start-Class: com.mycompany.project.MyApplication
您不需要在清單文件中指定類(lèi)路徑項(xiàng),程序會(huì)自動(dòng)查找路徑备闲。
E.3.2 Exploded archives(歸檔文件)
某些PaaS實(shí)現(xiàn)可能選擇在運(yùn)行前解包存檔晌端。例如,你可以運(yùn)行一個(gè)解壓縮檔案浅役,只需啟動(dòng)適當(dāng)?shù)膯?dòng)器:
$ unzip -q myapp.jar
$ java org.springframework.boot.loader.JarLauncher
E.4 PropertiesLauncher特性
PropertiesLauncher has a few special features that can be enabled with external properties (System properties, environment variables, manifest entries or loader.properties).
PropertiesLauncher
支持從loader.properties
以及(由于歷史原因)application.properties加載屬性斩松。我們建議使用loader.properties
,作為對(duì)應(yīng)用程序的支持觉既。application.properties
已被棄用惧盹,將來(lái)可能會(huì)被刪除。
Key | Purpose |
---|---|
loader.path | 逗號(hào)分隔的類(lèi)路徑瞪讼,例如lib 钧椰、${HOME}/app/lib ,類(lèi)似 javac -classpath
|
loader.home | 用于解析loader.path 中的相對(duì)路徑。如裝載機(jī)符欠。loader.path=lib ${loader.home}/lib 是一個(gè)類(lèi)路徑位置(以及該目錄中的所有jar文件)嫡霞。也用于定位加載loader.properties 。示例/opt/app (默認(rèn)為${user.dir} )希柿。 |
loader.args | 主方法的默認(rèn)參數(shù)(以空格分隔) |
loader.main | 要啟動(dòng)的主類(lèi)的名稱(chēng)诊沪,例如com.app.Application
|
loader.config.name | 屬性文件的名稱(chēng)养筒,例如啟動(dòng)器(默認(rèn)為加載器)。 |
loader.config.location | 屬性文件的路徑端姚,例如類(lèi)路徑:loader晕粪。屬性(默認(rèn)為loader.properties)。 |
loader.system | 布爾標(biāo)志渐裸,指示應(yīng)將所有屬性添加到系統(tǒng)屬性中(默認(rèn)為false) |
當(dāng)指定為環(huán)境變量或清單項(xiàng)時(shí)巫湘,應(yīng)使用以下名稱(chēng):
Key Manifest | entry | Environment variable |
---|---|---|
loader.path | Loader-Path | LOADER_PATH |
loader.home | Loader-Home | LOADER_HOME |
loader.args | Loader-Args | LOADER_ARGS |
loader.main | Start-Class | LOADER_MAIN |
loader.config.location | Loader-Config-Location | LOADER_CONFIG_LOCATION |
loader.system | Loader-System | LOADER_SYSTEM |
構(gòu)建插件在構(gòu)建
fat jar
時(shí)自動(dòng)將Main-Class
屬性移動(dòng)到Start-Class
。如果您正在使用它昏鹃,請(qǐng)使用Main-Class
屬性指定要啟動(dòng)的類(lèi)的名稱(chēng)尚氛,并省略Start-Class
。
loader.properties
先在 loader.home
查找 然后在classpath根目錄查找, 最后是classpath:/BOOT-INF/classes
使用存在的第一個(gè)位置洞渤。
loader.home
只是一個(gè)附加屬性文件的目錄位置(覆蓋默認(rèn)值)阅嘶,只要load.config存在。沒(méi)有指定位置您宪。
loader.path
可以包含目錄(遞歸掃描jar和zip文件)奈懒、歸檔路徑、歸檔文件中掃描jar文件的目錄(例如宪巨,“dependensis .jar!/lib”)或通配符模式(默認(rèn)JVM行為)磷杏。存檔路徑可以相對(duì)于加載器。home捏卓,或者文件系統(tǒng)中具有jar:file:前綴的任何地方极祸。
loader.path
path(如果為空)默認(rèn)為BOOT-INF/lib(意味著從存檔文件運(yùn)行的本地目錄或嵌套目錄)。由于這個(gè)屬性怠晴,當(dāng)沒(méi)有提供額外配置時(shí)遥金,啟動(dòng)器的行為與JarLauncher相同。
loader.path
不能用于配置加載程序的位置蒜田。屬性(用于搜索后者的類(lèi)路徑是啟動(dòng)PropertiesLauncher時(shí)的JVM類(lèi)路徑)稿械。
占位符替換是在使用前從系統(tǒng)和環(huán)境變量以及所有值上的屬性文件本身進(jìn)行的。
屬性的搜索順序是env vars冲粤、系統(tǒng)屬性和loader(在多個(gè)位置查找是有意義的)美莫。屬性,分解的存檔清單梯捕,存檔清單厢呵。
E.5 可執(zhí)行jar的限制
在使用Spring引導(dǎo)加載程序打包的應(yīng)用程序時(shí),需要考慮許多限制傀顾。
E.5.1 Zip實(shí)體壓縮(Zip entry compression)
嵌套實(shí)體 ZipEntry
必須使用 ZipEntry.STORED
方法襟铭,這是必需的,以便我們可以直接查找嵌套jar中的各個(gè)內(nèi)容。嵌套jar文件本身的內(nèi)容仍然可以壓縮寒砖,外部jar中的其他entries也可以壓縮赐劣。
E.5.2 System ClassLoader
啟動(dòng)的應(yīng)用程序在加載類(lèi)時(shí)應(yīng)該使用Thread.getContextClassLoader()
(默認(rèn)情況下,大多數(shù)庫(kù)和框架都會(huì)這樣做)入撒。通過(guò)ClassLoader.getSystemClassLoader()
加載嵌套的jar類(lèi)將會(huì)失敗隆豹。請(qǐng)注意java.util.Logging
總是使用系統(tǒng)類(lèi)加載器,因此您應(yīng)該考慮不同的日志實(shí)現(xiàn)茅逮。
E.6 可選的fat jar 替代方案
如果上述限制意味著您不能使用Spring引導(dǎo)加載程序,可以考慮以下替代方案:
- Maven Shade Plugin
- JarClassLoader
- OneJar