springboot maven 打包插件介绍及注意事项说明_java
2022-02-28
目录
springboot maven 打包插件介绍及注意事项
1. springboot项目默认生成的可执行jar，为什么不能作为依赖导入其他项目？
2. 有木有办法可以一次性获得可执行jar和依赖jar呢？
springboot打包插件详解（spring-boot-maven-plugin）
引入配置
新增后可以看Maven工具栏中有Plugins部分
看一下SpringBoot父工程的pom.xml中打包插件的配置
这个值可以通过设置属性layout来控制
具体layout值对应Main-Class关系如下
springboot maven 打包插件介绍及注意事项
1. springboot项目默认生成的可执行jar，为什么不能作为依赖导入其他项目？
Spring Boot 项目默认的插件是spring-boot-maven-plugin:
<plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin>
使用上面的插件会将项目A打包成一个可执行的jar 和一个.original文件如下：
可以看到，可执行的jar包比另一个original文件大多了，分别解压这两个文件，original文件去掉后缀重命名可解压：可执行jar打开如下：
original文件重命名后打开如下：
从这两张图片对比可以得知，可执行jar将项目的依赖都放进去了且目录和传统的jar包目录不同，多了一层BOOT-INF,因此这个jar包不能直接作为其他项目的依赖，不可执行jar没有把依赖打进去，和传统的jar包目录一致，因此去掉它的.original后缀可以作为其他项目的依赖。
2. 有木有办法可以一次性获得可执行jar和依赖jar呢？
官方当然也准备了，使用下面的插件即可：
<plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> <configuration> <classifier>exec</classifier> </configuration> </plugin>
打包结果：
遇到的问题
将上述A项目的依赖jar引入另一个项目B时，启动项目依旧报找不到相关依赖？
原因：
因为上述的依赖jar 并没有把A项目依赖的其他jar包给引进来，只是把A项目的代码给打成了jar包
解决办法：
将上述的A项目依赖jar安装到本地maven仓库或者公司的私服，然后在B项目通过maven引入，因为通过maven引入的方式，项目会自动去寻找依赖jar本身所需要引入的依赖。（推荐）将上述的A项目依赖jar直接放到B项目工程下，即springboot引入第三方jar的方式，这样引入后，还需要单独把A项目中用到的依赖，在B项目的pom文件单独再引入一下。采用下面的打包插件，在打A项目的依赖jar时，就把A项目需要的依赖全部一起打进去
将项目中所有依赖都打进依赖jar的打包插件
<plugin> <artifactId>maven-assembly-plugin</artifactId> <configuration> <appendAssemblyId>false</appendAssemblyId> <descriptorRefs> <descriptorRef>jar-with-dependencies</descriptorRef> </descriptorRefs> <archive> <manifest> <!-- 此处指定 main 方法入口的class --> <mainClass>com.libii.sso.LibiiSpringBootStartApplication</mainClass> </manifest> </archive> </configuration> <executions> <execution> <id>make-assembly</id> <phase>package</phase> <goals> <goal>single</goal> </goals> </execution> </executions> </plugin>
打包结果：
springboot打包插件详解（spring-boot-maven-plugin）
引入配置
<build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build>
新增后可以看Maven工具栏中有Plugins部分
build-info：生成项目的构建信息文件 build-info.propertiesrepackage：这个是默认 goal，在 mvn package 执行之后，这个命令再次打包生成可执行的 jar，同时将 mvn package 生成的 jar 重命名为 *.originrun：这个可以用来运行 Spring Boot 应用start：这个在 mvn integration-test 阶段，进行 Spring Boot 应用生命周期的管理stop：这个在 mvn integration-test 阶段，进行 Spring Boot 应用生命周期的管理
看一下SpringBoot父工程的pom.xml中打包插件的配置
发现父工程指定的是repackage [spring-boot-starter-parent pom.xml]
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
<configuration>
<mainClass>${start-class}</mainClass>
</configuration>
</plugin>
再看下打包结果内容中的MANIFEST.MF
Manifest-Version: 1.0
Implementation-Title: first-spring-boot-application
Implementation-Version: 1.0.0-SNAPSHOT
Built-By: weifei
Implementation-Vendor-Id: thinking-in-spring-boot
Spring-Boot-Version: 2.0.2.RELEASE
Main-Class: org.springframework.boot.loader.JarLauncher
Start-Class: thinking.in.spring.boot.App
Spring-Boot-Classes: BOOT-INF/classes/
Spring-Boot-Lib: BOOT-INF/lib/
Created-By: Apache Maven 3.5.2
Build-Jdk: 1.8.0_172-ea
Implementation-URL: http://maven.apache.org
发现Main-Class属性值为org.springframework.boot.loader.JarLauncher
这个值可以通过设置属性layout来控制
<plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> <configuration> <!--使用-Dloader.path需要在打包的时候增加<layout>ZIP</layout>，不指定的话-Dloader.path不生效--> <layout>ZIP</layout> <!-- 指定该jar包启动时的主类[建议] --> <mainClass>com.common.util.CommonUtilsApplication</mainClass> </configuration> <executions> <execution> <goals> <goal>repackage</goal> </goals> </execution> </executions> </plugin>
设置<layout>ZIP</layout>时Main-Class为org.springframework.boot.loader.PropertiesLauncher
具体layout值对应Main-Class关系如下
1.JAR，即通常的可执行jar
Main-Class: org.springframework.boot.loader.JarLauncher
2.WAR，即通常的可执行war，需要的servlet容器依赖位于WEB-INF/lib-provided
Main-Class: org.springframework.boot.loader.warLauncher
3.ZIP，即DIR，类似于JAR
Main-Class: org.springframework.boot.loader.PropertiesLauncher
4.MODULE，将所有的依赖库打包（scope为provided的除外），但是不打包Spring Boot的任何Launcher
5.NONE，将所有的依赖库打包，但是不打包Spring Boot的任何Launcher 之所以可以使用java -jar运行，和MANIFEST.MF文件里的配置关系密切
赠送知识点：
一般对使用spring-boot-maven-plugin插件打出的可执行jar不建议作为jar给其他服务引用，因为可能出现访问可执行jar中的一些配置文件找不到的问题。
如果想让构建出来的原始jar（没有引入插件相关的包并且没有更改MANIFEST.MF）不被重新打包（重新打包会引入spring-boot-maven-plugin定制的配置和jar包），可以对spring-boot-maven-plugin插件配置classifier属性，自定义一个可运行jar名称，这样该插件就不会对原始的jar重命名操作了。