三分鐘搞定maven插件

老鐵昨天下午問我何時講講Maven插件：java

因而老田搞到大半夜終於寫了一篇maven的插件，今天分享給你們。shell

想進一步詳聊了請加我微信tj20120622，進羣和你們一塊兒聊技術。apache

Maven 是一個執行插件的框架，每個任務其實是由插件完成的。那麼咱們今天就來聊聊Maven插件。api

什麼是Maven插件？

Maven 實際上只是Maven插件集合的核心框架。換句話說，插件是執行大部分實際操做的地方。微信

插件用於：框架

建立jar文件，
建立war文件，
編譯代碼，
單元測試代碼，
建立項目文檔等。

插件是Maven的核心功能，它容許在多個項目中重用通用的構建邏輯。他們經過在項目描述（項目對象模型（POM））的上下文中執行「操做」（即建立WAR文件或編譯單元測試）來實現此目的。能夠經過一組惟一的參數來自定義插件的行爲，這些參數經過每一個插件目標（或Mojo）的描述公開。maven

一個插件一般提供了一組目標，可以使用如下語法來執行：ide

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

例如：一個 Java 項目可使用 Maven 編譯器插件來編譯目標，經過運行如下命令編譯post

mvn compiler:compile

插件有哪些類型

Maven 提供如下兩種類型插件：單元測試

如下是一些常見的插件列表：

例如

咱們使用 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 命令。

mvn clean

Maven 將開始處理並顯示 clean 生命週期的 clean 階段。

[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 2020
[INFO] Final Memory: 4M/44M
[INFO] --------

上面的例子展現瞭如下關鍵概念：

插件是在 pom.xml 中使用 plugins 元素定義的。
每一個插件能夠有多個目標。
你能夠定義階段，插件會使用它的 phase 元素開始處理。咱們已經使用了 clean 階段。
你能夠經過綁定到插件的目標的方式來配置要執行的任務。咱們已經綁定了 echo 任務到 maven-antrun-plugin 的 run 目標。
就是這樣，Maven 將處理剩下的事情。它將下載本地倉庫中獲取不到的插件，並開始處理。

插件與目標

一個插件一般能夠完成多個任務，每個任務就叫作插件的一個目標。如執行mvn install命令時，調用的插件和執行的插件目標以下：

將插件綁定到生命週期

Maven的生命週期是抽象的，實際須要插件來完成任務，這一過程是經過將插件的目標（goal）綁定到生命週期的具體階段（phase）來完成的。如：將maven-compiler-plugin插件的compile目標綁定到default生命週期的compile階段，完成項目的源代碼編譯：

內置綁定

Maven對一些生命週期的階段（phase）默認綁定了插件目標，由於不一樣的項目有jar、war、pom等不一樣的打包方式，所以對應的有不一樣的綁定關係，其中針對default生命週期的jar包打包方式的綁定關係以下：

在第二列中，冒號前面是插件的前綴（prefix），是配置和使用插件的一種簡化方式；冒號後面便是綁定的插件目標。

你的倉庫中有哪些maven插件？

存放目錄=%本地倉庫%\org\apache\maven\plugins

Maven官網上有更詳細的官方插件列表：

自定義插件

在前面咱們提到了一個Mojo，Mojo其實是一個Maven的目標，插件包含任意數量的目標（Mojos）。Mojos能夠定義爲帶註釋的java類或Beanshell腳本。Mojo指定有關目標的元數據：目標名稱，它適合生命週期的哪一個階段，以及它指望的參數。

Mojo術語是在maven2中引入，它是對如何編寫插件的完整重寫。Mojo是對Pojo（plain-old-java-object）的一種改進，它將maven替換爲plain。

一個 Mojo 包含一個簡單的 Java 類。插件中多個相似 Mojo 的通用之處可使用抽象父類來封裝。Maven插件項目的打包方式packaging必須爲maven-plugin。

實現自定義插件

建立maven項目，添加依賴：

<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/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.tian.maven</groupId>
    <artifactId>my-maven-plugin</artifactId>
    <packaging>maven-plugin</packaging>
    <version>1.0-SNAPSHOT</version>
    <name>my-maven-plugin</name>
    <url>http://maven.apache.org</url>
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>3.8.1</version>
            <scope>test</scope>
        </dependency>
        <!--api依賴-->
        <dependency>
            <groupId>org.apache.maven</groupId>
            <artifactId>maven-plugin-api</artifactId>
            <version>3.0</version>
        </dependency>

        <!--註解支持-->
        <dependency>
            <groupId>org.apache.maven.plugin-tools</groupId>
            <artifactId>maven-plugin-annotations</artifactId>
            <version>3.4</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>
</project>

TianMojo繼承了 AbstractMojo 這個抽象類，並實現了 execute() 方法，該方法就是用來定義這個 Mojo 具體操做內容，咱們只須要根據本身的須要來編寫本身的實現便可。

//自定義插件類
//name就是後面使用該插件的時候excuation裏面的
@Mojo(name = "tian")
public class TianMojo extends AbstractMojo
{
    // 配置的是本maven插件的配置，在pom使用configration標籤進行配置 property就是名字，
    // 在配置裏面的標籤名字。在調用該插件的時候會看到，還能夠設置默認值
    @Parameter(property = "userName",defaultValue = "田哥你好")
    private String userName;
    @Parameter(property = "pwd",defaultValue = "000000")
    private String pwd;

    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        System.out.println("userm=" + userName + " pwd=" + pwd);
        System.out.println("my plugin is running");
    }
}

而後在執行mvn clean install命令。

使用自定義插件

在咱們的maven項目添加咱們自定義的插件：

<build>
    <plugins>
      <plugin>
        <groupId>com.tian.maven</groupId>
        <artifactId>my-maven-plugin</artifactId>
        <version>1.0-SNAPSHOT</version>
        <executions>
          <execution>
            <!-- 表示咱們在執行mvn install時候就會執行咱們自定義的插件tian-->  
            <phase>install</phase>
            <goals>
              <!-- 目標 -->
              <goal>tian</goal>
            </goals>
          </execution>
        </executions>
        <!-- 咱們自定義的Mojo中定義的屬性 -->
        <configuration>
          <userName>田維常</userName>
          <pwd>123456</pwd>
        </configuration>
      </plugin>
    </plugins>
</build>

而後就能夠在咱們的IDEA中看到：

雙擊my:tian：

還可使用命令的方式：mvn my:tian

my是前綴，是my-maven的縮寫。後綴tian就是插件綁定的目標。

到此，咱們的自定義Maven插件就搞定了。

總結

Maven插件是Maven的核心功能，插件類型有構建類型和報告類型，插件能夠有多個目標也就是能夠理解爲多個功能。自定義插件主要兩步：依賴相關jar包和重寫Mojo。自定義的插件的使用和咱們用其餘插件使用同樣，只要在pom中配置相關<plugin>配置便可。

只有真正理解了插件實現原理後，才能慢慢去體會猜想咱們平時使用的那些mvn...命令背後是如何實現的。

[ 學習是一我的對這個神奇世界不斷認識的一個過程]