spring-boot-maven-plugin插件詳解

一、 爲什麼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原稿和原圖片。其它情況一律禁止轉載！