目录

Spring Boot 可执行 Jar 包运行原理

简介

Spring Boot 有一个很方便的功能就是可以将应用打成可执行的 Jar。那么大家有没想过这个 Jar 是怎么运行起来的呢?本篇博客就来介绍下 Spring Boot 可执行 Jar 包的运行原理。

打可执行 Jar 包

将 Spring Boot 应用打成可执行 Jar包很容易,只需要在 pom 中加上一个 Spring Boot 提供的插件,然后在执行mvn package即可。

1
2
3
4
5
6
7
8
<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

**注意:**参数

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
<build>
<finalName>projectByMyself</finalName>
<plugins>
   <plugin>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-maven-plugin</artifactId>
      <version>2.0.1.RELEASE</version>
      <configuration>
         <mainClass>${start-class}</mainClass>
         <layout>ZIP</layout>
      </configuration>
      <executions>
         <execution>
            <goals>
               <goal>repackage</goal>
            </goals>
         </execution>
      </executions>
   </plugin>
</plugins>
</build>

finalName

1、设置了就会按照自己设定的名字作为包名

2、如果没有设置,打包后的包名为:artifactId与version拼接的结果

如下图:

./1.png

mainClass

${start-class} 其实就是项目的启动类,例如:com.myproject.PortalutilApplication

layout

1、JAR,即通常的可执行jar

Main-Class: org.springframework.boot.loader.JarLauncher

2、WAR,即通常的可执行war,需要的servlet容器依赖位于WEB-INF/lib-provided

Main-Class: org.springframework.boot.loader.warLauncher

3、ZIP,即DIR,类似于JAR

Main-Class: org.springframework.boot.loader.PropertiesLauncher

4、MODULE,将所有的依赖库打包(scope为provided的除外),但是不打包Spring Boot的任何Launcher

5、NONE,将所有的依赖库打包,但是不打包Spring Boot的任何Launcher

goals

如果你的项目没有继承spring-boot-starter-parent这个POM,你需要做如下配置,将目标绑定到repackage。

运行完mvn package后,我们会在 target 目录下看到两个 jar 文件。myproject-0.0.1-SNAPSHOT.jar 和 myproject-0.0.1-SNAPSHOT.jar.original。第一个 jar 文件就是我们应用的可执行 jar 包,第二个 Jar 文件是应用原始的 jar 包。

关于这个插件的详细使用,可以参考官网

可执行 Jar 包内部结构

将打出来的可执行 Jar 解压开我们能看到下面的结构:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
可执行 jar 目录结构
├─BOOT-INF
│  ├─classes
│  └─lib
├─META-INF
│  ├─maven
│  ├─app.properties
│  ├─MANIFEST.MF      
└─org
    └─springframework
        └─boot
            └─loader
                ├─archive
                ├─data
                ├─jar
                └─util

我们先来重点关注两个地方:META-INF 下面的 Jar 包描述文件和 BOOT-INF 这个目录。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Built-By: xxxx
Start-Class: com.xxxx.AppServer
Spring-Boot-Classes: BOOT-INF/classes/
Spring-Boot-Lib: BOOT-INF/lib/
Spring-Boot-Version: 2.1.6.RELEASE
Created-By: Apache Maven 3.3.9
Build-Jdk: 1.8.0_73
Main-Class: org.springframework.boot.loader.JarLauncher

在上面我们看到一个熟悉的配置Main-Class: org.springframework.boot.loader.JarLauncher。我们大概能猜到这个类是整个系统的入口。

再看下 BOOT-INF 这个目录下面,我们会发现里面是我们项目打出来的 class 文件和项目依赖的 Jar 包。看到这里,你可能已经猜到 Spring Boot 是怎么启动项目的了。

JarLauncher

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
public class JarLauncher extends ExecutableArchiveLauncher {

	static final String BOOT_INF_CLASSES = "BOOT-INF/classes/";

	static final String BOOT_INF_LIB = "BOOT-INF/lib/";

	public JarLauncher() {
	}

	protected JarLauncher(Archive archive) {
		super(archive);
	}

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

	public static void main(String[] args) throws Exception {
        //项目入口,重点在launch这个方法中
		new JarLauncher().launch(args);
	}

}
//launch方法
protected void launch(String[] args) throws Exception {
    JarFile.registerUrlProtocolHandler();
    //创建LaunchedURLClassLoader。如果根类加载器和扩展类加载器没有加载到某个类的话,就会通过LaunchedURLClassLoader这个加载器来加载类。这个加载器会从Boot-INF下面的class目录和lib目录下加载类。
    ClassLoader classLoader = createClassLoader(getClassPathArchives());
    //这个方法会读取jar描述文件中的Start-Class属性,然后通过反射调用到这个类的main方法。
    launch(args, getMainClass(), classLoader);
}

简单总结

  • Spring Boot 可执行 Jar 包的入口点是 JarLauncher 的 main 方法;
  • 这个方法的执行逻辑是先创建一个 LaunchedURLClassLoader,这个加载器加载类的逻辑是:先判断根类加载器和扩展类加载器能否加载到某个类,如果都加载不到就从 Boot-INF 下面的 class 和 lib 目录下去加载;
  • 读取Start-Class属性,通过反射机制调用启动类的 main 方法,这样就顺利调用到我们开发的 Spring Boot 主启动类的 main 方法了。

远程调试

这边介绍个调试 JarLauncher 启动的小技巧:IDEA 远程调试。

step1:我们以下面的方式启动我们的 Spring Boot 应用

1
 java -Xdebug -Xrunjdwp:transport=dt_socket,address=5005,server=y,suspend=y -jar App.jar

step2:在 idea 中进行如下配置

./2.png

然后点击下面的执行按钮执行即可:

./3.png