前言
在日常的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
发表回复