Spring Boot spring-boot-maven-plugin 參數配置詳解

一 spring-boot-maven-plugin 插件的5個Goals

spring-boot:repackage，默認goal。在mvn package之后，再次打包可執行的jar/war，同時保留mvn package生成的jar/war為.origin；重新打包存在的jar或者war包從而使他們可以在命令行使用jar -jar來執行，使用layout=NONE也可以簡單的打包有嵌套依賴的jar(沒有主類，所以無法執行)；它可以替代常規的構件或者連接到構建生命周期并有獨立的分級。

spring-boot:run，運行Spring Boot應用

spring-boot:start，在mvn integration-test階段，進行Spring Boot應用生命周期的管理；啟動Spring應用程序。和run目標不同，該目標不會阻塞，并且允許其他目標來操作應用程序。這個目標通常是在應用程序集成測試套件開始之前和停止之后的繼承測試腳本中使用；集成spring boot應用程序到集成測試階段，從而使應用程序在集成測試程序之前啟動

spring-boot:stop，在mvn integration-test階段，進行Spring Boot應用生命周期的管理；停止使用start目標啟動的spring應用程序，通常在測試套件完成后被調用。；集成spring boot應用程序到集成測試階段，從而使應用程序在集成測試程序之前啟動

spring-boot:build-info，生成Actuator使用的構建信息文件build-info.properties

2. 配置pom.xml文件

<build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><version>1.5.4.RELEASE</version></plugin></plugins>
</build>

二應用場景

1 重新打包應用

為了重新打包應用，只需要在pom文件中的plugin配置中如下：

<plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><executions><execution><goals><goal>repackage</goal></goals></execution></executions>
</plugin>

2 運行應用程序

插件包含了一個run目標，該目標能夠從命令行執行應用程序: mvn spring-boot:run

默認情況下，應用從Maven的JVM運行。如果需要在分支中運行，則指定fork選項。如果指定了jvmArguments或者agent參數，分支進程也會執行。

如果需要制定某些JVM參數(如為了debug)，可以使用jvmArguments參數，更多細節參考調試應用一章。方便起見，為了啟用總則(profiles)，可以使用特定(profiles)屬性來處理，參考指定使用的配置文件一章。

Spring Boot 1.3已經推出了devtools，它是提升使用Spring Boot應用開發時經驗的一個模塊。啟用該模塊，僅僅在項目中添加如下配置即可：

org.springframework.boot spring-boot-devtools 1.3.0.BUILD-SNAPSHOT true

目前最新是2.0.0.BUILD-SNAPSHOT了。

當devtools運行時，會在重新編譯應用時進行檢測變化并且自動刷新。這不僅包括資源文件，也包括代碼。它也提供了一個激活的可以重加在的服務器，所以不管任何改變都會自動出發瀏覽器刷新。

devtools也可配置成僅僅靜態資源改變時刷新瀏覽器(也就是忽略代碼的改變)，僅僅增加如下配置：

spring.devtools.remote.restart.enabled=false

在devtools之前，該插件已經默認支持資源的及時刷新(hot refreshing)，為了支持devtools功能，該插件功能已經被禁用。但是可以隨時恢復該功能，恢復功能配置如下；

<build>
……<plugins>……<plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><version>1.3.0.BUILD-SNAPSHOT</version><configuration><addResources>true</addResources></configuration></plugin>……</plugins>……
</build>

當啟用addResources配置時，任意src/main/resources文件夾在應用運行時將被添加到應用的類路徑，同時任意target/class中發現重復的資源將被移除。這將在發布web應用時使資源及時刷新非常有用。例如，當使用HTML，CSS和JavaScript文件時，不用重新編譯應用就可以立馬看到變化。這對前端開發人員不用下載安裝Java IDE就可以工作也是一種非常有用的方式。

需要注意的是，該特性的副作用是在構建時資源過濾不起作用

為了與repackage目標保持一致，run目標在構件類路徑下文件時將排除在配置依賴時排除的依賴配置。更詳細的的請參考排除一個依賴章節。

有時候在運行應用時包含測試依賴也是非常有用的。例如，在測試模式下使用根目錄類運行應用。如果希望這樣做，可以設置useTestClasspath參數的值為true。注意：盡在運行應用時生效：重新打包目標將不會增加測試依賴到結果jar和war包中。

3 使用集成測試

雖然可以很容易從測試(測試套件)本身啟動Spring Boot程序，但可能需要在構建自身來處理。為了確信圍繞集成測試的Spring Boot應用的生命周期被合適的管理，可以使用start和stop目標。如下配置：

<build>
……<plugins>……<plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><version>1.3.0.BUILD-SNAPSHOT</version><executions><execution><id>pre-integration-test</id><goals><goal>start</goal></goals></execution><execution><id>post-integration-test</id><goals><goal>stop</goal></goals></execution></executions></plugin>……</plugins>……
</build>

這樣的設置現在可以使用failsafe-plugin來運行你的集成測試，正如你所期待的哪樣。

更多詳細細節，參考隨機端口的集成測試的。

4 自定義分類重打包

