all-in-one jar
包。maven-jar-plugin
生成的包和spring-boot-maven-plugin
生成的包之間的直接區別,是fat jar
中主要增加了兩部分,第一部分是lib目錄,存放的是Maven依賴的jar包文件,第二部分是spring boot loader相關的類。
fat jar //目錄結構
├─BOOT-INF
│ ├─classes
│ └─lib
├─META-INF
│ ├─maven
│ ├─app.properties
│ ├─MANIFEST.MF
└─org
└─springframework
└─boot
└─loader
├─archive
├─data
├─jar
└─util
spring-boot-maven-plugin
工作機制,而spring-boot-maven-plugin
屬于自定義插件,因此我們又必須知道,Maven的自定義插件是如何工作的
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
</plugin>
org.springframework.boot.maven.RepackageMojo#execute
,該方法的主要邏輯是調用了org.springframework.boot.maven.RepackageMojo#repackage
private void repackage() throws MojoExecutionException {
//獲取使用maven-jar-plugin生成的jar,最終的命名將加上.orignal后綴
Artifact source = getSourceArtifact();
//最終文件,即Fat jar
File target = getTargetFile();
//獲取重新打包器,將重新打包成可執行jar文件
Repackager repackager = getRepackager(source.getFile());
//查找并過濾項目運行時依賴的jar
Set<Artifact> artifacts = filterDependencies(this.project.getArtifacts(),
getFilters(getAdditionalFilters()));
//將artifacts轉換成libraries
Libraries libraries = new ArtifactsLibraries(artifacts, this.requiresUnpack,
getLog());
try {
//提供Spring Boot啟動腳本
LaunchScript launchScript = getLaunchScript();
//執行重新打包邏輯,生成最后fat jar
repackager.repackage(target, libraries, launchScript);
}
catch (IOException ex) {
throw new MojoExecutionException(ex.getMessage(), ex);
}
//將source更新成 xxx.jar.orignal文件
updateArtifact(source, target, repackager.getBackupFile());
}
org.springframework.boot.maven.RepackageMojo#getRepackager
這個方法,知道Repackager是如何生成的,也就大致能夠推測出內在的打包邏輯。
private Repackager getRepackager(File source) {
Repackager repackager = new Repackager(source, this.layoutFactory);
repackager.addMainClassTimeoutWarningListener(
new LoggingMainClassTimeoutWarningListener());
//設置main class的名稱,如果不指定的話則會查找第一個包含main方法的類,repacke最后將會設置org.springframework.boot.loader.JarLauncher
repackager.setMainClass(this.mainClass);
if (this.layout != null) {
getLog().info("Layout: " + this.layout);
//重點關心下layout 最終返回了 org.springframework.boot.loader.tools.Layouts.Jar
repackager.setLayout(this.layout.layout());
}
return repackager;
}
/**
* Executable JAR layout.
*/
public static class Jar implements RepackagingLayout {
@Override
public String getLauncherClassName() {
return "org.springframework.boot.loader.JarLauncher";
}
@Override
public String getLibraryDestination(String libraryName, LibraryScope scope) {
return "BOOT-INF/lib/";
}
@Override
public String getClassesLocation() {
return "";
}
@Override
public String getRepackagedClassesLocation() {
return "BOOT-INF/classes/";
}
@Override
public boolean isExecutable() {
return true;
}
}
org.springframework.boot.loader.JarLauncher
,從名字推斷,這很可能是返回可執行jar文件的啟動類。
Manifest-Version: 1.0
Implementation-Title: oneday-auth-server
Implementation-Version: 1.0.0-SNAPSHOT
Archiver-Version: Plexus Archiver
Built-By: oneday
Implementation-Vendor-Id: com.oneday
Spring-Boot-Version: 2.1.3.RELEASE
Main-Class: org.springframework.boot.loader.JarLauncher
Start-Class: com.oneday.auth.Application
Spring-Boot-Classes: BOOT-INF/classes/
Spring-Boot-Lib: BOOT-INF/lib/
Created-By: Apache Maven 3.3.9
Build-Jdk: 1.8.0_171
MANIFEST.MF
文件為以上信息,可以看到兩個關鍵信息Main-Class
和Start-Class
。我們可以進一步,程序的啟動入口并不是我們SpringBoot中定義的main,而是JarLauncher#main
,而再在其中利用反射調用定義好的Start-Class
的main方法
java.util.jar.JarFile JDK
工具類提供的讀取jar文件
org.springframework.boot.loader.jar.JarFileSpringboot-loader
繼承JDK提供JarFile類
java.util.jar.JarEntryDK
工具類提供的jar文件條目
org.springframework.boot.loader.jar.JarEntry Springboot-loader
繼承JDK提供JarEntry類
org.springframework.boot.loader.archive.Archive
Springboot抽象出來的統一訪問資源的層
JarFileArchivejar
包文件的抽象ExplodedArchive
文件目錄JarFile
的作用,每個JarFileArchive
都會對應一個JarFile。在構造的時候會解析內部結構,去獲取jar包里的各個文件或文件夾類。我們可以看一下該類的注釋。
/* Extended variant of {@link java.util.jar.JarFile} that behaves in the same way but
* offers the following additional functionality.
* <ul>
* <li>A nested {@link JarFile} can be {@link #getNestedJarFile(ZipEntry) obtained} based
* on any directory entry.</li>
* <li>A nested {@link JarFile} can be {@link #getNestedJarFile(ZipEntry) obtained} for
* embedded JAR files (as long as their entry is not compressed).</li>
</ul>
**/
最基礎:Bootstrap ClassLoader
(加載JDK的/lib目錄下的類)
次基礎:Extension ClassLoader
(加載JDK的/lib/ext目錄下的類)
普通:Application ClassLoader
(程序自己classpath下的類)
ClassLoader
加載,就不能讓高層的ClassLoader
加載,這樣是為了范圍錯誤的引入了非JDK下但是類名一樣的類。LaunchedURLClassLoader
,該類繼承了java.net.URLClassLoader
,重寫了java.lang.ClassLoader#loadClass(java.lang.String, boolean)
,然后我們再探討他是如何修改雙親委派機制。LaunchedURLClassLoader
的構造方法。
public LaunchedURLClassLoader(URL[] urls, ClassLoader parent) {
super(urls, parent);
}
the URLs from which to load classes and resources
,即fat jar包依賴的所有類和資源,將該urls參數傳遞給父類java.net.URLClassLoader
,由父類的java.net.URLClassLoader#findClass
執行查找類方法,該類的查找來源即構造方法傳遞進來的urls參數。
//LaunchedURLClassLoader的實現
protected Class<?> loadClass(String name, boolean resolve)
throws ClassNotFoundException {
Handler.setUseFastConnectionExceptions(true);
try {
try {
//嘗試根據類名去定義類所在的包,即java.lang.Package,確保jar in jar里匹配的manifest能夠和關聯 //的package關聯起來
definePackageIfNecessary(name);
}
catch (IllegalArgumentException ex) {
// Tolerate race condition due to being parallel capable
if (getPackage(name) == null) {
// This should never happen as the IllegalArgumentException indicates
// that the package has already been defined and, therefore,
// getPackage(name) should not return null.
//這里異常表明,definePackageIfNecessary方法的作用實際上是預先過濾掉查找不到的包
throw new AssertionError("Package " + name + " has already been "
+ "defined but it could not be found");
}
}
return super.loadClass(name, resolve);
}
finally {
Handler.setUseFastConnectionExceptions(false);
}
}
super.loadClass(name, resolve)
實際上會回到了java.lang.ClassLoader#loadClass(java.lang.String, boolean)
,遵循雙親委派機制進行查找類,而Bootstrap ClassLoader和Extension ClassLoader將會查找不到fat jar依賴的類,最終會來到Application ClassLoader
,調用java.net.URLClassLoader#findClass
org.springframework.boot.loader.Launcher#launch(java.lang.String[], java.lang.String, java.lang.ClassLoader)
反射調用邏輯比較簡單,這里就不再分析,比較關鍵的一點是,在調用main方法之前,將當前線程的上下文類加載器設置成LaunchedURLClassLoader
protected void launch(String[] args, String mainClass, ClassLoader classLoader)
throws Exception {
Thread.currentThread().setContextClassLoader(classLoader);
createMainMethodRunner(mainClass, args, classLoader).run();
}
public static void main(String[] args) throws ClassNotFoundException, MalformedURLException {
JarFile.registerUrlProtocolHandler();
// 構造LaunchedURLClassLoader類加載器,這里使用了2個URL,分別對應jar包中依賴包spring-boot-loader和spring-boot,使用 "!/" 分開,需要org.springframework.boot.loader.jar.Handler處理器處理
LaunchedURLClassLoader classLoader = new LaunchedURLClassLoader(
new URL[] {
new URL("jar:file:/E:/IdeaProjects/oneday-auth/oneday-auth-server/target/oneday-auth-server-1.0.0-SNAPSHOT.jar!/BOOT-INF/lib/spring-boot-loader-1.2.3.RELEASE.jar!/")
, new URL("jar:file:/E:/IdeaProjects/oneday-auth/oneday-auth-server/target/oneday-auth-server-1.0.0-SNAPSHOT.jar!/BOOT-INF/lib/spring-boot-2.1.3.RELEASE.jar!/")
},
Application.class.getClassLoader());
// 加載類
// 這2個類都會在第二步本地查找中被找出(URLClassLoader的findClass方法)
classLoader.loadClass("org.springframework.boot.loader.JarLauncher");
classLoader.loadClass("org.springframework.boot.SpringApplication");
// 在第三步使用默認的加載順序在ApplicationClassLoader中被找出
classLoader.loadClass("org.springframework.boot.autoconfigure.web.DispatcherServletAutoConfiguration");
// SpringApplication.run(Application.class, args);
}
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-loader</artifactId>
<version>2.1.3.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>2.1.3.RELEASE</version>
</dependency>
對于源碼分析,這次的較大收獲則是不能一下子去追求弄懂源碼中的每一步代碼的邏輯,即便我知道該方法的作用。我們需要搞懂的是關鍵代碼,以及涉及到的知識點。
我從Maven的自定義插件開始進行追蹤,鞏固了對Maven的知識點,在這個過程中甚至了解到JDK對jar的讀取是有提供對應的工具類。最后最重要的知識點則是自定義類加載器。整個代碼下來并不是說代碼究竟有多優秀,而是要學習他因何而優秀。