自定义Maven插件
maven本质上就是一个插件框架,它的核心并不执行任何具体的构建任务,所有这些任务都交给插件来完成,例如编译源代码是由maven- compiler-plugin完成的。进一步说,每个任务对应了一个插件目标(goal),每个插件会有一个或者多个目标,例如maven- compiler-plugin的compile目标用来编译位于src/main/java/目录下的主源码,testCompile目标用来编译位于src/test/java/目录下的测试源码。
用户可以通过两种方式运行maven插件目标。第一种方式是直接运行命令,比如我们自定义插件test-maven-plugin,那么执行mvn test:run(run是插件中自行指定的名称),这种调用方式与生命周期没有关系。第二种方式是将插件目标与生命周期阶段绑定,用户在执行maven生命周期阶段运行我们的自定义插件,例如Maven默认将maven-compiler-plugin的compile目标与 compile生命周期阶段绑定,因此命令mvn compile实际上是先定位到compile这一生命周期阶段,然后再根据绑定关系调用maven-compiler-plugin的compile目标。
自定义插件
在项目中新建一个moudle作为插件。勾选Create from archetype,并选择maven-archetype-mojo。
填写插件信息,插件名一般取myname-maven-plugin,官方定义的取名为maven-name-plugin。
如果不是使用Idea自带maven的可以自行选择maven。
项目创建完成之后,我们还需要进入插件相关的依赖
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-plugin-api</artifactId>
<version>2.0</version>
</dependency>
<dependency>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
<version>3.1</version>
</dependency>
<dependency>
<groupId>org.codehaus.gmaven</groupId>
<artifactId>gmaven-mojo</artifactId>
<version>1.5-jenkins-3</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.2</version>
<scope>test</scope>
</dependency>
接下来我们就可以编写插件代码了,自定义一个类继承AbstractMojo,重写execute方法,execute就是我们插件需要运行的逻辑,最后需要在类上添加@Mojo,其中name就是我们需要运行时指定运行目标的名字。
@Mojo(name = "hello")
public class HelloMojo extends AbstractMojo {
public void execute() throws MojoExecutionException, MojoFailureException {
System.out.println("hello world,my plugin run...");
}
}
插件编写完成之后,需要执行mvn install进行安装就可以被其他项目引用使用了。
命令方式运行插件
在项目中引入自定义插件
<plugin>
<groupId>com.ssk</groupId>
<artifactId>ssk-maven-plugin</artifactId>
<version>1.0-SNAPSHOT</version>
</plugin>
在我们Idea右侧的插件栏中可以看到我们自定义的插件,点击可以直接运行插件命令,也可以通过mvn ssk:name,其中冒号前面的为插件的名,name与@Mojo中指定的goal name保持一致。
运行结果
绑定到Maven生命周期运行插件
将自定义插件绑定到Maven生命周期上,可以在支持生命周期的命令的时候,执行自定义插件。在引用自定义插件的项目中引入插件,goal为我们需要执行插件的名字,对应@Mojo中的name,phase标签为生命周期阶段,这里我们选择在compile阶段执行自定义插件。
<plugin>
<groupId>com.ssk</groupId>
<artifactId>ssk-maven-plugin</artifactId>
<version>1.0-SNAPSHOT</version>
<!-- 自定义插件处理时机 -->
<executions>
<execution>
<goals>
<goal>hello</goal>
</goals>
<phase>compile</phase>
</execution>
</executions>
</plugin>
执行mvn compile可以看到打印插件信息。
Maven Debug
我们在执行maven命令的时候出现异常,根据错误日志很难找到问题,这时候通过Debug就可以很清除的看到插件的运行情况。现在我们的插件代码中打上断点。如果是Debug别人的插件,可以根据报错的位置打上断点。
在正常使用mvn命令的后面加上debug就可以以Debug的方式运行了,并显示监听端口是8000,
在Configurations面板输入如下信息,Name自行定义,Port要与上面的端口号一致。
选中刚才选中的组件点击运行。
进入到我们设置断点的位置,接下来就可以按照正常的流程往下Debug了。