學(xué)習(xí)本系列前可以下載相關(guān)的github項(xiàng)目gradleLearnDemo。
地址:https://github.com/sososeen09/gradleLearnDemo
1 聲明Task
默認(rèn)情況下仗嗦,每個(gè)新創(chuàng)建的task都是org.gradle.api.DefaultTask類型的稀拐,它是標(biāo)準(zhǔn)的org.gradle.api.Task 實(shí)現(xiàn)。DefaultTask的所有屬性都是private的,只能通過(guò)getter和setter方法來(lái)訪問(wèn)。
幸運(yùn)的是闸翅,Groovy提供了一些語(yǔ)法糖,可以直接通過(guò)屬性名來(lái)使用屬性记某。在底層,Groovy會(huì)為你調(diào)用這些方法。
一個(gè)簡(jiǎn)單的task可以是這樣畅姊,
version ='0.1-SNAPSHOT'
task printVersion {
doLast{
println "Version: $version"
}
}
執(zhí)行gradle printVersion
命令倾鲫,結(jié)果是
:printVersion
Version: 0.1-SNAPSHOT
如果換成doFirst,執(zhí)行的結(jié)果也是一樣的甚淡。
task printVersion {
doFirst{
println "Version: $version"
}
}
2 給現(xiàn)有的Task添加動(dòng)作
task在創(chuàng)建后焙贷,可以根據(jù)需要添加很多動(dòng)作啡彬,在內(nèi)部纵搁,每個(gè)task都保持了一個(gè)動(dòng)作列表峻呕,在運(yùn)行時(shí),它們按順序執(zhí)行。
version ='0.1-SNAPSHOT'
// 聲明一個(gè)包含doFirst和doLast的task
task printVersion {
doFirst{
println "Before reading the project version"
}
doLast{
println "Version: $version"
}
}
//在動(dòng)作列表的開始添加doFirst閉包
//在動(dòng)作列表的最后添加doLast閉包,采用別名的方式
printVersion.doFirst {println "First action"}
printVersion<<{println "Last action"}
執(zhí)行gradle printVersion
命令,結(jié)果是:
:printVersion
First action
Before reading the project version
Version: 0.1-SNAPSHOT
Last action
如上所示碎税,可以給現(xiàn)有的task添加一些動(dòng)作杯道,這在你想要為不是自己編寫的task執(zhí)行自定義邏輯時(shí)非常有用。比如,為Java插件的compileJava task添加一個(gè)doFirst動(dòng)作來(lái)檢查項(xiàng)目中至少包含一個(gè)Java源文件。
3 訪問(wèn)DefaultTask屬性
Gradle提供了一個(gè)基于SLF4J日志庫(kù)的logger實(shí)現(xiàn)趾代。除了常規(guī)的日志級(jí)別如DEBUG禽捆、ERROR、INFO飘哨、TRACE胚想、WARN,之外Gradle還增加了一些額外的日志級(jí)別芽隆。通過(guò)Task的方法可以直接訪問(wèn)logger實(shí)例浊服。例如,打印QUIET日志級(jí)別的版本號(hào):
version ='0.1-SNAPSHOT'
task printVersion << {
logger.quiet "Version: $version"
}
Task還有兩個(gè)屬性:description和group胚吁。description屬性用于描述任務(wù)的作用牙躺,而group屬性則用于定義task的邏輯分組。
創(chuàng)建task的時(shí)候可以為這兩個(gè)屬性設(shè)置值作為參數(shù)腕扶。
task printVersion(group: 'versioning',description:'Print project version' ) << {
logger.quiet "Version: $version"
}
也可以通過(guò)setter方法來(lái)設(shè)置屬性:
task printVersion{
group = 'versioning'
description = 'Print project version'
doLast{
logger.quiet "Version: $version"
}
}
執(zhí)行 gradle task
命令孽拷,可以看到task正確的分組和描述
Versioning tasks
----------------
printVersion - Print project version
盡管設(shè)置task的描述和分組和可選的,但是為所有的task指定description和group是一個(gè)比較好的實(shí)踐半抱,這會(huì)幫助用戶比較容易的去識(shí)別task的功能脓恕。
4 定義task依賴
dependsOn方法允許聲明依賴一個(gè)或多個(gè)task。
version ='0.1-SNAPSHOT'
task first << { println 'first'}
task second << { println 'second' }
//指定多個(gè)task依賴
task printVersion(dependsOn :[second,first]) << {
logger.quiet "Version: $version"
}
//task third(dependsOn : printVersion) <<{
// println 'third'
//}
//還可以采用這樣的方式
task third <<{ println 'third'}
third.dependsOn('printVersion')
執(zhí)行g(shù)radle -q third 結(jié)果如下:
first
second
Version: 0.1-SNAPSHOT
third
看到執(zhí)行結(jié)果會(huì)有一點(diǎn)點(diǎn)意外窿侈,printVersion任務(wù)的依賴是second和first炼幔,為什么不是先執(zhí)行second再執(zhí)行first呢?在Gradle中史简,task執(zhí)行順序是不確定的乃秀。
5 Task的執(zhí)行順序
理解Gradle并不能保證task依賴的執(zhí)行順序是很重要的。dependsOn方法只是定義了所依賴的task需要先執(zhí)行乘瓤。Gradle的思想是聲明在一個(gè)給定的task執(zhí)行之前什么該被執(zhí)行环形,而沒有去定義它該如何執(zhí)行。在Gradle中衙傀,執(zhí)行順序是由task的輸入/輸出規(guī)范自動(dòng)確定的抬吟。
好處:
- 不需要知道整個(gè)task依賴鏈上的關(guān)系是否發(fā)生改變,這樣可以提高代碼的可維護(hù)性和避免潛在的破壞统抬。
- 因?yàn)闃?gòu)建沒有嚴(yán)格的執(zhí)行順序火本,也就是支持task的并行執(zhí)行危队,這樣可以極大地節(jié)約構(gòu)建執(zhí)行時(shí)間。
6 理解task配置
在Gradle腳本中可以定義通用的Groovy代碼的功能钙畔。Groovy中只需要聲明屬性茫陆,不需要添加訪問(wèn)權(quán)限修飾符。getter和setter方法本質(zhì)上是在生成字節(jié)碼時(shí)自動(dòng)添加的擎析,運(yùn)行時(shí)可以直接使用簿盅。
version=new ProjectVersion(0,1)
class ProjectVersion{
Integer major
Integer minor
Boolean release
ProjectVersion(Integer major, Integer minor){
this.major=major
this.minor=minor
this.release=Boolean.FALSE
}
ProjectVersion(Integer major, Integer minor, Boolean release){
this.major=major
this.minor=minor
this.release=release
}
@Override
String toString(){
"$major.$minor${release?'': '-SNAPSHOT'}"
}
}
task printVersion << {
logger.quiet "Version: $version"
}
運(yùn)行 gradle printVersion
,得到的結(jié)果與之前相同揍魂。
我們也可以使用配置文件來(lái)設(shè)置屬性桨醋。
例如新建一個(gè)version.properties文件。
major = 0
minor = 1
release = false
對(duì)應(yīng)的version就是0.1-SANPSHOT
然后可以添加task的配置塊
// Project接口提供了file方法现斋,它會(huì)創(chuàng)建一個(gè)相對(duì)于項(xiàng)目目錄的java.io.File實(shí)例
// versionFile是一個(gè)擴(kuò)展屬性
ext.versionFile=file('version.properties')
//沒有使用左移操作符定義task配置
task loadVersion{
project.version=readVersion()
}
//readVersion方法喜最,注意:這個(gè)是方法,而不是task
ProjectVersion readVersion(){
logger.quiet 'Reading the version file'
if(!versionFile.exists()){
throw new GradleException ("Required version file dose not exist:$versionFile.canonicalPath " )
}
//Groovy的文件實(shí)現(xiàn)通過(guò)添加新的方法來(lái)讀取InputStream
Properties versionProps=new Properties()
versionFile.withInputStream{stream->
versionProps.load(stream)
}
// 在Groovy中庄蹋,如果return是方法中的最后一條語(yǔ)句的話瞬内,則可以將它省略
new ProjectVersion(versionProps.major.toInteger(),versionProps.minor.toInteger(),versionProps.release.toBoolean())
}
運(yùn)行 gradle printVersion
,會(huì)看到 loadVersion 中的代碼執(zhí)行了限书。盡管 loadVersion 這個(gè)task的名字沒有打印出來(lái)虫蝶,但是可以看到打印日志了。
Reading the version file
:printVersion
Version: 0.1-SNAPSHOT
我們不禁疑問(wèn)蔗包,為什么我們沒有執(zhí)行 loadVersion 這個(gè)task秉扑,也沒有聲明依賴關(guān)系,但是它內(nèi)部的代碼依然被執(zhí)行了呢调限?
原因就是我們?cè)趌oadVersion這個(gè)task閉包中的project.version=readVersion()
屬于task配置塊舟陆,而task配置塊永遠(yuǎn)在task動(dòng)作執(zhí)行之前被執(zhí)行,只要觸發(fā)構(gòu)建耻矮,腳本文件中的所有task配置塊都會(huì)執(zhí)行秦躯,這牽涉到了Gradle的構(gòu)建生命周期問(wèn)題。
注意區(qū)分 配置塊和action是不同的裆装,task的action一般就是doFirst和doLast踱承。
7 構(gòu)建生命周期階段
無(wú)論什么時(shí)候執(zhí)行Gradle構(gòu)建,都會(huì)運(yùn)行三個(gè)不同的生命周期階段:初始化哨免、配置和執(zhí)行茎活。
初始化階段,Gradle為項(xiàng)目創(chuàng)建了一個(gè)Project實(shí)例琢唾。給定的構(gòu)建腳本只定義了一個(gè)項(xiàng)目载荔,在多項(xiàng)目構(gòu)建中,這個(gè)構(gòu)建階段變得更加重要采桃。根據(jù)正在執(zhí)行的項(xiàng)目懒熙,Gradle找出哪些項(xiàng)目依賴需要參與到構(gòu)建中丘损。
注意:在這個(gè)構(gòu)建階段當(dāng)前已有的構(gòu)建腳本代碼都不會(huì)被執(zhí)行。
配置階段工扎,Gradle構(gòu)造了一個(gè)模型來(lái)表示任務(wù)徘钥,并參與到構(gòu)建中來(lái)。增量式構(gòu)建特性決定了模型中的task是否需要被運(yùn)行肢娘。這個(gè)階段非常適合與為項(xiàng)目或執(zhí)行task設(shè)置所需的配置呈础。
注意:項(xiàng)目每一次構(gòu)建的任何配置代碼都可以被執(zhí)行——即使你只執(zhí)行g(shù)radle tasks
執(zhí)行階段,所有的task都應(yīng)該以正確的順序被執(zhí)行蔬浙。執(zhí)行順序是由它們的依賴決定的猪落。如果任務(wù)被認(rèn)為沒有修改過(guò),將被跳過(guò)畴博,這個(gè)牽涉到增量式構(gòu)建,我們下一篇再講蓝仲。