SpringBoot 打包插件spring-boot-maven-plugin打包机制及内部结构分析

分手后的思念是犯贱 2023-09-30 15:43 16阅读 0赞

当下许多公司都会选择使用springboot作为服务应用开发框架，springboot框架提供了一套自己的打包机制，是通过spring-boot-maven-plugin插件来实现的。

#### 1、spring-boot-maven-plugin引入pom ####

对于新建的一个springboot项目来说，pom中会加入插件：

![img][]

通过idea可以看到maven中包含了spring-boot-maven-plugin插件：

![img][img 1]

功能说明：

*  build-info：生成项目的构建信息文件 build-info.properties
 *  repackage：这个是默认 goal，在 `mvn package` 执行之后，这个命令再次打包生成可执行的 jar，同时将 `mvn package` 生成的 jar 重命名为 `*.origin`
 *  run：这个可以用来运行 Spring Boot 应用
 *  start：这个在 `mvn integration-test` 阶段，进行 `Spring Boot` 应用生命周期的管理
 *  stop：这个在 `mvn integration-test` 阶段，进行 `Spring Boot` 应用生命周期的管理

spring-boot-maven-plugin插件默认在父工程sprint-boot-starter-parent中被指定为repackage，可以点击sprint-boot-starter-parent进入父pom进行查看，如下图：

![img][img 2]

如果需要设置其他属性，需要在当前应用的pom中进行设置。

#### 2、执行打包命令 ####

mvn clean package

或者通过开发工具如idea执行clean和package俩命令：

![img][img 3]

执行以上命令时会自动触发spring-boot-maven-plugin插件的repackage目标，完后可以在target目录下看到生成的jar，如下图：

![img][img 4]

这里可以看到生成了两个jar相关文件，其中common.jar是spring-boot-maven-plugin插件重新打包后生成的可执行jar，即可以通过java -jar common.jar命令启动。common.jar.original这个则是mvn package打包的原始jar，在spring-boot-maven-plugin插件repackage命令操作时重命名为xxx.original，这个是一个普通的jar，可以被引用在其他服务中。

#### 3、jar内部结构 ####

对这两个jar文件解压看看里面的结构差异：

**3.1 common.jar目录结构如下：**

![img][img 5]

其中BOOT-INF主要是一些启动信息，包含classes和lib文件，classes文件放的是项目里生成的字节文件class和配置文件，lib文件是项目所需要的jar依赖。

META-INF目录下主要是maven的一些元数据信息，MANIFEST.MF文件内容如下：

Manifest-Version: 1.0
    Implementation-Title: java-common-utils
    Implementation-Version: 0.0.1-SNAPSHOT
    Start-Class: com.common.util.CommonUtilsApplication
    Spring-Boot-Classes: BOOT-INF/classes/
    Spring-Boot-Lib: BOOT-INF/lib/
    Build-Jdk-Spec: 1.8
    Spring-Boot-Version: 2.1.9.RELEASE
    Created-By: Maven Archiver 3.4.0
    Main-Class: org.springframework.boot.loader.JarLauncher

其中Start-Class是项目的主程序入口，即main方法。Springboot-Boot-Classes和Spring-Boot-Lib指向的是生成的BOOT-INF下的对应位置。

Main-Class属性值为org.springframework.boot.loader.JarLauncher，这个值可以通过设置属性layout来控制，如下：

<plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
        <configuration>
            
            <layout>ZIP</layout>
            
            <mainClass>com.common.util.CommonUtilsApplication</mainClass>
        </configuration>
        <executions>
            <execution>
                <goals>
                    <goal>repackage</goal>
                </goals>
            </execution>
        </executions>
    </plugin>

设置ZIP时Main-Class为org.springframework.boot.loader.PropertiesLauncher，具体layout值对应Main-Class关系如下：

*  JAR，即通常的可执行jar

Main-Class: org.springframework.boot.loader.JarLauncher

*  WAR，即通常的可执行war，需要的servlet容器依赖位于WEB-INF/lib-provided

Main-Class: org.springframework.boot.loader.warLauncher

*  ZIP，即DIR，类似于JAR

Main-Class: org.springframework.boot.loader.PropertiesLauncher

*  MODULE，将所有的依赖库打包（scope为provided的除外），但是不打包Spring Boot的任何Launcher
 *  NONE，将所有的依赖库打包，但是不打包Spring Boot的任何Launcher

common.jar之所以可以使用java -jar运行，和MANIFEST.MF文件里的配置关系密切

**3.2 original jar包结构**

![img][img 6]

可以看到通过mvn package构建的jar是一个普通的jar,包含的都是项目的字节文件和一些配置文件，没有将项目依赖的第三方jar包含进来。再看下MANIFEST.MF文件：

Manifest-Version: 1.0
    Implementation-Title: java-common-utils
    Implementation-Version: 0.0.1-SNAPSHOT
    Build-Jdk-Spec: 1.8
    Created-By: Maven Archiver 3.4.0

其中没有包含Start-Class、Main-Class等信息，这个与可执行jar的该文件存在很多差异，而且目录结构也有很大差异。

一般对使用spring-boot-maven-plugin插件打出的可执行jar不建议作为jar给其他服务引用，因为可能出现访问可执行jar中的一些配置文件找不到的问题。如果想让构建出来的原始jar不被重新打包，可以对spring-boot-maven-plugin插件配置classifier属性，自定义一个可运行jar名称，这样该插件就不会对原始的jar重命名操作了。

<configuration>
        
        <mainClass>com.common.util.CommonUtilsApplication</mainClass>
        
        <classifier>myexec</classifier>
    </configuration>

效果如下：

![img][img 7]

以上是对spring-boot-maven-plugin插件的打包机制和jar包结构的一些分析。

[img]: https://img-blog.csdnimg.cn/img_convert/262edfea3545a984d05d850b19e8c839.png
[img 1]: https://img-blog.csdnimg.cn/img_convert/0272273e36018f763030411ba80094b0.png
[img 2]: https://img-blog.csdnimg.cn/img_convert/f868d165e884115c85b376b5a6e9287b.png
[img 3]: https://img-blog.csdnimg.cn/img_convert/52a8ba3e3772ec58f0dbd70282dddc55.png
[img 4]: https://img-blog.csdnimg.cn/img_convert/fd6783b2ddc37570b3d56542463511d7.png
[img 5]: https://img-blog.csdnimg.cn/img_convert/cf600db72fee173fcfb1ea619e463424.png
[img 6]: https://img-blog.csdnimg.cn/img_convert/82398cadf1ccddf62e45c0e35a6b0ec9.png
[img 7]: https://img-blog.csdnimg.cn/img_convert/47e60d952207a87dabe5d66e0c9091b0.png