Maven 自定義插件

1. provide

插件提供者 項(xiàng)目結(jié)構(gòu)

├── pom.xml
├── src
│   └── main
│       ├── java
│       │   └── com
│       │       └── fantj
│       │           └── mypluginprovide
│       │               └── MyMojo.java
│       └── resources
│           └── application.properties
└── target
    │  
    └── my-plugin-provide-0.0.1-SNAPSHOT.jar

1.1 修改packaging
 <packaging>maven-plugin</packaging>
1.2. 修改pom
<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>
</dependency>

這兩個(gè)依賴是自定義插件必須的依賴卑硫,代表了它是一個(gè)Mojo工程蒙袍,里面包含了一些Mojo的接口和抽象類以及注解予弧。

1.3 coding業(yè)務(wù)邏輯
@Mojo(name = "fantj",defaultPhase = LifecyclePhase.PACKAGE)
public class MyMojo extends AbstractMojo {

    @Parameter
    private String msg;

    @Parameter
    private List<String> list;

    public void execute() throws MojoExecutionException, MojoFailureException {
        System.out.println("hello plugin: "+msg + "list: "+ list);
    }
}

注意這里面的@Parameter``@Mojo`` LifecyclePhase.PACKAGE都是org.apache.maven.plugins.annotations包下的:

import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;

@Parameter注解會(huì)獲取消費(fèi)者配置文件中的變量值并賦值媳瞪。

defaultPhase = LifecyclePhase.PACKAGE聲明了該插件觸發(fā)的生命周期幽污。

@Mojo定義插件的goal名字。

1.3. clean and install

執(zhí)行mvn clean install,在target目錄下會(huì)生成這樣一個(gè)jar包,這就是插件包。

2. consume

插件消費(fèi)者 : 項(xiàng)目結(jié)構(gòu)

├── pom.xml
└── src
    └── main
        ├── java
        │   └── com
        │       └── fantj
        │           └── mypluginuse
        └── resources
            └── application.properties
2.1 修改pom
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.fantj</groupId>
    <artifactId>my-plugin-consume</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <build>
        <plugins>
            <plugin>
                <groupId>com.fantj</groupId>
                <artifactId>my-plugin-provide</artifactId>
                <version>0.0.1-SNAPSHOT</version>
                <configuration>
                    <msg>hello plugin</msg>
                    <list>
                        <list>one</list>
                        <list>two</list>
                    </list>
                </configuration>

                <!--在執(zhí)行package時(shí)候自動(dòng)執(zhí)行自定義插件 將插件掛到 phase 中 -->
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>fantj</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

如果不加<executions>,我們只能通過執(zhí)行插件或者執(zhí)行命令的方式來執(zhí)行担平,如果想讓它在執(zhí)行package的時(shí)候自動(dòng)執(zhí)行,就需要設(shè)置該屬性,可以把它理解成hook锭部。

2.2 如何傳遞參數(shù)給plugin

在插件提供者中暂论,有個(gè)MyMojo的類,有這樣一段代碼:

    @Parameter
    private String msg;

    @Parameter
    private List<String> list;

它和你用過的spring注解一樣空免,也是用來以注解的形式獲取參數(shù)的值。

相對(duì)應(yīng)的盆耽,在插件消費(fèi)者的配置中我們就應(yīng)該相應(yīng)的給出參數(shù)的定義:

<configuration>
    <msg>hello plugin</msg>
    <list>
         <list>one</list>
         <list>two</list>
    </list>
</configuration>

上面的配置與變量名一一對(duì)應(yīng)即可蹋砚。這時(shí)候你會(huì)發(fā)現(xiàn)maven插件中自動(dòng)會(huì)添加一個(gè)plugins選項(xiàng):

執(zhí)行該插件:mvn myprovide:fantj 或者直接點(diǎn)擊

