文章目录有道无术,术尚可求,有术无道,止于术。
本系列Spring Boot版本2.7.0
- 简介
- Maven
- POM的层级关系
- 超级POM
- 父 POM
- 有效 POM
- 生命周期Lifecycle
- Maven 插件和目标
- Maven 命令
- Spring Boot插件打包为可执行JAR包
- 1. 添加插件
- 2. 打包
- 3. jar 包目录结构
- BOOT-INF
- META-INF
- org
可运行jar包是打jar包时,指定了main-class类,可以通过java -jar xxx.jar 命令,执行main-class的main方法,运行jar包。
普通jar包打包时,不用指定main-class,也不可运行。普通jar包可以供其它项目进行依赖。
Spring Boot Maven 插件提供了在Apache Maven中对Spring Boot 的支持,可以使用该插件将应用程序打包可执行 jar 包或 war包。
Maven为了更好的理解使用Spring Boot Maven 插件,首先我们简单回顾下Maven 中的相关知识。
POM的层级关系Maven 中的Pom 文件和Java 中的对象一样,也存在继承关系,可分为四层:
超级POM和JAVA 中的Object 类一样,是Maven的默认父级 POM,我们自己写的POM都直接或间接的继承了超级 POM。例如源文件存放的目录、测试源文件存放的目录、构建输出的目录……等等都在超级POM定义好了,这样等于有了默认的配置。
超级POM是在Maven 程序中定义的,我们可以找到Maven 的安装目录。
然后用压缩工具打开/lib/maven-model-builder-3.0.4.jar,按照下面的目录找到pom-4.0.0.xml,这个就是超级POM。
可以在超级POM中看到很多构建时的默认配置:
和 Java 类一样,POM 之间其实也是单继承的。如果我们给一个 POM 指定了父 POM,那么继承关系如下图所示:
有效 POM 英文翻译为 effective POM,在 POM 的继承关系中,子 POM 可以覆盖父 POM 中的配置。如果子 POM 没有覆盖,那么父 POM 中的配置将会被继承。按照这个规则,继承关系中的所有 POM 叠加到一起,就得到了一个最终生效的 POM。显然 Maven 实际运行过程中,执行构建操作就是按照这个最终生效的 POM 来运行的。这个最终生效的 POM 就是有效 POM,英文叫effective POM。
要查看有效 POM,可以在当前pom.xml目录,右键选择Open in Terminal。
输入mvn help:effective-pom命令,可以在当前控制台查看到当前生效POM,内容非常之多:
生命周期是Maven 构建的核心概念,Maven 设定了三个生命周期,生命周期中的每一个阶段对应构建过程中的一个操作:
- clean:项目清理。主要用于清理上一次构建产生的文件,可以理解为删除 target 目录。
- defalut:处理项目构建过程
- site: 项目站点文档创建。
每个生命周期中都包含着一系列的阶段(phase)。这些 phase 就相当于 Maven 提供的统一的接口,这些phase的实现由 Maven 的插件来完成。
官网说明
default生命周期负责项目构建包含以下阶段:
- validate- 验证项目是否正确并且所有必要的信息都可用
- compile- 编译项目的源代码
- test- 使用合适的单元测试框架测试编译的源代码。
- package- 获取已编译的代码并将其打包成可分发的格式,例如 JAR。
- verify- 对集成测试的结果进行任何检查,以确保满足质量标准
- install- 将包安装到本地存储库中,作为本地其他项目的依赖项
- deploy- 在构建环境中完成,将最终包复制到远程存储库以与其他开发人员和项目共享。
在IDEA 中,一个项目完全没有配置POM,也可在在右侧看到默认生命周期的这个阶段命令,可以直接点击来实现相关构建操作,这些阶段操作,是由Maven 默认插件完成的。
Maven 本质上是一个插件执行框架,所有工作都由插件完成,有构建和报告插件:
- 构建插件将在构建期间执行,它们应该在POM
元素中配置。 - 报告插件将在站点生成期间执行,它们应在POM 的
元素中进行配置。因为报告插件的结果是生成网站的一部分,所以报告插件应该是国际化和本地化的。
Maven 插件通常被用来:
-
创建 jar 文件
-
创建 war 文件
-
编译代码文件
-
代码单元测试
-
创建工程文档
-
创建工程报告
项目默认就携带了很多插件,我们可以在IDEA 中查看到每个插件的名称、机构、版本,可以直接点击插件选择对应的命令执行:
goal 目标是 Maven 中非常重要的概念。通常指的是Maven 插件的功能。Maven 插件有多个功能则存在多个 goal。
Maven的生命周期本身是不做任何实际工作, 任务执行均交由插件完成。其中每个构建步骤都可以绑定一个或多个插件的目标(目标也就是插件提供的功能),而且 Maven 为大多数构建步骤都编写并绑定了默认插件。当用户有特殊需要的时候,也可以配置插件定制构建行为,甚至自己编写插件。
生命周期的阶段phase与插件的目标 goal 相互绑定,用以完成实际的构建任务。而对于插件本身,为了能够复用代码,它往往能够完成多个任务,这些功能聚集在一个插件里,每个功能就是一个目标。
例如:$ mvn compiler:compile。冒号前部分是插件前缀,后面部分是该插件目标,即该命令的作用是执行maven-compiler-plugin 的 compile功能。
plugins 标签存放的是默认生命周期中实际会用到的插件,如下所示:
Maven 命令maven-compiler-plugin 3.1 default-compile compile compile default-testCompile test-compile testCompile 1.8 1.8 UTF-8
调用 Maven 插件的某个功能需要执行 Maven 命令,其命令格式如下:
mvn [plugin-name]:[goal-name]
该命令的意思是:执行· plugin-name· 插件的 ·goal-name ·目标(或者称为动作)。
用户可以通过两种方式调用 Maven 插件目标:
-
第一种方式是将插件目标与生命周期阶段绑定,这样用户在命令行只是输入生命周期阶段而已,例如 Maven 默认将 maven-compiler-plugin 的 compile 目标与 compile 生命周期阶段绑定,因此命令mvn compile 实际上是先定位到 compile 这一生命周期阶段,然后再根据绑定关系调用 maven-compiler-plugin 的 compile 目标。
-
第二种方式是直接在命令行指定要执行的插件目标,例如 mvn archetype:generate 就表示调用 maven-archetype-plugin 的 generate 目标,这种带冒号的调用方式与生命周期无关。
使用Spring Initializr构建项目时,会自动引入Spring Boot Maven 插件。
org.springframework.boot spring-boot-maven-plugin
引入之后,我们可以看到该插件的各个目标(功能)。
这些目标的功能如下:
| 功能名称 | 作用 |
|---|---|
| spring-boot:build-image | 使用构建包将应用程序打包成OCI镜像,比如Docker 镜像 |
| spring-boot:build-info | 生成一个build-info.properties文件,基于当前Maven 功能 |
| spring-boot:help | 在spring-boot-maven-plugin上显示帮助信息 |
| spring-boot:repackage | 重新打包现有的JAR和WAR包 |
| spring-boot:run | 就地运行应用程序 |
| spring-boot:start | 启动一个spring应用程序。 |
| spring-boot:stop | 停止由“启动”目标启动的应用程序。 |
在该插件中,最重要的功能就是repackage 了,因为Maven 自带的jar 包插件,只是一个普通的jar 包,并不能启动,这个时候就需要使用repackage 打包成一个可执行的jar 包,然后通过 java -jar直接启动jar 包。
1. 添加插件打包可执行文件,只需要添加如下即可,然后就可以通过 java -jar直接启动jar 包。
org.springframework.boot spring-boot-maven-plugin repackage
goal设置为repackage,表示将打包为执行行JAR 的功能(也就是目标)绑定到Maven 的生命周期,这样就可以直接通过Maven 的package 命令,打包为可执行的jar 包。
该插件执行属性重写,比如配置主启动类和打包文件格式:
${start.class} ZIP
可配置的参数如下表描述:
| 配置项 | 类型 | 作用 | 默认值 |
|---|---|---|---|
| attach | boolean | 将重新打包的归档文件附加到本地Maven存储库或部署到远程存储库。 | true |
| outputDirectory | File | 打包文件输出目录 | ${project.build.directory} |
| classifier | String | 要添加到重新打包存档的分类器。如果没有给出,则主工件将被重新打包的归档文件替换。如果给定,分类器还将用于确定要重新打包的源存档:如果具有该分类器的工件已经存在,则将其用作源并替换。如果不存在这样的工件,则主工件将用作源,重新打包的归档将作为该分类器的补充工件附加。 | |
| embeddedLaunchScript | File | 如果jar完全可执行,则将嵌入的启动脚本前置到jar的前面。如果未指定,将使用“Spring Boot”默认脚本。 | |
| embeddedLaunchScriptProperties | Properties | 应在嵌入式启动脚本中展开的属性。 | |
| excludeDevtools | boolean | 从重新打包的存档中排除 Spring Boot devtools。 | true |
| excludeGroupIds | String | 要排除的 groupId 名称的逗号分隔列表(完全匹配)。 | |
| excludes | List | 要排除的工件定义的集合。该Exclude元素定义了强制属性groupId和artifactId可选classifier属性。 | |
| executable | boolean | 为*nix机器创建一个完全可执行的jar,方法是在jar中预先添加一个启动脚本 目前,某些工具不接受此格式,因此您可能无法始终使用此技术。例如,jar-xf可能会悄悄地无法提取完全可执行的jar或war。建议您仅在打算直接执行此选项时启用此选项,而不是使用java-jar运行它或将其部署到servlet容器中。 | false |
| includeSystemScope | boolean | 包括系统范围的依赖项。 | false |
| includes | List | 要包含的工件定义的集合。该Include元素定义了强制groupId和artifactId属性以及可选的强制groupId和artifactId属性以及可选classifier属性。 | |
| layers | Layers | 层配置,带有禁用层创建、排除层工具 jar 和提供自定义层配置文件的选项。 | |
| layout | LayoutType | 存档的类型(对应于依赖项在其中的布局方式)。可能的值为JAR, WAR, ZIP, DIR, NONE。默认为基于存档类型的猜测。 | |
| layoutFactory | LayoutFactory | 如果未设置显式布局,将用于创建可执行存档的布局工厂。第三方可以提供替代布局实现。 | |
| mainClass | String | 主类的名称。main如果未指定,将使用找到的第一个包含方法的编译类。 | |
| outputTimestamp | String | 可重现的输出存档条目的时间戳,格式为 ISO 8601 ( yyyy-MM-dd’T’HH:mm:ssXXX) 或int表示自纪元以来的秒数。 | ${project.build.outputTimestamp} |
| requiresUnpack | List | 必须从胖罐子中解压才能运行的库列表。将每个库指定为带有 a和 a 的 a ,它们将在运行时解包。 | |
| skip | boolean | 跳过执行。 | false |
直接在右边执行打包命令即可。
打包成功后,我们使用jar -jar 命令启动:
使用压缩工具,我们可以看到有以下几个目录:
- BOOT-INF:包含应用程序的类和第三方依赖包
- META-INF:元数据文件
- org:Spring Boot 类加载
BOOT-INF包含的文件如下所示:
classes 包含了当前应用程序的字节码文件
lib 包含了该项目所需的第三方依赖包
META-INF是元数据目录
spring-configuration-metadata.json:可以作为application.properties的提示信息,可以设置其默认值。
MANIFEST.MF :定义了当前JAR包的相关规则属性,启动时会在该文件中获取需要的信息。
MANIFEST.MF 文件内容如下:
# 清单规范的版本 Manifest-Version: 1.0 # 项目名 Implementation-Title: spring-boot-study # 版本号 Implementation-Version: 0.0.1-SNAPSHOT # Archiver-Version: Plexus Archiver # 谁构建的 Built-By: Administrator # 包名 Implementation-Vendor-Id: org.pearl.boot # Spring Boot 版本 Spring-Boot-Version: 2.2.6.RELEASE # 主类 ,是当前JRA的启动类, 定义jar文件的入口类,该类必须是一个可执行的类,一旦定义了该属性即可通过 java -jar x.jar来运行该jar文件。 Main-Class: org.springframework.boot.loader.PropertiesLauncher # 启动类 Start-Class: org.pearl.boot.tstudy.SpringBootStudyApplication # 当前程序源码位置 Spring-Boot-Classes: BOOT-INF/classes/ # 依赖jar包位置 Spring-Boot-Lib: BOOT-INF/lib/ # Maven 版本 Created-By: Apache Maven 3.6.2 # JDK 版本 Build-Jdk: 1.8.0_151
maven :包含pom.xml和pom.properites文件
- pom.xml 是代表的整个项目引用的第三方jar的maven坐标
- pom.properites 是当前执行 package 命令后打包当前项目的版本信息
org目录下,可以看到就是一个spring boot 程序包,在Main-Class中指定的PropertiesLauncher类就在这里,这个放的其实就是spring-boot-loader模块包,我们能通过java -jar 启动,就是用它来实现的。
Spring Boot Loader提供了一套标准用于执行SpringBoot打包出来的jar。
java -jar启动大概流程就是:java -jar会去找jar中的MANIFEST.MF 文件,去找到Main-Class对应的真正的启动类org.springframework.boot.loader.PropertiesLauncher,PropertiesLauncher启动后会获取lib下面的所有jar包。根据这些jar包的url以及当前的ClassLoader创建一个URLClassLoader,启动一个新的线程RunThread,将上面创建的URLClassLoader设置为RunThread的classloader。在RunThread中先读取jar包中manifest的文件中得Start-Class,然后通过反射调用Start-Class的main方法,并把args传递过去,启动成功。



