【Maven】自定义插件（新建项目开始）：AbstractMojo，Mojo，pluginGroups，build，plugin，execution，phase，goals

一、前言

• 实际开发中很少会有开发插件的需求
• 只是通过此次开发更好地理解插件目标与生命周期阶段的关系

二、插件开发

2.1 创建项目

2.2 环境准备

• 根据个人情况修改项目的Maven配置
  

• 修改工程打包类型
  

<packaging>maven-plugin</packaging>

• 引入依赖

<!-- 提供AbstractMojo抽象类、允许文档注解 -->
<dependency>
	<groupId>org.apache.maven</groupId>
	<artifactId>maven-plugin-api</artifactId>
	<version>3.5.2</version>
</dependency>
<!-- 允许直接注解 -->
<dependency>
	<groupId>org.apache.maven.plugin-tools</groupId>
	<artifactId>maven-plugin-annotations</artifactId>
	<version>3.5.2</version>
</dependency>

2.3 插件目标开发

2.3.1 MyHelloPlugin：文档注解开发

package com.example.maven;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;

/**
 * @goal sayHello
 * 插件目标名称 sayHello
 */
public class MyHelloPlugin extends AbstractMojo {

    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        getLog().info("---> This is my first maven plugin. <---");
    }
}

2.3.2 MyPluginOfFistBlood：直接注解开发

package com.example.maven;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;

@Mojo(name = "firstBlood") //插件目标名称
public class MyPluginOfFistBlood extends AbstractMojo {
    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        getLog().info("---> first blood <---");
    }
}

2.4 插件安装

三、两种使用方式

3.1 命令行调用具体目标

• 修改settings.xml：在<pluginGroups>中添加新的插件groupId
• pluginGroup的作用：当在命令中使用插件，且未提供groupId时搜索pluginGroup列表。
  • 默认包含 org.apache.maven.plugins和org.codehaus.mojo

  <pluginGroups>
	<pluginGroup>com.example.maven</pluginGroup>
  </pluginGroups>

• 使用

mvn my:sayHello

3.1 生命周期调用绑定的目标

• 在使用自定义插件的项目的 pom.xml 中进行插件绑定：将插件目标与maven生命周期进行绑定
  • 插件已经安装到本地仓库的情况下，刷新Maven，插件依然报红。认为是IDEA识别问题。

   <build>
        <plugins>
            <plugin>
                <!-- 插件groupid -->
                <groupId>com.example.maven</groupId>
                <!-- 插件名称 -->
                <artifactId>my-maven-plugin</artifactId>
                <!-- 将插件目标与maven生命周期进行绑定 -->
                <executions>
                    <execution>
                        <id>hello</id>
                        <!-- 生命周期阶段 -->
                        <phase>validate</phase>
                        <!-- 要绑定的具体目标，可绑定多个 -->
                        <goals>
                            <goal>sayHello</goal>
                            <goal>firstBlood</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

• 使用