MAVEN 自定義插件

文章目錄

• 快速開始
• • 建立第一個插件
  • • 0. 約束
    • 1. 添加依賴
    • 2. 建立插件類
    • 3. 打包使用
    • • 引用文件說明
• 參考資料

快速開始

建立第一個插件

0. 約束

在建立插件以前，MAVEN官網有個重要的約束，應該全部自定義插件的開發者都應該遵循此約束。

Apache Maven 維護的統一的命名約束爲：maven-<yourplugin>-plugin

用戶自定義插件命名約束：<yourplugin>-maven-plugin

因此在寫插件以前，請記住不要把請不要起maven開頭的名字

1. 添加依賴

首先建立一個Maven項目，在pom.xml中，添加如下依賴，並聲明打包方式爲packaging

更改打包方式

<packaging>maven-plugin</packaging>

添加依賴：

<!--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>

2. 建立插件類

自定義一個類型，並繼承這個抽象類：AbstractMojo便可。最後還要用@Mojo聲明一下，插件名(goal)。

GreetingMojo.java

@Mojo(name = "demo")
public class GreetingMojo extends AbstractMojo
{
    public void execute() throws MojoExecutionException, MojoFailureException {
        System.out.println("很簡單的demo");
    }
}

3. 打包使用

是的，就是這麼簡單，接下來就能夠打包使用了。

把插件打包到本地: mvn install

在另外的項目中引用該插件：

<build>
        <plugins>
            <plugin>
                <groupId>cn.wenhaha</groupId>
                <artifactId>demo-maven-plugin</artifactId>
                <version>1.0-SNAPSHOT</version>
                <executions>
                    <execution>
                        <phase>install</phase>
                        <goals>
                            <goal>demo</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

引用文件說明

<executions>
    <execution>
          <phase>install</phase>
          <goals>
              <goal>demo</goal>
          </goals>
      </execution>
  </executions>

這一塊可能比較陌生，其意表明在執行mvn install的時候，會自動執行goals裏的插件，即咱們剛剛寫的demo插件，具體相關能夠查閱MAVEN的生命週期，也能夠直接查看以前的一篇文章: 點我直達

參考資料

https://maven.apache.org/guides/plugin/guide-java-plugin-development.html