使用Gradle編譯Java工程之自定義Task類型篇

文章目的

本章中我們將會學(xué)習(xí)到如何自定義任務(wù)(Task)的類型,了解Gradle是怎么增強任務(wù)的功能的仅仆。

需要準(zhǔn)備

  • 一個熟悉的IDE開發(fā)工具
  • JDK 7及以上
  • Gradle 3.2以上

Gradle的兩種任務(wù)類型

在上一章中(http://www.reibang.com/p/a41769bf5118)漓踢, 我們介紹了任務(wù)(Task)的一些高級用法惰匙,知道了Gradle對任務(wù)的功能增強很多既峡,那么它是具體如何做到的呢?在揭曉答案之前狠怨,我們先來看看Gradle都支持哪兩種類型的任務(wù)吧。
第一種為簡單任務(wù)類型邑遏,就是我們在之前一篇文章中介紹的(http://www.reibang.com/p/a7b947c86650)取董, 它的行為是定義在一個動作閉包方法中的, 這種簡單類型的任務(wù)適合在一個編譯腳本中實現(xiàn)一種功能无宿。而第二種為增強的任務(wù)類型茵汰,它的行為被提前構(gòu)建在了任務(wù)里,只是提供一些配置屬性讓我們?nèi)ピO(shè)置孽鸡,這種任務(wù)可以在不的地方或不同的編譯腳本中被重復(fù)使用蹂午,它正是我們上一章中介紹的任務(wù)類型。

這種高級的增強的任務(wù)類型是通過定義一個任務(wù)類來實現(xiàn)的彬碱,在Gradle中我們也可以自定義自己的增強類型類豆胸,我們可以使用多種語言來實現(xiàn),比如java巷疼、scala等晚胡。不過Gradle本身是使用Groovy語言實現(xiàn)的,所以我在這里選擇使用Groovy語言來實現(xiàn)嚼沿。

實現(xiàn)自定義的任務(wù)類型

首先有三種方式來編寫我們的任務(wù)類

  1. 在我們構(gòu)建項目的build.gradle腳本中直接編寫估盘,這種方式的好處是任務(wù)類自動被編譯加載到我們的classpath中,我們不需要額外做任何的事情骡尽,但是它有很明顯的局限性遣妥,就是除了在包括它的腳本外別的地方無法復(fù)用。

  2. 在我們構(gòu)建項目的rootProjectDir/buildSrc/src/main/groovy 目錄下編寫攀细,Gradle會自動編譯到當(dāng)前項目的classpath中箫踩,該項目下所有編譯腳本都可以使用爱态,但是除了當(dāng)前項目之外的都無法復(fù)用。

  3. 以單獨的工程方式編寫境钟,這個工程最終編譯發(fā)布為一個JAR包锦担,它可以在多個項目或不同的團隊中共享使用。

然后我們先使用第一種方式編寫一個簡單的自定義任務(wù)類慨削,而該自定義任務(wù)類是繼承自DefaultTask的吆豹,同時為它添加一個行為方法,該方法需要使用TaskAction進行標(biāo)注理盆,這樣Gradle就會在任務(wù)執(zhí)行的時候默認調(diào)用它痘煤,其build.gradle中代碼如下所示:

task hello(type: GreetingTask)

class GreetingTask extends DefaultTask {
    @TaskAction
    def greet() {
        println 'hello from GreetingTask'
    }
}

執(zhí)行命令gradle -q hello結(jié)果如下:

> gradle -q hello
hello from GreetingTask

當(dāng)然我們可以為我們自定義的任務(wù)類添加屬性,并且在使用的時候設(shè)置該屬性值猿规,其build.gradle中代碼如下:

// 使用默認的屬性值
task hello(type: GreetingTask)

// 自定義設(shè)置的屬性值
task greeting(type: GreetingTask) {
    greeting = 'greetings from GreetingTask'
}

class GreetingTask extends DefaultTask {
    String greeting = 'hello from GreetingTask'

    @TaskAction
    def greet() {
        println greeting
    }
}

執(zhí)行命令gradle -q hello greeting結(jié)果如下:

> gradle -q hello greeting
hello from GreetingTask
greetings from GreetingTask

以單獨工程方式實現(xiàn)自定義任務(wù)類

我們使用IDEA開發(fā)工具創(chuàng)建一個Groovy的工程衷快,然后在它的build.gradle文件中使用Groovy plugin,并且添加相關(guān)的依賴姨俩,代碼如下:

apply plugin: 'groovy'

dependencies {
    compile gradleApi()
    compile localGroovy()
}

接著創(chuàng)建一個Groovy類蘸拔,其文件為src/main/groovy/org/gradle/GreetingTask.groovy,相關(guān)代碼如下:

package org.gradle

import org.gradle.api.DefaultTask
import org.gradle.api.tasks.TaskAction

class GreetingTask extends DefaultTask {
    String greeting = 'hello from GreetingTask'

    @TaskAction
    def greet() {
        println greeting
    }
}

我們可以使用maven-publish插件先發(fā)布到本地环葵,這樣我們機器上的其他工程就能在指定目錄下找到我們的任務(wù)類了调窍,修改build.gradle中代碼如下:

apply plugin: 'groovy'
apply plugin: 'maven-publish'

dependencies {
    compile gradleApi()
    compile localGroovy()
}

publishing{
    publications {
        mavenJava(MavenPublication) {
            from components.java

            groupId 'org.gradle'
            artifactId 'customPlugin'
            version '1.0-SNAPSHOT'

        }
    }

    repositories{
        maven {
            // change to point to your repo, e.g. http://my.org/repo
            url "../repo"
        }
    }
}

在IDEA工具中直接運行publish任務(wù),就能完成發(fā)布工作张遭,并在工程的上一級目錄下生成發(fā)布包邓萨,具體操作和結(jié)果如下圖所示:

圖一 運行publish發(fā)布工程
圖二 生布后的本地倉庫目錄

最后在另外一個工程中使用該任務(wù)類
使用IDEA開發(fā)工具新創(chuàng)建一個Gradle工程,在該工程中將使用我們上面單獨定義的任務(wù)類菊卷,首先我們需要使用buildscript { } 塊來使類添加到編譯腳本的classpath中缔恳,下面build.gradle中的代碼展示了如果加載本地倉庫的任務(wù)類:

buildscript {
    repositories {
        maven {
            url uri('../repo')
        }
    }
    dependencies {
        classpath group: 'org.gradle', name: 'customPlugin',
                  version: '1.0-SNAPSHOT'
    }
}

task greeting(type: org.gradle.GreetingTask) {
    greeting = 'another project working!'
}

執(zhí)行命令gradle -q greeting的結(jié)果如下:

> gradle -q greeting
another project working!

小結(jié)

本章通過實現(xiàn)了一個自定義任務(wù)類,讓我們了解到了Gradle是如何增強任務(wù)功能的洁闰,下一節(jié)中我將繼續(xù)介紹如何實現(xiàn)自定義的插件歉甚,自定義任務(wù)類一般是與自定義插件一起使用的。如果感覺興趣的同學(xué)請關(guān)注我扑眉,我和朋友的新書《分布式服務(wù)架構(gòu):原理纸泄、設(shè)計與實戰(zhàn)》也正式登陸京東了,如果有需要的可以直購買腰素,里面有很多平時的工作經(jīng)驗分享聘裁。

參加技術(shù)分享


《分布式服務(wù)架構(gòu):原理、設(shè)計與實戰(zhàn)》
楊彪的簡書博客
云時代架構(gòu)公眾號
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末耸弄,一起剝皮案震驚了整個濱河市咧虎,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌计呈,老刑警劉巖砰诵,帶你破解...
    沈念sama閱讀 222,378評論 6 516
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異捌显,居然都是意外死亡茁彭,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,970評論 3 399
  • 文/潘曉璐 我一進店門扶歪,熙熙樓的掌柜王于貴愁眉苦臉地迎上來理肺,“玉大人,你說我怎么就攤上這事善镰∶萌” “怎么了?”我有些...
    開封第一講書人閱讀 168,983評論 0 362
  • 文/不壞的土叔 我叫張陵炫欺,是天一觀的道長乎完。 經(jīng)常有香客問我,道長品洛,這世上最難降的妖魔是什么树姨? 我笑而不...
    開封第一講書人閱讀 59,938評論 1 299
  • 正文 為了忘掉前任,我火速辦了婚禮桥状,結(jié)果婚禮上帽揪,老公的妹妹穿的比我還像新娘。我一直安慰自己辅斟,他們只是感情好转晰,可當(dāng)我...
    茶點故事閱讀 68,955評論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著士飒,像睡著了一般挽霉。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上变汪,一...
    開封第一講書人閱讀 52,549評論 1 312
  • 那天侠坎,我揣著相機與錄音,去河邊找鬼裙盾。 笑死实胸,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的番官。 我是一名探鬼主播庐完,決...
    沈念sama閱讀 41,063評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼徘熔!你這毒婦竟也來了门躯?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,991評論 0 277
  • 序言:老撾萬榮一對情侶失蹤酷师,失蹤者是張志新(化名)和其女友劉穎讶凉,沒想到半個月后染乌,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,522評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡懂讯,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,604評論 3 342
  • 正文 我和宋清朗相戀三年荷憋,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片褐望。...
    茶點故事閱讀 40,742評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡勒庄,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出瘫里,到底是詐尸還是另有隱情实蔽,我是刑警寧澤,帶...
    沈念sama閱讀 36,413評論 5 351
  • 正文 年R本政府宣布谨读,位于F島的核電站局装,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏漆腌。R本人自食惡果不足惜贼邓,卻給世界環(huán)境...
    茶點故事閱讀 42,094評論 3 335
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望闷尿。 院中可真熱鬧塑径,春花似錦、人聲如沸填具。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,572評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽劳景。三九已至誉简,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間盟广,已是汗流浹背闷串。 一陣腳步聲響...
    開封第一講書人閱讀 33,671評論 1 274
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留筋量,地道東北人烹吵。 一個月前我還...
    沈念sama閱讀 49,159評論 3 378
  • 正文 我出身青樓,卻偏偏與公主長得像桨武,于是被迫代替她去往敵國和親肋拔。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,747評論 2 361

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