[fantj@lalala my-plugin-consume]$ mvn myprovide:fantj
[INFO] Scanning for projects...
[INFO] 
[INFO] --------------------< com.fantj:my-plugin-consume >---------------------
[INFO] Building my-plugin-consume 0.0.1-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- my-plugin-provide:0.0.1-SNAPSHOT:fantj (default-cli) @ my-plugin-consume ---
hello plugin: hello pluginlist: [one, two]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 0.347 s
[INFO] Finished at: 2018-11-01T19:59:04+08:00
[INFO] ------------------------------------------------------------------------
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末扼菠,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子坝咐,更是在濱河造成了極大的恐慌循榆,老刑警劉巖,帶你破解...
    沈念sama閱讀 221,273評(píng)論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件墨坚,死亡現(xiàn)場離奇詭異秧饮,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)泽篮,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,349評(píng)論 3 398
  • 文/潘曉璐 我一進(jìn)店門盗尸,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人帽撑,你說我怎么就攤上這事泼各。” “怎么了亏拉?”我有些...
    開封第一講書人閱讀 167,709評(píng)論 0 360
  • 文/不壞的土叔 我叫張陵扣蜻,是天一觀的道長。 經(jīng)常有香客問我及塘,道長莽使,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 59,520評(píng)論 1 296
  • 正文 為了忘掉前任笙僚,我火速辦了婚禮芳肌,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘味咳。我一直安慰自己庇勃,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,515評(píng)論 6 397
  • 文/花漫 我一把揭開白布槽驶。 她就那樣靜靜地躺著责嚷,像睡著了一般。 火紅的嫁衣襯著肌膚如雪掂铐。 梳的紋絲不亂的頭發(fā)上罕拂,一...
    開封第一講書人閱讀 52,158評(píng)論 1 308
  • 那天,我揣著相機(jī)與錄音全陨,去河邊找鬼爆班。 笑死,一個(gè)胖子當(dāng)著我的面吹牛辱姨,可吹牛的內(nèi)容都是我干的柿菩。 我是一名探鬼主播,決...
    沈念sama閱讀 40,755評(píng)論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼雨涛,長吁一口氣:“原來是場噩夢(mèng)啊……” “哼枢舶!你這毒婦竟也來了懦胞?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,660評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤凉泄,失蹤者是張志新(化名)和其女友劉穎躏尉,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體后众,經(jīng)...
    沈念sama閱讀 46,203評(píng)論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡胀糜,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,287評(píng)論 3 340
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了蒂誉。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片教藻。...
    茶點(diǎn)故事閱讀 40,427評(píng)論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖拗盒,靈堂內(nèi)的尸體忽然破棺而出怖竭,到底是詐尸還是另有隱情,我是刑警寧澤陡蝇,帶...
    沈念sama閱讀 36,122評(píng)論 5 349
  • 正文 年R本政府宣布痊臭,位于F島的核電站,受9級(jí)特大地震影響登夫,放射性物質(zhì)發(fā)生泄漏广匙。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,801評(píng)論 3 333
  • 文/蒙蒙 一恼策、第九天 我趴在偏房一處隱蔽的房頂上張望鸦致。 院中可真熱鬧,春花似錦涣楷、人聲如沸分唾。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,272評(píng)論 0 23
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽绽乔。三九已至,卻和暖如春碳褒,著一層夾襖步出監(jiān)牢的瞬間折砸,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,393評(píng)論 1 272
  • 我被黑心中介騙來泰國打工沙峻, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留睦授,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,808評(píng)論 3 376
  • 正文 我出身青樓摔寨,卻偏偏與公主長得像去枷,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,440評(píng)論 2 359

推薦閱讀更多精彩內(nèi)容

  • Maven編譯代碼的相關(guān)命令 第一删顶、main目錄下的主代碼編寫完畢后疗隶,使用Maven進(jìn)行編譯,在項(xiàng)目根目錄下運(yùn)行命...
    加油小杜閱讀 1,194評(píng)論 0 2
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理翼闹,服務(wù)發(fā)現(xiàn),斷路器蒋纬,智...
    卡卡羅2017閱讀 134,693評(píng)論 18 139
  • maven maven是一個(gè)跨平臺(tái)的項(xiàng)目管理的工具猎荠。隸屬于Apache下的一個(gè)開源項(xiàng)目。主要服務(wù)于Java平臺(tái)的項(xiàng)...
    jwfy閱讀 883評(píng)論 0 2
  • Maven作為一個(gè)優(yōu)秀的項(xiàng)目管理工具蜀备,其插件機(jī)制為其功能擴(kuò)展提供了非常大的便利性关摇。Maven本身提供了很多的插件。...
    Soclever閱讀 6,337評(píng)論 0 9
  • 簡介 概述 Maven 是一個(gè)項(xiàng)目管理和整合工具 Maven 為開發(fā)者提供了一套完整的構(gòu)建生命周期框架 Maven...
    閩越布衣閱讀 4,303評(píng)論 6 39