tasks
下面的代碼展示了三個Gradle task,稍後會講解這三者的不同。
task myTask { println "Hello, World!" } task myTask { doLast { println "Hello, World!" } } task myTask << { println "Hello, World!" }我的目的是創建一個task,當它執行的時候會打印出來”Hello, World!”。當我第一次創建task的時候,我猜測應該是這樣來寫的:
task myTask { println "Hello, World!" }現在,試著來執行這個myTask,在命令行輸入gradle myTask,打印如下:
user$ gradle myTask Hello, World! :myTask UP-TO-DATE
這個task看起來起作用了。它打印了”Hello, World!”。
但是,它其實並沒有像我們期望的那樣。下面我們來看看為什麼。在命令行輸入gradle tasks來查看所有可用的tasks。
user$ gradle tasks Hello, World! :tasks ------------------------------------------------------------ All tasks runnable from root project ------------------------------------------------------------ Build Setup tasks ----------------- init - Initializes a new Gradle build. [incubating] ..........
等等,為什麼”Hello, World!”打印出來了?我只是想看看有哪些可用的task,並沒有執行任何自定義的task!
原因其實很簡單,Gradle task在它的生命週期中有兩個主要的階段:配置階段和執行階段。
可能我的用詞不是很精確,但這的確能幫助我理解tasks。
Gradle在執行task之前都要對task先進行配置。那麼問題就來了,我怎麼知道我的task中,哪些代碼是在配置過程中執行的,哪些代碼是在task執行的時候運行的?答案就是,在task的最頂層的代碼就是配置代碼,比如:
task myTask { def name = "Pavel" //<-- 這行代碼會在配置階段執行println "Hello, World!"////<-- 這行代碼也將在配置階段執行}這就是為什麼我執行gradle tasks的時候,會打印出來”Hello, World!”-因為配置代碼被執行了。但這並不是我想要的效果,我想要”Hello, World!”僅僅在我顯式的調用myTask的時候才打印出來。為了達到這個效果,最簡單的方法就是就是使用Task#doLast()方法。
task myTask { def text = 'Hello, World!' //configure my task doLast { println text //this is executed when my task is called } }現在,”Hello, World!”僅僅會在我執行gradle myTask的時候打印出來。 Cool,現在我已經知道如何配置以及使task做正確的事情。還有一個問題,最開始的例子中,第三個task的<<符號是什麼意思?
task myTask2 << { println "Hello, World!" }這其實只是doLast的一個語法糖版本。它和下面的寫法效果是一樣的:
task myTask { doLast { println 'Hello, World!' //this is executed when my task is called } }但是,這種寫法所有的代碼都在執行部分,沒有配置部分的代碼,因此比較適合那些簡小不需要配置的task。一旦你的task需要配置,那麼還是要使用doLast的版本。
文法
Gradle腳本是使用Groovy語言來寫的。 Groovy的語法有點像Java,希望你能接受它。
如果你對Groovy已經很熟悉了,可以跳過這部分了。
Groovy中有一個很重要的概念你必要要弄懂Closure(閉包)
Closures
Closure是我們弄懂Gradle的關鍵。 Closure是一段單獨的代碼塊,它可以接收參數,返回值,也可以被賦值給變量。和Java中的Callable接口,Future類似,也像函數指針,你自己怎麼方便理解都好。 。 。
關鍵是這塊代碼會在你調用的時候執行,而不是在創建的時候。看一個Closure的例子:
def myClosure = { println 'Hello world!' }//execute our closuremyClosure()#output: Hello world!下面是一個接收參數的Closure:
def myClosure = {String str -> println str }//execute our closuremyClosure('Hello world!')#output: Hello world!如果Closure只接收一個參數,可以使用it來引用這個參數:
def myClosure = {println it }//execute our closuremyClosure('Hello world!')#output: Hello world!接收多個參數的Closure:
def myClosure = {String str, int num -> println "$str : $num" }//execute our closuremyClosure('my string', 21)#output: my string : 21另外,參數的類型是可選的,上面的例子可以簡寫成這樣:
def myClosure = {str, num -> println "$str : $num" }//execute our closuremyClosure('my string', 21)#output: my string : 21很酷的是Closure中可以使用當前上下文中的變量。默認情況下,當前的上下文就是closure被創建時所在的類:
def myVar = 'Hello World!'def myClosure = {println myVar}myClosure()#output: Hello world!另外一個很酷的點是closure的上下文是可以改變的,通過Closure#setDelegate()。這個特性非常有用:
def myClosure = {println myVar} //I'm referencing myVar from MyClass classMyClass m = new MyClass()myClosure.setDelegate(m)myClosure()class MyClass { def myVar = 'Hello from MyClass!'}#output: Hello from MyClass!正如你鎖看見的,在創建closure的時候,myVar並不存在。這並沒有什麼問題,因為當我們執行closure的時候,在closure的上下文中,myVar是存在的。這個例子中。因為我在執行closure之前改變了它的上下文為m,因此myVar是存在的。
把closure當做參數傳遞
closure的好處就是可以傳遞給不同的方法,這樣可以幫助我們解耦執行邏輯。前面的例子中我已經展示瞭如何把closure傳遞給一個類的實例。下面我們將看一下各種接收closure作為參數的方法:
1.只接收一個參數,且參數是closure的方法: myMethod(myClosure)
2.如果方法只接收一個參數,括號可以省略: myMethod myClosure
3.可以使用內聯的closure: myMethod {println 'Hello World'}
4.接收兩個參數的方法: myMethod(arg1, myClosure)
5.和4類似,單數closure是內聯的: myMethod(arg1, { println 'Hello World' })
6.如果最後一個參數是closure,它可以從小括號從拿出來: myMethod(arg1) { println 'Hello World' }
這裡我只想提醒你一下,3和6的寫法是不是看起來很眼熟?
Gradle例子
現在我們已經了解了基本的語法了,那麼如何在Gradle腳本中使用呢?先看下面的例子吧:
buildscript { repositories { jcenter() } dependencies { classpath 'com.android.tools.build:gradle:1.2.3' }}allprojects { repositories { jcenter() }}知道了Groovy的語法,是不是上面的例子就很好理解了?
首先就是一個buildscript方法,它接收一個closure:
def buildscript(Closure closure)
接著是allprojects方法,它也接收一個closure參數:
def allprojects(Closure closure)
其他的都類似。 。 。
現在看起來容易多了,但是還有一點不明白,那就是這些方法是在哪裡定義的?答案就是Project
Project
這是理解Gradle腳本的一個關鍵。
構建腳本頂層的語句塊都會被委託給Project的實例這就說明Project正是我要找得地方。
在Project的文檔頁面搜索buildscript方法,會找到buildscript{} script block(腳本塊).等等,script block是什麼鬼?根據文檔:
script block就是只接收closure作為參數的方法繼續閱讀buildscript的文檔,文檔上說Delegates to: ScriptHandler from buildscript。也就是說,我們傳遞給buildscript方法的closure,最終執行的上下文是ScriptHandler。在上面的例子中,我們的傳遞給buildscript的closure調用了repositories(closure)和dependencies(closure)方法。既然closure被委託給了ScriptHandler,那麼我們就去ScriptHandler中尋找dependencies方法。
找到了void dependencies(Closure configureClosure),根據文檔,dependencies是用來配置腳本的依賴的。而dependencies最終又是委託到了DependencyHandler。
看到了Gradles是多麼廣泛的使用委託了吧。理解委託是很重要滴。
Script blocks
默認情況下,Project中預先定義了很多script block,但是Gradle插件允許我們自己定義新的script blocks!
這就意味著,如果你在build腳本頂層發了一些{…},但是你在Gradle的文檔中卻找不到這個script blocks或者方法,絕大多情況下,這是一些來自插件中定義的script block。
android Script block
我們來看看默認的Android app/build.gradle文件:
apply plugin: 'com.android.application'android { compileSdkVersion 22 buildToolsVersion "22.0.1" defaultConfig { applicationId "com.trickyandroid.testapp" minSdkVersion 16 targetSdkVersion 22 versionCode 1 versionName "1.0" } buildTypes { release { minifyEnabled false proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' } }}Task順序
我注意到我在使用Gradle的時候遇到的大多數問題都是和task的執行順序有關的。很明顯如果我的構建會工作的更好如果我的task都是在正確的時候執行。下面我們就深入了解一下如何更改task的執行順序。
dependsOn
我認為最直接的方式來說明的你task的執行時依賴別的task的方法就是使用dependsOn方法。
比如下面的場景,已經存在task A,我們要添加一個task B,它的執行必須要在A執行完之後:
這是一個很簡單的場景,假定A和B的定義如下:
task A << {println 'Hello from A'}task B << {println 'Hello from B'}只需要簡單的調用B.dependsOn A,就可以了。
這意味著,只要我執行task B,task A都會先執行。
paveldudka$ gradle B:AHello from A:BHello from B
另外,你也可以在task的配置區中來聲明它的依賴:
task A << {println 'Hello from A'}task B { dependsOn A doLast { println 'Hello from B' }}如果我們想要在已經存在的task依賴中插入我們的task該怎麼做呢?
過程和剛才類似。假定已經存在如下的task依賴:
task A << {println 'Hello from A'}task B << {println 'Hello from B'}task C << {println 'Hello from C'}B.dependsOn AC.dependsOn B加入我們的新的task
task B1 << {println 'Hello from B1'}B1.dependsOn BC.dependsOn B1輸出:
paveldudka$ gradle C:AHello from A:BHello from B:B1Hello from B1:CHello from C
注意dependsOn把task添加到依賴的集合中,所以依賴多個task是沒有問題的。
task B1 << {println 'Hello from B1'}B1.dependsOn BB1.dependsOn Q輸出:
paveldudka$ gradle B1:AHello from A:BHello from B:QHello from Q:B1Hello from B1
mustRunAfter
現在假定我又一個task,它依賴於其他兩個task。這裡我使用一個真實的場景,我有兩個task,一個單元測試的task,一個是UI測試的task。另外還有一個task是跑所有的測試的,它依賴於前面的兩個task。
task unit << {println 'Hello from unit tests'}task ui << {println 'Hello from UI tests'}task tests << {println 'Hello from all tests!'}tests.dependsOn unittests.dependsOn ui輸出:
paveldudka$ gradle tests:uiHello from UI tests:unitHello from unit tests:testsHello from all tests!
儘管unitest和UI test會子啊test task之前執行,但是unit和ui這兩個task的執行順序是不能保證的。雖然現在來看是按照字母表的順序執行,但這是依賴於Gradle的實現的,你的代碼中絕對不能依賴這種順序。
由於UI測試時間遠比unit test時間長,因此我希望unit test先執行。一個解決辦法就是讓ui task依賴於unit task。
task unit << {println 'Hello from unit tests'}task ui << {println 'Hello from UI tests'}task tests << {println 'Hello from all tests!'}tests.dependsOn unittests.dependsOn uiui.dependsOn unit // <-- I added this dependency輸出:
paveldudka$ gradle tests:unitHello from unit tests:uiHello from UI tests:testsHello from all tests!
現在unit test會在ui test之前執行了。
但是這裡有個很噁心的問題,我的ui測試其實並不依賴於unit test。我希望能夠單獨的執行ui test,但是這裡每次我執行ui test,都會先執行unit test。
這裡就要用到mustRunAfter了。 mustRunAfter並不會添加依賴,它只是告訴Gradle執行的優先級如果兩個task同時存在。比如我們這裡就可以指定ui.mustRunAfter unit,這樣如果ui task和unit task同時存在,Gradle會先執行unit test,而如果只執行gradle ui,並不會去執行unit task。
task unit << {println 'Hello from unit tests'}task ui << {println 'Hello from UI tests'}task tests << {println 'Hello from all tests!'}tests.dependsOn unittests.dependsOn uiui.mustRunAfter unit輸出:
paveldudka$ gradle tests:unitHello from unit tests:uiHello from UI tests:testsHello from all tests!
依賴關係如下圖:
mustRunAfter在Gradle2.4中目前還是實驗性的功能。
finalizedBy
現在我們已經有兩個task,unit和ui,假定這兩個task都會輸出測試報告,現在我想把這兩個測試報告合併成一個:
task unit << {println 'Hello from unit tests'}task ui << {println 'Hello from UI tests'}task tests << {println 'Hello from all tests!'}task mergeReports << {println 'Merging test reports'}tests.dependsOn unittests.dependsOn uiui.mustRunAfter unitmergeReports.dependsOn tests現在如果我想獲得ui和unit的測試報告,執行task mergeReports就可以了。
paveldudka$ gradle mergeReports:unitHello from unit tests:uiHello from UI tests:testsHello from all tests!:mergeReportsMerging test reports
這個task是能工作,但是看起來好笨啊。 mergeReports從用戶的角度來看感覺不是特別好。我希望執行tests task就可以獲得測試報告,而不必知道mergeReports的存在。當然我可以把merge的邏輯挪到tests task中,但我不想把tests task搞的太臃腫,我還是繼續把merge的邏輯放在mergeReports task中。
finalizeBy來救場了。顧名思義,finalizeBy就是在task執行完之後要執行的task。修改我們的腳本如下:
task unit << {println 'Hello from unit tests'}task ui << {println 'Hello from UI tests'}task tests << {println 'Hello from all tests!'}task mergeReports << {println 'Merging test reports'}tests.dependsOn unittests.dependsOn uiui.mustRunAfter unitmergeReports.dependsOn teststests.finalizedBy mergeReports現在執行tests task就可以拿到測試報告了:
paveldudka$ gradle tests:unitHello from unit tests:uiHello from UI tests:testsHello from all tests!:mergeReportsMerging test reports