聊聊如何自定义实现maven插件

前言

在日常的maven项目开发中,我们自己开发maven插件的机会是比较少,因为市面上的maven插件基本上就可以满足我们的日常开发需求。maven官方也提供了很多插件,详情可见如下链接

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

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

maven插件开发

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

java doc开发

这种可以直接利用maven自带的骨架

聊聊如何自定义实现maven插件_第1张图片
选中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 :唯一必须声明的标注,当用户命令行调用或在pom中配置插件是,需使用该目标名称,如果你在运行compiler:compile目标,compiler就是插件的goalPrefix,compile就是目标的名称

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

@requiresDependencyResolution :在运行mojo之前必须解析所有指定范围的依赖,如maven-surefire-plugin的test目标带有requiresDependencyResolution test标注,表示执行测试前,所有测试范围的依赖必须得到解析

@requiresProject :该目标是否必须在一个maven项目中运行(如测试插件用于测试其他项目),默认为true。大部分插件目标需依赖一个项目才能运行,但是,maven-help-plugin的system目标例外,它用来显示系统属性和环境变量信息,无需实际项目。

@requiresOnline :是否要求maven必须是在线状态,默认值为false

@requiresReport :是否要求项目报告已经生成,默认为false

@aggregator:当mojo在多模块项目上运行时,该标注表示目标只会在顶层模块运行。

@requiresDirectInvocation :为true时,该目标就只能通过命令行直接调用。默认为false

@execute goal="":在运行该目标之前,让maven运行另外一个目标。如果是本插件目标,则直接调用目标名称,否则,使用“prefix:goal”

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

@execute lifecycle="" 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引入

      
        org.apache.maven
        maven-plugin-api
        3.5.2
        provided
      

      
        org.apache.maven.plugin-tools
        maven-plugin-annotations
        3.5.2
        provided
      

  

注: 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生命周期的哪个阶段触发执行

插件可在如下阶段触发执行
聊聊如何自定义实现maven插件_第2张图片
@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文件中加上

 
         
             
                 org.apache.maven.plugins
                 maven-plugin-plugin
                 3.5
             
         
     

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

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

 
        
            
                com.github.lybgeek
                echo-maven-plugin
                1.0-SNAPSHOT
                
                    springboot-echo
                
                
                    
                        package
                        
                            echo
                        
                    
                
            
        
    

执行 mvn clean package

聊聊如何自定义实现maven插件_第3张图片

总结

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

你可能感兴趣的