springboot maven 打包插件介紹及註意事項說明

Posted on 2021-12-14 by WalkonNet

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圖片

可以看到，可執行的jar包比另一個original文件大多瞭，分別解壓這兩個文件，original文件去掉後綴重命名可解壓：可執行jar打開如下：

可執行jar解壓後圖片

original文件重命名後打開如下：

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>

打包結果：

包含所有依賴的jar圖片

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.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 應用生命周期的管理

看一下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重命名操作瞭。

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

springboot maven 打包插件介紹及註意事項說明

目錄