文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

SpringBoot工程打包后执行Java -Jar就能启动的步骤原理

2023-05-20 09:02

关注

本文主要分享SpringBoot工程项目如何打包成一个可直接通过java -jar执行的jar,并且简单分析其启动步骤原理。

1.SpringBoot如何打包成一个可执行jar?

SpringBoot打包成成一个可执行jar需要依赖一个maven打包插件spring-boot-maven-plugin,如下所示在pom文件结尾的build节点添加依赖,同时将src/main/javasrc/main/resources打入jar里面。

 	<build>
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>***.*</include>
                </includes>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

此时再执行maven package打包成jar(最后打包完成在target目录下):

此时我们直接通过cmd控制台执行命令:java -jar boot-first-1.0.0-SNAPSHOT.jar 可以看到启动成功。

相关日志已经打印出来了,此时我们再通过postman验证一下编码中的接口是否生效:

程序中的接口代码如下:

2.SpringBoot打包成的jar为何可以直接Java -jar执行?

java程序的入口是main方法 ,如果一个jar能够通过java -jar执行起来,肯定离不开main方法。那springboot通过spring-boot-maven-plugin插件打包成的jar通常称为fat jar,里面不仅仅包含了程序代码还包括其他引用的依赖的jar。那这个fat jar的main方法入口在哪儿呢?我们通过解压该jar可以看到,在META-INF下的有一个MANIFEST.MF文件:

其中MANIFEST.MF中内容如下,其中比较重要的几行信息:

Start-Class: com.xren.bootfirst.BootFirstApplication ##程序开始类
Spring-Boot-Classes: BOOT-INF/classes/        ##加载的class
Spring-Boot-Lib: BOOT-INF/lib/   ##加载的内部jar位置
Main-Class: org.springframework.boot.loader.JarLauncher  ## boot启动类

综上可知,SpringBoot项目通过引入打包插件spring-boot-maven-plugin生成特定的主清单文件MANIFEST.MF,其中包含了程序的入口类和相关启动依赖。

3.一窥SpringBoot初启动

通用的jar包如果能被java -jar执行,只需要其MANIFEST.MF文件中有 Main-Class配置项即可。而此处SpringBoot的jar中的MANIFEST.MF文件里面不仅仅包含Main-Class 还有Start-Class、Spring-Boot-Classes、Spring-Boot-Lib等相关信息,那他们是如何运行的呢?我们还是要回到该jar主类org.springframework.boot.loader.JarLauncher来一窥究竟。

查看org.springframework.boot.loader.JarLauncher类需要pom引入spring-boot-loader,如下:

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

引入后其中JarLaunche类代码如下,它包含一个main方法,并且继承一个父类ExecutableArchiveLauncher。

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);
    }
    protected boolean isNestedArchive(Entry entry) {
        return entry.isDirectory() ? entry.getName().equals("BOOT-INF/classes/") : entry.getName().startsWith("BOOT-INF/lib/");
    }
    public static void main(String[] args) throws Exception {
        (new JarLauncher()).launch(args);
    }
}

从main方法进入我们需要关注一个launch方法,其中的三行

 protected void launch(String[] args) throws Exception {
        JarFile.registerUrlProtocolHandler();
        ClassLoader classLoader = this.createClassLoader(this.getClassPathArchives());
        this.launch(args, this.getMainClass(), classLoader);
    }

追寻this.getMainClass() 方法,其会指向上述的父类ExecutableArchiveLauncher中,此处就回到了我们开始说的Start-Class配置项。

protected String getMainClass() throws Exception {
        Manifest manifest = this.archive.getManifest();
        String mainClass = null;
        if (manifest != null) {
            mainClass = manifest.getMainAttributes().getValue("Start-Class");
        }
        if (mainClass == null) {
            throw new IllegalStateException("No 'Start-Class' manifest entry specified in " + this);
        } else {
            return mainClass;
        }
    }

getMainClass()方法中的this.archive.getManifest() 就是获取jar下的META-INF/MANIFEST.MF文件。此处追寻到Archive的子类ExplodedArchive中,如下代码获取清单文件:

 	private File getManifestFile(File root) {
        File metaInf = new File(root, "META-INF");
        return new File(metaInf, "MANIFEST.MF");
    }

到此时清单文件中的Start-Class、Spring-Boot-Classes、Spring-Boot-Lib都已找到,准备启动!
回到org.springframework.boot.loader.Launcher的launch方法。

protected void launch(String[] args, String mainClass, ClassLoader classLoader) throws Exception {
        Thread.currentThread().setContextClassLoader(classLoader);
        this.createMainMethodRunner(mainClass, args, classLoader).run();
    }

以上两行代码具体实现在org.springframework.boot.loader.MainMethodRunner类中,run方法即为最后的启动逻辑

public MainMethodRunner(String mainClass, String[] args) {
        this.mainClassName = mainClass;
        this.args = args != null ? (String[])args.clone() : null;
    }
    public void run() throws Exception {
        Class<?> mainClass = Thread.currentThread().getContextClassLoader().loadClass(this.mainClassName);
        Method mainMethod = mainClass.getDeclaredMethod("main", String[].class);
        mainMethod.invoke((Object)null, this.args);
    }

至此,从执行java -jar命令,SpringBoot打包的jar启动到程序中XXXApplication中的main方法这一阶段我们就初步分析完了!

总结:SpringBoot通过引入打包插件spring-boot-maven-plugin将其相关信息写入到java-jar的META-INF/MANIFEST.MF文件中,而后通过清单文件中的主入口Main-Class配置的org.springframework.boot.loader.JarLauncher类加载相关class、lib和应用程序主类Start-Class配置的XXXApplication类,再反射获取XXXApplication类中我们业务定义的main方法启动运行。

到此这篇关于SpringBoot工程打包后为何执行Java -Jar就能启动?的文章就介绍到这了,更多相关springboot打包执行ava -Jar启动内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