Maven插件开发

Maven为我们提供了丰富的插件资源,使得开发调试过程中非常方便,可以满足大多数场景下的需求。当然有时候,我们也需要根据需求定制自己的插件。下面是在开发Maven插件时的一点备忘录,具体的开发流程请Google,有不少的教程,这里只是概述一下,同时记录一些容易掉坑的点。

1,Maven的工具由一个又一个的插件组成的,插件类继承了AbstractMojo类,需要覆写execute方法。getLog()获取的是AbstractMojo内部的log,类型是:org.apache.maven.plugin.logging.Log; 在Mojo的开发中,不要使用其他的Log基础设施。注: Mojo = Maven Old Java Object;

1
2
3
4
5
public class Example extends AbstractMojo{ 
    public void execute() throws MojoExecutionException, MojoFailureException { 
        getLog().info("Hello world"); 
    
}

2,pom.xml文件中,打包(packaging)类型应该为 maven-plugin,而不是war/jar。同时需要依赖的两个核心依赖是:
3,开发Maven插件和开发普通的Maven工程的流程是一样的,不同在于插件的 archetype应该设置为:maven-archetype-plugin;

  • maven-plugin-api:这是插件开发的api;
  • maven-plugin-annotations:这是进行插件注解的api。

4,插件的入口类为继承了AbstractMojo的实现类,但是需要进行注解。注解@Mojo是必须要的,这是定义插件对象的启动方法,由于该类只有一个方法,所以启动方法和启动类是一致的。在Maven 3之前是使用注释注解:@goal doSomething这种方式。现在已经不使用这种方式了。举个例子,如果进行如下标注:

1
2
3
4
@Mojo( name = "doSomething")
public class GreetingMojo extends AbstractMojo{
...
}

那么运行的时候使用如下方式执行:

1
mvn groupId:artifactId:version:doSomething  //如果一个项目中只有一个@Mojo标记,则verison可以省略

5,除了标注执行的方法,还可对成员变量进行标注,以便自动获取或由用户传入参数。

1
2
3
4
5
@Parameter( property = "greeting", defaultValue = "Hello World!" )   //这是由用户传入的参数,可以在命令行中由-D参数传入
private String greeting;
  
@Parameter( expression = "${project}", defaultValue = "${project}" )   //还可以使用表达式,引用Maven工程中定义好的变量
private String project;

6,每个Mojo(由@Mojo标注)都有生命周期,即该Mojo的执行时间。用户可以选择将某个插件目标绑定到生命周期的某个阶段,从而让构建过程更为完善。生命周期的具体介绍参考文末给出的文章。下面将插件配置到编译阶段执行:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<build>
    <plugins>
      <plugin>
        <groupId>sample.plugin</groupId>
        <artifactId>doSomething-maven-plugin</artifactId>
        <version>1.0-SNAPSHOT</version>
        <executions>
          <execution>
            <phase>compile</phase>
            <goals>
              <goal>doSomething</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
</build>

总体来说Maven插件的开发思路还是比较清晰的。

参考资料:

  1. Guide to Developing Java Plugins
  2. maven的生命周期和插件
  3. Maven生命周期以及插件详解

 

 
posted @   唐公子  阅读(2738)  评论(0编辑  收藏  举报
编辑推荐:
· .NET Core 中如何实现缓存的预热?
· 从 HTTP 原因短语缺失研究 HTTP/2 和 HTTP/3 的设计差异
· AI与.NET技术实操系列:向量存储与相似性搜索在 .NET 中的实现
· 基于Microsoft.Extensions.AI核心库实现RAG应用
· Linux系列:如何用heaptrack跟踪.NET程序的非托管内存泄露
阅读排行:
· TypeScript + Deepseek 打造卜卦网站:技术与玄学的结合
· 阿里巴巴 QwQ-32B真的超越了 DeepSeek R-1吗?
· 【译】Visual Studio 中新的强大生产力特性
· 【设计模式】告别冗长if-else语句:使用策略模式优化代码结构
· AI与.NET技术实操系列(六):基于图像分类模型对图像进行分类
点击右上角即可分享
微信分享提示