maven插件开发及调试方法

一、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行了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,884评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,347评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,435评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,509评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,611评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,837评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,987评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,730评论 0 267
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,194评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,525评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,664评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,334评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,944评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,764评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,997评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,389评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,554评论 2 349

推荐阅读更多精彩内容