默認情況下，repackage目標將使用可執行的構件來替代原始的構件。如果希望保留原是構件，并且也使用不同的分類來附屬保留可執行的構件，可以配置如下：

說明：如果不適用repackage目標，那么maven執行package命令生成的jar包只有一個，名稱為pom.xml里面配置的name(artifactId)-version.jar

如果加入了repackage配置，則maven打包生成的jar包會被重命名為name-version.jar.original,使用repackage重新打包生成的jar包名稱為name-version.jar,

下面的配置就是如果希望保留原始構件生成的jar包名稱不變，同時也想保留repackage打包生成的jar包，可以自定義命名。

<project><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><version>1.3.0.BUILD-SNAPSHOT</version><executions><execution><goals><goal>repackage</goal></goals><configuration><classifier>exec</classifier></configuration></execution></executions></plugin></plugins></build>
</project>

如上配置，那么使用repackage重新生成的包的名稱就是name-version-exec.jar,就是在version后面追加了configuration節點中的classifier節點中的值，該值是自定義的。但是如果classifier節點中什么值都不寫，那么就和默認的repackage配置一樣，即原始的構件為name-version.jar.original,repackage打包的jar為name-version.jar

5 排除依賴

默認情況下，repackage和run目標都會包含所有provided scope的依賴。基于boot的項目應該考慮provided scope的依賴就像容器所需要的依賴包來使應用可以運行。

**有三種方式可以排除運行時被打包使用的依賴
1、通過指定groupId和artifactId來排除依賴(如果需要可以指定classifier，這是可選的)
2、通過指定artifactId，來排除所有匹配的依賴
3、通過指定groupId，來排除所有屬于該group的依賴
如下通過指定groupId和artifactId排除依賴 **

<project><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><version>1.3.0.BUILD-SNAPSHOT</version><configuration><excludes><exclude><groupId>com.foo</groupId><artifactId>bar</artifactId></exclude></excludes></configuration></plugin></plugins></build>
</project>

如上配置就會排除對com.foo:bar的jar包

如下通過指定artifactId，來排除artifactId與此匹配的所有依賴

<project><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><version>1.3.0.BUILD-SNAPSHOT</version><configuration><excludeArtifactIds>my-lib,another-lib</excludeArtifactIds></configuration></plugin></plugins></build>
</project>

如上配置就會排除所有artifactId為my-lib和another-lib的jar包

如下通過指定groupId，來排除groupId與此匹配的所有依賴

<project><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><version>1.3.0.BUILD-SNAPSHOT</version><configuration><excludeGroupIds>com.foo</excludeGroupIds></configuration></plugin></plugins></build>
</project>

如上配置則排除掉所有groupId為com.foo的jar包

###6 調試應用

默認情況下，run目標和mvn命令是在同一個進程中執行的，除非jvm參數或者客戶端明確指定。可以通過使用fork屬性明確的開啟或者關閉是否在同一進程中執行。
如果需要fork這個進程并且進行調試，可以添加需要的JVM參數來開啟遠程調試。如下配置為掛起進程，直到有調試請求從5005端口進入。

<project><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><version>1.3.0.BUILD-SNAPSHOT</version><configuration><jvmArguments>-Xdebug -Xrunjdwp:transport=dt_sorket,server=y,suspend=y,address=5005
</jvmArguments></configuration></plugin></plugins></build>
</project>

需要注意的是，只要你指定了這些JVM參數，這個進程就會自動被fork。這些jvm擦書也可以在命令行中指定，確認書寫正確：

mvn spring-boot:run -Drun.jvmArguments=“-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005”

7 集成測試的隨機端口

Spring Boot集成測試的一個好特性是它能夠為Web應用分配一個空閑端口。當start目標插件使用時，Spring Boot應用是被分離執行的，這讓傳遞給集成測試程序本身實際的端口變得非常困難。

如下的配置展示如何使用build-help-plugin插件達到相同的特性。

<project><build><plugins><plugin><groupId>org.codehaus.mojo</groupId><artifactId>build-helper-maven-plugin</artifactId><executions><execution><id>reserve-tomcat-port</id><goals><goal>reserve-network-port</goal></goals><phase>process-resources</phase><configuration><portNames><portName>tomcat.http.port</portName></portNames></configuration></execution></executions></plugin><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><version>1.3.0.BUILD-SNAPSHOT</version><executions><execution><id>pre-integration-test</id><goals><goal>start</goal></goals><configuration><arguments><argument>--server.port={tomcat.http.port}</test.server.port></systemPropertyVariables></configuration></plugin></plugins></build>

現在可以在任意的集成測試中查詢test.server.port系統屬性來給server創建一個合適的url。

8 指定使用的配置文件

一個特定應用使用的配置文件可以通過profiles參數指定。如下配置啟動了foo和bar兩個配置文件：

<project><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><version>1.3.0.BUILD-SNAPSHOT</version><configuration><profiles><profile>foo</profile><profile>bar</profile></profiles></configuration></plugin></plugins></build>
</project>

使用哪個配置文件也可以通過命令行參數配置，如果有多個，需要使用都好將他們隔開：

mvn spring-boot:run -Drun.profiles=bar,foo