文章目的
本章中我們將會學(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ù)類
在我們構(gòu)建項目的build.gradle腳本中直接編寫估盘,這種方式的好處是任務(wù)類自動被編譯加載到我們的classpath中,我們不需要額外做任何的事情骡尽,但是它有很明顯的局限性遣妥,就是除了在包括它的腳本外別的地方無法復(fù)用。
在我們構(gòu)建項目的rootProjectDir/buildSrc/src/main/groovy 目錄下編寫攀细,Gradle會自動編譯到當(dāng)前項目的classpath中箫踩,該項目下所有編譯腳本都可以使用爱态,但是除了當(dāng)前項目之外的都無法復(fù)用。
以單獨的工程方式編寫境钟,這個工程最終編譯發(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é)果如下圖所示:
最后在另外一個工程中使用該任務(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)驗分享聘裁。