技術文章 » spring-boot-maven-plugin外掛詳解

spring-boot-maven-plugin外掛詳解

2023-06-25 06:00:40

一、 為什麼Spring Boot專案自帶這個外掛

當我們在SpringBoot官方下載一個腳手架時,會發現pom.xml會自帶spring-boot-maven-plugin外掛

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.7.12</version>
		<relativePath/>
	</parent>
	<groupId>com.zhuangpo</groupId>
	<artifactId>maven-plugin</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>maven-plugin</name>
	<properties>
		<java.version>1.8</java.version>
	</properties>
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
	</dependencies>

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

那為什麼會自帶這個外掛呢？

我們知道Spring Boot專案，是可以通過java -jar 包名啟動的

打包命令

mvn clean package

打包成功後就會生成一個jar包

試下是否可以通過java -jar 包名啟動專案

發現是可以正常啟動。

這個時候我們去掉spring-boot-maven-plugin外掛,通過 mvn clean package 再打一次包。

打包依然成功，包名也一樣，只是jar包大小有著天壤之別

發現只有3KB,之前的有17.7MB。

我們通過java -jar 包名看能否啟動成功。

localhost:target xub$ java -jar maven-plugin-0.0.1-SNAPSHOT.jar 
maven-plugin-0.0.1-SNAPSHOT.jar中沒有主清單屬性

發現並不能啟動成功，這是為什麼呢？

一般的maven專案的打包命令，不會把依賴的jar包也打包進去的，只是會放在jar包的同目錄下，能夠參照就可以了。

但是spring-boot-maven-plugin外掛，會將依賴的jar包全部打包進去。該檔案包含了所有的依賴和資原始檔，可以直接在命令列或者傳統的 Java Web 伺服器上啟動執行。


二、外掛介紹

1、外掛標籤詳解

  <!--使用的外掛列表 。 -->
            <plugins>
                <!--plugin元素包含描述外掛所需要的資訊。 -->
                <plugin>
                    <!--外掛在倉庫裡的group ID -->
                    <groupId />
                    <!--外掛在倉庫裡的artifact ID -->
                    <artifactId />
                    <!--被使用的外掛的版本（或版本範圍） -->
                    <version />
                    <!--是否從該外掛下載Maven擴充套件（例如打包和型別處理器），由於效能原因，只有在真需要下載時，該元素才被設定成enabled。 -->
                    <extensions />
                    <!--在構建生命週期中執行一組目標的設定。每個目標可能有不同的設定。 -->
                    <executions>
                        <!--execution元素包含了外掛執行需要的資訊 -->
                        <execution>
                            <!--執行目標的識別符號，用於標識構建過程中的目標，或者匹配繼承過程中需要合併的執行目標 -->
                            <id />
                            <!--繫結了目標的構建生命週期階段，如果省略，目標會被繫結到源資料裡設定的預設階段 -->
                            <phase />
                            <!--設定的執行目標 -->
                            <goals />
                            <!--設定是否被傳播到子POM -->
                            <inherited />
                            <!--作為DOM物件的設定 -->
                            <configuration />
                        </execution>
                    </executions>
                    <!--專案引入外掛所需要的額外依賴 -->
                    <dependencies>
                        <!--參見dependencies/dependency元素 -->
                        <dependency>
                            ......
                        </dependency>
                    </dependencies>
                    <!--任何設定是否被傳播到子專案 -->
                    <inherited />
                    <!--作為DOM物件的設定 -->
                    <configuration />
                </plugin>
            </plugins>

2、內部goals

該外掛提供了7個maven goal

  • build-image: 將程式使用 buildpack 打包進容器映象中。
  • build-info：生成專案的構建資訊檔案 build-info.properties
  • help：顯示幫助資訊。呼叫mvn spring-boot:help -Ddetail=true -Dgoal=以顯示引數詳細資訊。
  • repackage：可生成可執行的jar包或war包。外掛的核心goal。
  • run：執行 Spring Boot 應用
  • start：在整合測試階段，控制生命週期
  • stop：在整合測試階段，控制生命週期

為什麼這裡外掛名稱叫spring-boot？

原因:自定義外掛如果遵循 xxx-maven-plugin 的形式，maven 預設會將 maven-plugin 前面的內容作為外掛字首。


三、該外掛常見使用場景

1、排除provided型別的依賴

預設情況下,repackage命令所生成的包,會把專案中所有的依賴都打進去。

但其實在專案中scope為provided的依賴，比如 lombok、mybatis-plus等,只作用於編譯階段，編譯完成就沒用了。

若除去provided依賴，可以使用如下的設定：

 <plugin>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-maven-plugin</artifactId>
		<configuration>
			<excludes>
				<exclude>
				   <groupId>org.projectlombok</groupId>
				   <artifactId>lombok</artifactId>
				</exclude>
			</excludes>
		</configuration>
</plugin>

2、指定Mainclass類

如果未指定，main將使用找到的第一個包含方法的編譯類。

也就是說如果只有一個main方法，那不需要去指定，如果你這個模組存在兩個主類，那麼就需要在外掛中指定具體哪個啟動類了。

<plugin>
	   <groupId>org.springframework.boot</groupId>
	   <artifactId>spring-boot-maven-plugin</artifactId>
	   <configuration>
			    <mainClass>com.zhuangpo.mavenplugin.MavenPluginApplication</mainClass>
			    <layout>ZIP</layout>
	    </configuration>
</plugin>

layout 屬性用來指定打成 jar 還是war 檔案，可用的值包括：ZIP 、JAR 、WAR、 NONE 。預設JAR

3、在使用spring-boot-maven-plugin的下生成普通的jar包

前面說了，如果使用該外掛，那麼打出來的包是一個可執行的jar包，這樣的jar包，在被別的專案參照的時候，可能會出問題。

那如何打成一個普通的jar包。

當然你可以把這個外掛註釋掉，重新打包。不過這樣做未必太愚蠢啦。

解決辦法

第一種:通過命令

mvn clean package -D spring-boot.repackage.skip=true

加上-Dspring-boot.repackage.skip=true引數即可，此時只會生成一個普通的jar包

第二種：通過設定

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

這兩種方式打出來的包就是沒有依賴jar的普通包了。



宣告 : 公眾號如需轉載該篇文章,發表文章的頭部一定要 告知是轉至公眾號: 後端元宇宙。同時也可以問本人要markdown原稿和原圖片。其它情況一律禁止轉載！