关于java:聊聊如何自定义实现maven插件

前言

在日常的 maven 我的项目开发中，咱们本人开发 maven 插件的机会是比拟少，因为市面上的 maven 插件基本上就能够满足咱们的日常开发需要。maven 官网也提供了很多插件，详情可见如下链接

https://maven.apache.org/plugins/index.html

明天次要是介绍一下开发一个 maven 插件的流程步骤

maven 插件开发

maven 插件开发有两种，一种是基于 java doc 开发，一种是基于注解开发

java doc 开发

这种能够间接利用 maven 自带的骨架

选中 maven-archetype-mojo 进行生成模板，生成的模板如下

/**
 * Goal which touches a timestamp file.
 *
 * @goal touch
 * 
 * @phase process-sources
 */
public class MyMojo
    extends AbstractMojo
{
    /**
     * Location of the file.
     * @parameter expression="${project.build.directory}"
     * @required
     */
    private File outputDirectory;

    public void execute()
        throws MojoExecutionException
    {
        File f = outputDirectory;

        if (!f.exists() )
        {f.mkdirs();
        }

        File touch = new File(f, "touch.txt");

        FileWriter w = null;
        try
        {w = new FileWriter( touch);

            w.write("touch.txt");
        }
        catch (IOException e)
        {throw new MojoExecutionException( "Error creating file" + touch, e);
        }
        finally
        {if ( w != null)
            {
                try
                {w.close();
                }
                catch (IOException e)
                {// ignore}
            }
        }
    }
}

这种按骨架傻瓜式生成，大家感兴趣的话，能够试下，这边就不再阐述。

附录： maven 文档开发罕用 doc 解释

每个 mojo 都必须应用 @Goal 标注来表明其指标名称，否则 maven 将无奈辨认该指标。还有其余很多标注，列举如下：

@goal <name>: 惟一必须申明的标注，当用户命令行调用或在 pom 中配置插件是，需应用该指标名称，如果你在运行 compiler:compile 指标，compiler 就是插件的 goalPrefix，compile 就是指标的名称

@phase <phase>: 默认将该指标绑定至 default 申明周期的某个阶段，这样在配置应用插件指标时，就无需申明 phase，如 maven-surefire-plugin 的 test 指标带有 @phase tes 标注

@requiresDependencyResolution <scope>: 在运行 mojo 之前必须解析所有指定范畴的依赖，如 maven-surefire-plugin 的 test 指标带有 requiresDependencyResolution test 标注，示意执行测试前，所有测试范畴的依赖必须失去解析

@requiresProject <true/false>: 该指标是否必须在一个 maven 我的项目中运行（如测试插件用于测试其余我的项目），默认为 true。大部分插件指标需依赖一个我的项目能力运行，然而，maven-help-plugin 的 system 指标例外，它用来显示零碎属性和环境变量信息，无需理论我的项目。

@requiresOnline <true/false>: 是否要求 maven 必须是在线状态，默认值为 false

@requiresReport <true/false>: 是否要求我的项目报告曾经生成，默认为 false

@aggregator: 当 mojo 在多模块我的项目上运行时，该标注示意指标只会在顶层模块运行。

@requiresDirectInvocation <true/false>: 为 true 时，该指标就只能通过命令行间接调用。默认为 false

@execute goal=”<goal>”: 在运行该指标之前，让 maven 运行另外一个指标。如果是本插件指标，则间接调用指标名称，否则，应用“prefix:goal”

@execute phase=”<phase>”: 在运行该指标前，让 maven 先运行一个并行的生命周期，到指定的阶段为止。到 phase 执行完，才执行插件指标

@execute lifecycle=”<lifecycle>” phase = “<phase>”: 在运行该指标前，让 maven 先运行一个自定义的生命周期，到指定的阶段为止。

parameters: 该元素形容 Mojo 的所有参数。name，type，required，editable（是否容许在 pom.xml 中设置），description, 如可应用 @parameter 将 mojo 的某个字段标注为可配置参数，即 mojo 参数。反对 boolean,int,float,String,Date,File,Url 数组,Collection,map,Propertes

configuration：为所有 Mojo 参数提供默认值

注 ：该解释取自博主 波波仔 86的博客
https://blog.csdn.net/bobozai86/article/details/106179288

注解开发

1、pom.xml 引入

<dependencies>
      <dependency>
        <groupId>org.apache.maven</groupId>
        <artifactId>maven-plugin-api</artifactId>
        <version>3.5.2</version>
        <scope>provided</scope>
      </dependency>

      <dependency>
        <groupId>org.apache.maven.plugin-tools</groupId>
        <artifactId>maven-plugin-annotations</artifactId>
        <version>3.5.2</version>
        <scope>provided</scope>
      </dependency>

  </dependencies>

注： pom 的 packaging 须要指定为 maven-plugin

2、编写插件类继承 org.apache.maven.plugin.AbstractMojo

@Mojo(name = "echo",defaultPhase = LifecyclePhase.PACKAGE)
public class EchoMojo extends AbstractMojo {


    @Parameter
    private String applicationName;

    public void execute() throws MojoExecutionException, MojoFailureException {getLog().info("echo-->" + applicationName);
    }
}

@Mojo 是通知 maven 这不是一个一般 java 类，而是一个 mojo 插件类，defaultPhase 这个是指定默认在 maven 生命周期的哪个阶段触发执行

插件可在如下阶段触发执行

@Parameter 这个性能的作用有两个

• It provides hooks to allow the user to adjust the operation of the plugin to suit their needs.
• It provides a means to easily extract the value of elements from the POM without the need to navigate the objects.

这段话来自官网，他的性能次要是它提供了钩子，容许用户调整插件的操作以满足他们的须要以及能够从 pom 文件中提取参数。这个参数失常能够从插件的 configration 标签中进行提取

3、将写好的插件装置到本地仓库

执行命令

mvn clean install

在执行的过程中，可能会报如下异样

org.apache.maven.plugins:maven-plugin-plugin:3.2:descriptor (default-descriptor)

其出错起因是因为没有指定 maven-plugin-plugin 版本，所以默认是 3.2，不适配以后代码，所以指定版本，在 pom 文件中加上

 <build>
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-plugin-plugin</artifactId>
                 <version>3.5</version>
             </plugin>
         </plugins>
     </build>

在我的项目中如何应用自定义的插件

以示例我的项目的插件为例，在 pom.xml 引入

 <build>
        <plugins>
            <plugin>
                <groupId>com.github.lybgeek</groupId>
                <artifactId>echo-maven-plugin</artifactId>
                <version>1.0-SNAPSHOT</version>
                <configuration>
                    <applicationName>springboot-echo</applicationName>
                </configuration>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>echo</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

执行 mvn clean package

总结

maven 插件能够看成是 maven 在执行生命周期阶段的钩子函数，如果咱们在要 maven 的执行编译、打包、装置、部署等阶段触发一些事件，咱们就能够思考实现一个 maven 插件。比方生成离线接口文档

其实官网也提供了很详尽开发 maven 插件的开发疏导，感兴趣的敌人，能够查看如下链接

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

demo 链接

https://github.com/lyb-geek/springboot-learning/tree/master/springboot-maven-plugin