可能很多初学者会比较困惑,Spring Boot 是如何做到将应用代码和所有的依赖打包成一个独立的 Jar 包,因为传统的 Java 项目打包成 Jar 包之后,需要通过 -classpath 属性来指定依赖,才能够运行。我们今天就来分析讲解一下 Spring Boot 的启动原理。
Spring Boot 打包插件
Spring Boot 提供了一个名叫 spring-boot-maven-plugin
的 maven 项目打包插件,可以方便的将 Spring Boot 项目打成 jar 包。这样我们就不再需要部署 Tomcat 、Jetty等之类的 Web 服务器容器啦。
我们先看一下 Spring Boot 打包后的结构是什么样的,打开 target 目录我们发现有两个jar包:
- hello-0.0.1-SNAPSHOT.jar:17.3MB
- hello-0.0.1-SNAPSHOT.jar.original:3KB
其中,hello-0.0.1-SNAPSHOT.jar 是通过 Spring Boot 提供的打包插件采用新的格式打成 Fat Jar,包含了所有的依赖;而 hello-0.0.1-SNAPSHOT.jar.original 则是Java原生的打包方式生成的,仅仅只包含了项目本身的内容。
SpringBoot FatJar 的组织结构
我们将 Spring Boot 打的可执行 Jar 展开后的结构如下所示:
.
├── BOOT-INF
│ ├── classes
│ │ ├── application.properties
│ │ └── com
│ │ └── javanorth
│ │ └── hello
│ │ └── HelloApplication.class
│ └── lib
│ ├── spring-boot-2.5.0.RELEASE.jar
│ ├── spring-boot-autoconfigure-2.5.0.RELEASE.jar
│ ├── spring-boot-configuration-processor-2.5.0.RELEASE.jar
│ ├── spring-boot-starter-2.5.0.RELEASE.jar
│ ├── ...
├── META-INF
│ ├── MANIFEST.MF
│ └── maven
│ └── com.javanorth
│ └── hello
│ ├── pom.properties
│ └── pom.xml
│
├── org
│ └── springframework
│ └── boot
│ └── loader
│ ├── ExecutableArchiveLauncher.class
│ ├── JarLauncher.class
│ ├── Launcher.class
│ ├── MainMethodRunner.class
│ ├── ...
- BOOT-INF目录:包含了我们的项目代码(classes目录),以及所需要的依赖(lib 目录)
- META-INF目录:通过 MANIFEST.MF 文件提供 Jar包的元数据,声明了 jar 的启动类
- org.springframework.boot.loader :Spring Boot 的加载器代码,实现的 Jar in Jar 加载的魔法源
我们看到,如果去掉BOOT-INF目录,这将是一个非常普通且标准的Jar包,包括元信息以及可执行的代码部分,其/META-INF/MAINFEST.MF指定了Jar包的启动元信息,org.springframework.boot.loader 执行对应的逻辑操作。
MAINFEST.MF 元信息分析
元信息内容如下所示:
Manifest-Version: 1.0
Created-By: Maven Jar Plugin 3.2.0
Build-Jdk-Spec: 11
Implementation-Title: hello
Implementation-Version: 0.0.1-SNAPSHOT
Main-Class: org.springframework.boot.loader.JarLauncher
Start-Class: com.javanorth.hello.HelloApplication
Spring-Boot-Version: 2.5.0
Spring-Boot-Classes: BOOT-INF/classes/
Spring-Boot-Lib: BOOT-INF/lib/
Spring-Boot-Classpath-Index: BOOT-INF/classpath.idx
Spring-Boot-Layers-Index: BOOT-INF/layers.idx
它相当于一个 Properties 配置文件,每一行都是一个配置项目。重点来看看两个配置项:
- Main-Class 配置项:Java 规定的 jar 包的启动类,这里设置为 spring-boot-loader 项目的 JarLauncher 类,进行 Spring Boot 应用的启动。
- Start-Class 配置项:Spring Boot 规定的主启动类,这里设置为我们定义的 Application 类。
- Spring-Boot-Classes 配置项:指定加载应用类的入口
- Spring-Boot-Lib 配置项: 指定加载应用依赖的库
启动原理
Spring Boot 的启动原理如下图所示:
源码分析
org.springframework.boot.loader.JarLauncher
JarLauncher
类是针对 Spring Boot jar 包的启动类, 完整的类图如下所示:
其中的 WarLauncher
类,是针对 Spring Boot war
包的启动类。启动类 org.springframework.boot.loader.JarLauncher
并非为项目中引入类,而是 spring-boot-maven-plugin
插件 repackage
追加进去的。接下来我们先来看一下 JarLauncher
的源码,比较简单,如下图所示:
public class JarLauncher extends ExecutableArchiveLauncher {
private static final String DEFAULT_CLASSPATH_INDEX_LOCATION = "BOOT-INF/classpath.idx";
static final EntryFilter NESTED_ARCHIVE_ENTRY_FILTER = (entry) -> {
if (entry.isDirectory()) {
return entry.getName().equals("BOOT-INF/classes/");
}
return entry.getName().startsWith("BOOT-INF/lib/");
};
public JarLauncher() {
}
protected JarLauncher(Archive archive) {
super(archive);
}
@Override
protected ClassPathIndexFile getClassPathIndex(Archive archive) throws IOException {
// Only needed for exploded archives, regular ones already have a defined order
if (archive instanceof ExplodedArchive) {
String location = getClassPathIndexFileLocation(archive)