详解SpringBoot可执行Jar包运行原理

 更新时间:2023年05月22日 11:49:01   作者:鹤冲天Pro  
SpringBoot有一个很方便的功能就是可以将应用打成可执行的Jar,那么大家有没想过这个Jar是怎么运行起来的呢,本篇博客就来介绍下 SpringBoot可执行Jar包的运行原理,需要的朋友可以参考下

打可执行 Jar 包

将 Spring Boot 应用打成可执行 Ja r包很容易,只需要在 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 包。

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

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

简单总结

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

远程调试

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

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

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

step2:在 idea 中进行如下配置

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

以上就是详解SpringBoot可执行Jar包运行原理的详细内容,更多关于SpringBoot Jar包运行的资料请关注脚本之家其它相关文章!

相关文章

  • Java经典面试题最全汇总208道(一)

    Java经典面试题最全汇总208道(一)

    这篇文章主要介绍了Java经典面试题最全汇总208道(一),本文章内容详细,该模块分为了六个部分,本次为第一部分,需要的朋友可以参考下
    2023-01-01
  • Java C++题解leetcode816模糊坐标示例

    Java C++题解leetcode816模糊坐标示例

    这篇文章主要为大家介绍了Java C++题解leetcode816模糊坐标示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-01-01
  • Springboot常用方法参数注解示例详解

    Springboot常用方法参数注解示例详解

    这篇文章主要介绍了Springboot常用方法参数注解及示例,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-08-08
  • Java实现从jar包中读取指定文件的方法

    Java实现从jar包中读取指定文件的方法

    这篇文章主要介绍了Java实现从jar包中读取指定文件的方法,涉及java针对jar文件的读取及查找相关操作技巧,需要的朋友可以参考下
    2017-08-08
  • Java如何获取word文档的条目化内容

    Java如何获取word文档的条目化内容

    这篇文章主要介绍了Java获取word文档的条目化内容的相关知识,非常不错,具有一定的参考借鉴价值,需要的朋友参考下吧
    2018-05-05
  • Spring Cloud Gateway实现零拷贝参数校验的完整指南

    Spring Cloud Gateway实现零拷贝参数校验的完整指南

    本文将深入探讨在 Spring Cloud Gateway 中实现零拷贝参数校验的完整方案,从问题背景、设计思路到具体实现,提供可落地的实践指导,需要的朋友可以参考下
    2026-04-04
  • 解决springboot configuration processor对maven子模块不起作用的问题

    解决springboot configuration processor对maven子模块不起作用的问题

    这篇文章主要介绍了解决springboot configuration processor对maven子模块不起作用的问题,本文通过图文实例代码给大家讲解的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-09-09
  • Springboot @Configuration @bean注解作用解析

    Springboot @Configuration @bean注解作用解析

    这篇文章主要介绍了springboot @Configuration @bean注解作用解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-02-02
  • 使用Java编写一个文件批量重命名工具

    使用Java编写一个文件批量重命名工具

    这篇文章主要为大家详细介绍了如何使用Java编写一个文件批量重命名工具,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2024-12-12
  • springboot整合mybatisplus的方法详解

    springboot整合mybatisplus的方法详解

    这篇文章主要为大家详细介绍了springboot整合mybatisplus的方法,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-03-03

最新评论