浅析 SpringBoot FatJar 机制的设计与实现

大家好，我是石页兄

一、概述

SpringBoot FatJar 的设计，打破了标准 jar 的结构，在 jar 包内携带了其所依赖的 jar 包，通过在标准 jar 包中指定的 Main-Class 的 main 方法启动后，创建自己的类加载器，来识别、加载、运行其非规范的目录下的代码（BOOT-INF/classes/...）和依赖（BOOT-INF/lib/...）。BOOT-INF/classes/ 目录下有 SpringBoot 上下文的启动类的 class 文件，自定义类加载器加载这个启动类后，开始进入 SpringBoot 的上下文中运行我们所写的程序代码。执行的流程可概括为：

通过 java -jar xxx.jar 启动应用
执行 xxx.jar 中 META-INF/MANIFEST.MF 里 Main-Class 所指定的 JarLauncher 类的 main 方法
main 方法中创建自定义的 ClassLoader 即 LaunchedURLClassLoader，并将其设置为线程上下文类加载器
由 LaunchedURLClassLoader 加载 META-INF/MANIFEST.MF 里 Start-Class 所指定的 SpringBoot 应用的启动类（在 BOOT-INF/classes/目录下），调用其 main 方法，开始执行 SpringApplication.run(...)

二、标准的 jar 包结构

打开 Java 的 jar 文件我们经常可以看到文件中包含着一个META-INF目录，这个目录下会有一些文件，其中必有一个MANIFEST.MF，这个文件描述了该 Jar 文件的很多信息其中 Main-Class 定义 Jar 文件的入口类，该类必须是一个可执行的类，一旦定义了该属性即可通过 java -jar xxx.jar来运行该 jar 文件。

在生产环境中，是使用java -jar xxx.jar 的方式来运行 SpringBoot 程序。这种情况下，SpringBoot 应用真实的启动类并不是我们所定义的带有 main 方法的启动类，而是其内置的 JarLauncher 类。查看 SpringBoot 所打成的 fat jar，其 Main-Class 是org.springframework.boot.loader.JarLauncher，这便是微妙之处。

Spring-Boot-Version: 2.1.3.RELEASE
Main-Class: org.springframework.boot.loader.JarLauncher
Start-Class: com.rock.springbootlearn.SpringbootLearnApplication
Spring-Boot-Classes: BOOT-INF/classes/
Spring-Boot-Lib: BOOT-INF/lib/
Build-Jdk: 1.8.0_131

JAR 包中的 MANIFEST.MF 文件详解以及编写规范^[1]

三、探索 JarLauncher

org.springframework.boot.loader.JarLauncher这个类是哪里来的呢？答案在 spring-boot-loader-***.jar 包中，可找到这个 JarLauncher 类的源码。在项目中加入 maven 依赖，以便查看源码和远程调试。

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

认真比较可以看出，这个 spring-boot-loader 包中的内容与 SpringBoot 的 FatJar 包中的一部分内容几乎一样。JarLauncher 在 jar 中的位置如下:

3.1 只能拷贝出来一份儿

重点重点重点：因 jar 规范要求 Main-Class 所指定的类必须位于 jar 包的顶层目录下，即 org.springframework.boot.loader.JarLauncher 这个 org 必须位于 jar 包中的第一级目录，不能放置在其他的目录下。所以所以所以（重点）只能将 spring-boot-loader 这个 jar 包的内容拷贝出来，而不是整个 jar 直接放置于执行 Jar 中。

3.2 携带程序所依赖的 jar 而非仅 class

上边 JarLauncher 的这个 org.springframework.xx 以及 META-INF 这两个目录是符合 jar 包规范的。但是 BOOT-INF 这个目录里边有点像我们开发中的一些用法：

但按照 jar 包规范 jar 中不能有 jar 包的情况下

程序.class 文件在 classes 目录下

但 xxx.class 文件应该按照 org.springframework.xx 这样放置在 jar 中的根目录中

所以classes 和 lib 你也能意识到，这个设计是独特的。早期 jar 包内携带依赖是采用如 maven-shade-plugin 的做法，把依赖的 class 文件拷贝到目标 jar 中，但也会造成重名(全限定名)的类会出现覆盖的情况。后来 SpringBoot 为了避免提取覆盖的情况，修改了打包机制，放弃了maven-shade-plugin那种拷贝 class 的方式，调整为依赖原始 jar 包；这同时意味着改变了 jar 标准的运行机制，那么要想让classes和lib中代码能够正常运行，你试想一下如果没有自定义的类加载器来加载这些类文件，可以嘛？答案是：不可以，需要自定义类加载器。

