maven插件开发及调试方法
2018-12-15 本文已影响0人
飞翔的猪宝宝
一、maven插件的开发:
1、首先随便创建一个maven工程。
2、然后在pom.xml文件中添加依赖:
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-plugin-api</artifactId>
<version>3.5.0</version>
</dependency>
<dependency>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
<version>3.5</version>
<scope>provided</scope>
</dependency>
这时还要添加一下打包方式:
<packaging>maven-plugin</packaging>
然后就可以随便创建一个类来继承AbstractMojo
类并重写execute()
方法就可以了。
@Mojo( name = "exportDataToFile")
public class WriteDataToFile extends AbstractMojo {
@Override
public void execute() throws MojoExecutionException, MojoFailureException {
...//要执行的代码
}
}
基本一个最简单的插件就写完了。
执行install
命令就可以将程序打成jar包并放入你说绑定的maven库了。
二、Maven插件的调试
以IntelliJ IDEA为例,通常我们调试项目时,都是直接点击 debug
调试按钮即可。但maven编写的插件就不同了,由于插件需要打包成Jar加载到项目中,所以如果我们需要在编写插件源码时调试的话,就不能直接点击调试按钮了(因为没有Main类),那么该怎么办呢?
这里提供一种简单解决办法:
假设及正在编写的maven插件A
拥有如下坐标:
<groupId>com.xx</groupId>
<artifactId>exportDataToFile</artifactId>
<version>1.0.0</version>
再假设你想将这个插件A
用在某个项目B
中,而项目B
中的pom.xml
是这样定义这个插件的:
<plugin>
<groupId>com.xx</groupId>
<artifactId>exportDataToFile</artifactId>
<version>1.0.0</version>
<executions>
<execution>
<id>exportDataToFile</id>
<phase>compile</phase>
<goals>
<goal>exportDataToFile</goal>
</goals>
</execution>
</executions>
</plugin>
其中,exportDataToFile
即为你要调试的目标的名字。
那么可以在Terminal中输入一下命令启动监听端口:
mvnDebug com.xx:exportDataToFile:1.0.0:exportDataToFile
可能到这时还是不知道这么做有什么用,好像和我们想做的事没什么关系,这里做完以上步骤后项目B
就不用再管了,这是我们要到开发插件A
的源代码中去打断点,什么意思?就是和正常项目一样在A中你要测试的地方打断点。
如下图,选中插件本身在鼠标右键debug运行就可以进入断点模式了:
如果实在是太小白,会发现自己这里没有自己要的插件的选项(这就尴尬了),那就在该项目pom.xml
文件中引入本身(要理解什么是插件,你引入的不是项目本身,而是编译打包后的jar包),实在不行就照着一下代码写就行了(可以百度一下各参数的含义):
<build>
<finalName>xx</finalName>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>
<plugin>
<groupId>com.xx</groupId>
<artifactId>exportDataToFile</artifactId>
<version>1.0.0</version>
<configuration>
<outDir>xxx.xxx.xxx</outDir>
<configFile>xxx.xxx.xxx</configFile>
</configuration>
</plugin>
</plugins>
</build>
最后调完不要忘记关闭B
项目的监听端口,快捷键Ctrl+C
行了。