springboot maven 打包插件介紹及注意事項(xiàng)

1. springboot項(xiàng)目默認(rèn)生成的可執(zhí)行jar，為什么不能作為依賴導(dǎo)入其他項(xiàng)目？

Spring Boot 項(xiàng)目默認(rèn)的插件是spring-boot-maven-plugin:

<plugin>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>

使用上面的插件會(huì)將項(xiàng)目A打包成一個(gè)可執(zhí)行的jar 和一個(gè).original文件如下：

可以看到，可執(zhí)行的jar包比另一個(gè)original文件大多了，分別解壓這兩個(gè)文件，original文件去掉后綴重命名可解壓：可執(zhí)行jar打開(kāi)如下：

original文件重命名后打開(kāi)如下：

從這兩張圖片對(duì)比可以得知，可執(zhí)行jar將項(xiàng)目的依賴都放進(jìn)去了且目錄和傳統(tǒng)的jar包目錄不同，多了一層BOOT-INF,因此這個(gè)jar包不能直接作為其他項(xiàng)目的依賴，不可執(zhí)行jar沒(méi)有把依賴打進(jìn)去，和傳統(tǒng)的jar包目錄一致，因此去掉它的.original后綴可以作為其他項(xiàng)目的依賴。

2. 有木有辦法可以一次性獲得可執(zhí)行jar和依賴jar呢？

官方當(dāng)然也準(zhǔn)備了，使用下面的插件即可：

 <plugin>
 <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-maven-plugin</artifactId>
     <configuration>
         <classifier>exec</classifier>
     </configuration>
 </plugin>

打包結(jié)果：

遇到的問(wèn)題

將上述A項(xiàng)目的依賴jar引入另一個(gè)項(xiàng)目B時(shí)，啟動(dòng)項(xiàng)目依舊報(bào)找不到相關(guān)依賴？

原因：

因?yàn)樯鲜龅囊蕾噅ar 并沒(méi)有把A項(xiàng)目依賴的其他jar包給引進(jìn)來(lái)，只是把A項(xiàng)目的代碼給打成了jar包

解決辦法：

將上述的A項(xiàng)目依賴jar安裝到本地maven倉(cāng)庫(kù)或者公司的私服，然后在B項(xiàng)目通過(guò)maven引入，因?yàn)橥ㄟ^(guò)maven引入的方式，項(xiàng)目會(huì)自動(dòng)去尋找依賴jar本身所需要引入的依賴。（推薦）將上述的A項(xiàng)目依賴jar直接放到B項(xiàng)目工程下，即springboot引入第三方j(luò)ar的方式，這樣引入后，還需要單獨(dú)把A項(xiàng)目中用到的依賴，在B項(xiàng)目的pom文件單獨(dú)再引入一下。采用下面的打包插件，在打A項(xiàng)目的依賴jar時(shí)，就把A項(xiàng)目需要的依賴全部一起打進(jìn)去

將項(xiàng)目中所有依賴都打進(jìn)依賴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>

打包結(jié)果：

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：生成項(xiàng)目的構(gòu)建信息文件 build-info.properties
• repackage：這個(gè)是默認(rèn) goal，在 mvn package 執(zhí)行之后，這個(gè)命令再次打包生成可執(zhí)行的 jar，同時(shí)將 mvn package 生成的 jar 重命名為 *.origin
• run：這個(gè)可以用來(lái)運(yùn)行 Spring Boot 應(yīng)用
• start：這個(gè)在 mvn integration-test 階段，進(jìn)行 Spring Boot 應(yīng)用生命周期的管理
• stop：這個(gè)在 mvn integration-test 階段，進(jìn)行 Spring Boot 應(yīng)用生命周期的管理

看一下SpringBoot父工程的pom.xml中打包插件的配置

發(fā)現(xiàn)父工程指定的是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>

再看下打包結(jié)果內(nèi)容中的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

發(fā)現(xiàn)Main-Class屬性值為org.springframework.boot.loader.JarLauncher

這個(gè)值可以通過(guò)設(shè)置屬性layout來(lái)控制

<plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <configuration>
        <!--使用-Dloader.path需要在打包的時(shí)候增加<layout>ZIP</layout>，不指定的話-Dloader.path不生效-->
        <layout>ZIP</layout>
        <!-- 指定該jar包啟動(dòng)時(shí)的主類[建議] -->
        <mainClass>com.common.util.CommonUtilsApplication</mainClass>
    </configuration>
    <executions>
        <execution>
            <goals>
                <goal>repackage</goal>
            </goals>
        </execution>
    </executions>
</plugin>

設(shè)置<layout>ZIP</layout>時(shí)Main-Class為org.springframework.boot.loader.PropertiesLauncher

具體layout值對(duì)應(yīng)Main-Class關(guān)系如下

1.JAR，即通常的可執(zhí)行jar

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

2.WAR，即通常的可執(zhí)行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，將所有的依賴庫(kù)打包（scope為provided的除外），但是不打包Spring Boot的任何Launcher

5.NONE，將所有的依賴庫(kù)打包，但是不打包Spring Boot的任何Launcher 之所以可以使用java -jar運(yùn)行，和MANIFEST.MF文件里的配置關(guān)系密切

贈(zèng)送知識(shí)點(diǎn)：

• 一般對(duì)使用spring-boot-maven-plugin插件打出的可執(zhí)行jar不建議作為jar給其他服務(wù)引用，因?yàn)榭赡艹霈F(xiàn)訪問(wèn)可執(zhí)行jar中的一些配置文件找不到的問(wèn)題。
• 如果想讓構(gòu)建出來(lái)的原始jar（沒(méi)有引入插件相關(guān)的包并且沒(méi)有更改MANIFEST.MF）不被重新打包（重新打包會(huì)引入spring-boot-maven-plugin定制的配置和jar包），可以對(duì)spring-boot-maven-plugin插件配置classifier屬性，自定義一個(gè)可運(yùn)行jar名稱，這樣該插件就不會(huì)對(duì)原始的jar重命名操作了。

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論