四、自定义类加载器的运行机制

通常自定义类加载器完成资源加载的核心逻辑为：

指定资源
指定委托关系
指定线程上下文类加载器
调用逻辑入口方法

所以 SpringBoot FatJar 中自定义 ClassLoader 中的核心逻辑也是如此。

4.1 指定资源

构造方法中基于 jar 包的文件系统信息，构造 Archive 对象

public ExecutableArchiveLauncher() {
 this.archive = createArchive();
}

protected final Archive createArchive() throws Exception {
 ProtectionDomain protectionDomain = getClass().getProtectionDomain();
 CodeSource codeSource = protectionDomain.getCodeSource();
 URI location = (codeSource != null) ? codeSource.getLocation().toURI() : null;
 String path = (location != null) ? location.getSchemeSpecificPart() : null;
 if (path == null) {
  throw new IllegalStateException("Unable to determine code source archive");
 }
 File root = new File(path);
 if (!root.exists()) {
  throw new IllegalStateException(
    "Unable to determine code source archive from " + root);
 }
 return (root.isDirectory() ? new ExplodedArchive(root)
   : new JarFileArchive(root));
}

采集 jar 包中的 classes和lib目录下的归档文件。后边创建 ClassLoader 的时候作为参数传入

@Override
protected List<Archive> getClassPathArchives() throws Exception {
 List<Archive> archives = new ArrayList<>(
   this.archive.getNestedArchives(this::isNestedArchive));
 postProcessClassPathArchives(archives);
 return archives;
}

protected boolean isNestedArchive(Archive.Entry entry) {
 if (entry.isDirectory()) {
  return entry.getName().equals(BOOT_INF_CLASSES);
 }
 return entry.getName().startsWith(BOOT_INF_LIB);
}

4.2 创建自定义 ClassLoader

protected void launch(String[] args) throws Exception {
 JarFile.registerUrlProtocolHandler();
        //创建类加载器, 并指定归档文件
 ClassLoader classLoader = createClassLoader(getClassPathArchives());
 launch(args, getMainClass(), classLoader);
}
//创建类加载器, 将归档文件转换为URL
protected ClassLoader createClassLoader(List<Archive> archives) throws Exception {
 List<URL> urls = new ArrayList<>(archives.size());
 for (Archive archive : archives) {
  urls.add(archive.getUrl());
 }
 return createClassLoader(urls.toArray(new URL[0]));
}
//父加载器是AppClassLoader
protected ClassLoader createClassLoader(URL[] urls) throws Exception {
        //getClass().getClassLoader() 是系统类加载器,因为默认情况下main方法所在类是由SystemClassLoader加载的,默认情况下是AppClassLoader.
 return new LaunchedURLClassLoader(urls, getClass().getClassLoader());
}

4.3 设置线程上下文类加载器，调用程序中的 main 方法

public static void main(String[] args) throws Exception {
 new JarLauncher().launch(args);
}
protected void launch(String[] args, String mainClass, ClassLoader classLoader)
  throws Exception {
        //设置线程上下文类加载器
 Thread.currentThread().setContextClassLoader(classLoader);
 //调用MANIFEST.MF 中配置的Start-Class: xxx的main方法,还带入了参数
        createMainMethodRunner(mainClass, args, classLoader).run();
}

我是石页兄，如果这篇文章对您有帮助或启发的话，欢迎关注笔者微信公众号【架构染色】进行交流和学习

参考资料

JAR 包中的 MANIFEST.MF 文件详解以及编写规范: https://baike.baidu.com/item/MANIFEST.MF

浅析 SpringBoot FatJar 机制的设计与实现原创

一、概述

二、标准的 jar 包结构

三、探索 JarLauncher

3.1 只能拷贝出来一份儿

3.2 携带程序所依赖的 jar 而非仅 class

四、自定义类加载器的运行机制

4.1 指定资源

4.2 创建自定义 ClassLoader

4.3 设置线程上下文类加载器，调用程序中的 main 方法

参考资料

推荐阅读

本月精选性能专题

本月精选线上案例

本月精选原创好文

联系我们

网媒渠道

友情链接