Maven外掛


什麼是 Maven 的外掛?

Maven 是一個執行外掛的框架,每一個任務實際上是由外掛完成的。Maven 外掛通常用於:

  • 建立 jar 檔案

  • 建立 war 檔案 

  • 編譯程式碼檔案

  • 進行程式碼單元測試

  • 建立專案文件

  • 建立專案報告

一個外掛通常提供了一組目標,可使用以下語法來執行:

mvn [plugin-name]:[goal-name]

例如,一個 Java 專案可以使用 Maven 編譯器外掛來編譯目標,通過執行以下命令編譯

mvn compiler:compile

外掛型別

Maven 提供以下兩種型別外掛:

型別 描述
構建外掛 在生成過程中執行,並在 pom.xml 中的<build/> 元素進行組態
報告外掛 在網站生成期間執行,在 pom.xml 中的 <reporting/> 元素進行組態

以下是一些常見的外掛列表:

外掛 描述
clean 編譯後的清理目標,刪除目標目錄
compiler 編譯 Java 原始檔
surefile 執行JUnit單元測試,建立測試報告
jar 從當前專案構建 JAR 檔案
war 從當前專案構建 WAR 檔案
javadoc 產生用於該專案的 Javadoc
antrun 從構建所述的任何階段執行一組 Ant 任務

例子

我們使用 maven-antrun-plugin 外掛在例子中來在控制台列印資料。現在在 C:\MVN\project 檔案夾 建立一個 pom.xml 檔案,內容如下: 

<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
    http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.companyname.projectgroup</groupId>
<artifactId>project</artifactId>
<version>1.0</version>
<build>
<plugins>
   <plugin>
   <groupId>org.apache.maven.plugins</groupId>
   <artifactId>maven-antrun-plugin</artifactId>
   <version>1.1</version>
   <executions>
      <execution>
         <id>id.clean</id>
         <phase>clean</phase>
         <goals>
            <goal>run</goal>
         </goals>
         <configuration>
            <tasks>
               <echo>clean phase</echo>
            </tasks>
         </configuration>
      </execution>     
   </executions>
   </plugin>
</plugins>
</build>
</project>

接下來,開啟命令控制台,並轉到包含 pom.xml 的檔案夾並執行以下命令 mvn 命令。

C:\MVN\project>mvn clean

Maven 將開始處理並顯示清潔週期/階段,如下圖中輸出:

[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------
[INFO] Building Unnamed - com.companyname.projectgroup:project:jar:1.0
[INFO]    task-segment: [post-clean]
[INFO] ------------------------------------------------------------------
[INFO] [clean:clean {execution: default-clean}]
[INFO] [antrun:run {execution: id.clean}]
[INFO] Executing tasks
     [echo] clean phase
[INFO] Executed tasks
[INFO] ------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------
[INFO] Total time: < 1 second
[INFO] Finished at: Sat Jul 07 13:38:59 IST 2012
[INFO] Final Memory: 4M/44M
[INFO] ------------------------------------------------------------------

上面的例子說明了以下關鍵概念:

  • 外掛可在 pom.xml 使用的 plugin 元素來指定; 

  • 每個外掛可以有多個目標;

  • 從外掛應使用它的相位元素開始處理定義階段。這裡已經使用 clean 階段;

  • 可以通過將它們系結到外掛的目標來執行組態任務。這裡已經系結 echo 任務到 maven-antrun-plugin 的執行目標;

  • 就這樣,Maven將處理其餘部分。如果沒有可用的本地儲存庫,它會下載這個外掛;