SpringBoot 系列-FatJar 启动原理

2020-03-02 10:09:31 浏览数 (1)

01

小伙伴们,大家好!从今天开始,我将持续更新磊叔的SpringBoot 系列文章,还请大家多多关注,多多转发,为我们开发者圈多分享些干货,在此谢过各位了!

本篇来介绍下在SpringBoot中,是如将一个FatJar运行起来的。

以下文章来源于磊叔授权分享,转载请注明出处,谢谢!

微信公众号:glmapper工作室

掘金专栏:glmapper

微 博:疯狂的石头_henu

欢迎关注,一起学习、一起分享

FatJar 解压之后的文件目录

从 Spring 官网 或者通过 Idea 创建一个新的 SpringBoot 工程,方便起见,建议什么依赖都不加,默认带入的空的 SpringBoot 工程即可。

通过 maven 命令进行打包,打包成功之后得到的构建产物截图如下:

前面的文章中有提到,jar 包是zip 包的一种变种,因此也可以通过 unzip 来解压

解压的 mock 目录,使用 tree 指令,看到整个解压之后的 FatJar 的目录结构如下(部分省略):

简单来看,FatJar 解压之后包括三个文件夹:

我们平时在 debug SpringBoot 工程的启动流程时,一般都是从 SpringApplication#run 方法开始

对于 java 程序来说,我们知道启动入口必须有 main 函数,这里看起来是符合条件的,但是有一点就是,通过 java 指令执行一个带有 main 函数的类时,是不需要有 -jar 参数的,比如新建一个 BootStrap.java 文件,内容为:

通过 javac 编译此文件:

然后就可以得到编译之后的 .class 文件 BootStrap.class ,此时可以通过 java 指令直接执行:

那么对于 java -jar 呢?这个其实在 java 的官方文档 中是有明确描述的:

  • -jar filename

Executes a program encapsulated in a JAR file. The filename argument is the name of a JAR file with a manifest that contains a line in the form Main-Class:classname that defines the class with the public static void main(String[] args) method that serves as your application’s starting point.

When you use the -jar option, the specified JAR file is the source of all user classes, and other class path settings are ignored.

简单说就是,java -jar 命令引导的具体启动类必须配置在 MANIFEST.MF 资源的 Main-Class 属性中。

那回过头再去看下之前打包好、解压之后的文件目录,找到 /META-INF/MANIFEST.MF 文件,看下元数据:

org.springframework.boot.loader.JarLauncher 类存放在 org/springframework/boot/loader 下面:

这样就基本理清楚了, FatJar 中,org.springframework.boot.loader 下面的类负责引导启动 SpringBoot 工程,作为入口,BOOT-INF 中存放业务代码和依赖,META-INF 下存在元数据描述。

JarLaunch - FatJar 的启动器

在分析 JarLaunch 之前,这里插一下,org.springframework.boot.loader 下的这些类是如何被打包在 FatJar 里面的

spring-boot-maven-plugin 打包 spring-boot-loader 过程

因为在新建的空的 SpringBoot 工程中并没有任何地方显示的引入或者编写相关的类。实际上,对于每个新建的 SpringBoot 工程,可以在其 pom.xml 文件中看到如下插件:

这个是 SpringBoot 官方提供的用于打包 FatJar 的插件,org.springframework.boot.loader 下的类其实就是通过这个插件打进去的;

下面是此插件将 loader 相关类打入 FatJar 的一个执行流程:

org.springframework.boot.maven#execute-> org.springframework.boot.maven#repackage -> org.springframework.boot.loader.tools.Repackager#repackage-> org.springframework.boot.loader.tools.Repackager#writeLoaderClasses-> org.springframework.boot.loader.tools.JarWriter#writeLoaderClasses

最终的执行方法就是下面这个方法,通过注释可以看出,该方法的作用就是将 spring-boot-loader 的classes 写入到 FatJar 中。

JarLaunch 基本原理

基于前面的分析,这里考虑一个问题,能否直接通过 java BootStrap 来直接运行 SpringBoot 工程呢?这样在不需要 -jar 参数和 JarLaunch 引导的情况下,直接使用最原始的 java 指令理论上是不是也可以,因为有 main 方法。

通过 java BootStrap 方式启动

BootStrap 类的如下:

编译之后,执行 java com.glmapper.bridge.boot.BootStrap,然后抛出异常了:

从异常堆栈来看,是因为找不到 SpringApplication 这个类;这里其实还是比较好理解的,BootStrap 类中引入了 SpringApplication,但是这个类是在 BOOT-INF/lib 下的,而 java 指令在启动时也没有指定 class path 。

这里不再赘述,通过 -classpath -Xbootclasspath 的方式尝试了下,貌似也不行,如果有通过 java 指令直接运行成功的,欢迎留言沟通。

通过 java JarLaunch 启动

再通过 java org.springframework.boot.loader.JarLauncher 方式启动,可以看到是可以的。

那这里基本可以猜到,JarLauncher 方式启动时,一定会通过某种方式将所需要依赖的 JAR 文件作为 BootStrap 的依赖引入进来。下面就来简单分析下 JarLauncher 启动时,作为启动引导类,它做了哪些事情。

基本原理分析

JarLaunch 类的定义如下:

通过代码,我们很明显可以看到几个关键的信息点:

  • BOOT_INF_CLASSESBOOT_INF_LIB 两个常量对应的是前面解压之后的两个文件目录
  • JarLaunch 中包含一个 main 函数,作为启动入口

但是单从 main 来看,只是构造了一个 JarLaunch 对象,然后执行其 launch 方法,并没有我们期望看到的构建所需依赖的地方。实际上这部分是在 JarLaunch 的父类 ExecutableArchiveLauncher 的构造函数中来完成的。

PS: 关于 Archive 的概念这里由于篇幅有限,不再展开说明。

通过上面构建了一个 Archive ,然后继续执行 launch 方法:

下面值需要关注下 getMainClass() 方法即可,这里就是获取 MENIFEST.MF 中指定的 Start-Class ,实际上就是我们的工程里面的 BootStrap 类:

最终是通过构建了一个 MainMethodRunner 实例对象,然后通过反射的方式调用了 BootStrap 类中的 main 方法:

小结

本文主要从 JarLaunch 的角度分析了下 SpringBoot 的启动方式,对常规 java 方式和 java -jar 等启动方式进行了简单的演示;同时简单阐述了下 JarLaunch 启动的基本工作原理。对于其中 构建 Archive 、自定义协议 Handler 等未做深入探究,后面也会针对相关点再做单独分析。

▐ 文章来源:glmapper工作室,转载请联系原作者,谢谢!

0 人点赞