Spring Boot可执行Jar包运行原理

2022-05-31 19:28:43

1. 打可执行Jar包
2. 可执行Jar包内部结构
3. JarLauncher
4. 简单总结
5. 远程调试
6. 公众号推荐

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

1. 打可执行Jar包

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

<build>

    <plugins>

        <plugin>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-maven-plugin</artifactId>

        </plugin>

    </plugins>

</build>

注意：

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

<plugin>

    <groupId>org.springframework.boot</groupId>

    <artifactId>spring-boot-maven-plugin</artifactId>

    <executions>

        <execution>

            <goals>

                <goal>repackage</goal>

            </goals>

        </execution>

    </executions>

</plugin>

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

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

2. 可执行Jar包内部结构

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

可执行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这个目录。

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是怎么启动项目的了。

3. JarLauncher

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);

}

4. 简单总结

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

5. 远程调试

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

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

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

step2：在idea中进行如下配置

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

6. 公众号推荐

欢迎大家关注我的个人公众号「程序员*之路」

码农公寓