Learn Gradle - CH 2 基本的構建腳本介紹

一、項目和任務

Gradle 構建腳本包括兩個最基本的概念，就是項目（projects）和任務（tasks）。

項目是指咱們的構建產物（好比jar包）或實施產物（好比web application等）。Gradle構建腳本包含一個或多個項目。

任務是指不可分的最小工做單元，執行構建工做（好比編譯一些類文件、建立jar文件、生成javadoc以及發佈架構文檔到倉庫等）。一個項目包含一個或多個任務。

二、Hello World！！

下面咱們學習一個簡單的hello world例子來簡單認識一下Gradle構建腳本。

新建文件：build.gradle 

添加內容：

task hello {
    doLast {
        println 'Hello world!'
    }
}

使用命令行進入build.gradle所在目錄，執行：gradle hello ，輸出：

:hello
Hello world!

BUILD SUCCESSFUL

在這個例子中build.gradle 文件就是一個構建腳本（嚴格的說，這是一個構建配置腳本），這個腳本定義了一個項目以及項目包含的任務。

Gradle是領域驅動設計的構建工具，在它的實現當中，Project接口對應上面的project概念，Task接口對應上面的task概念，實際上除此以外還有一個重要的領域對象，即Action，對應的是task裏面具體的某一個操做。一個project由多個task組成，一個task也是由多個action組成。

當執行gradle hello的時候，Gradle就會去調用這個hello task來執行給定操做(Action)。這個操做其實就是一個用Groovy代碼寫的閉包，代碼中的task是Project類裏的一個方法，經過調用這裏的task方法建立了一個Task對象，並在對象的doLast方法中傳入 println 'Hello world!' 這個閉包。這個閉包就是一個Action。

Task是Gradle裏定義的一個接口，表示上述概念中的task。它定義了一系列的諸如doLast, doFirst等抽象方法，具體能夠看gradle api裏org.gradle.api.Task的文檔。

三、使用快捷鍵定義任務

doLast還有另一種簡單的寫法：

task hello << {
    println 'Hello world!'
}

執行gradle hello 命令，輸出結果與以前的相同。也就是咱們把像doLast這樣的代碼，直接簡化爲<<這個符號了。這實際上是Gradle利用了Groovy的操做符重載的特性，把左位移操做符實現爲將action加到task的最後，至關於調用doLast方法。看Gradle的api文檔裏對doLast()和leftShift()這兩個方法的介紹，可知它們的做用是同樣的，因此在這裏，<<左移操做符即doLast的簡寫方式。

四、腳本即代碼

在Gradle的構建腳本中，可使用Groovy代碼以實現更強大的功能。

例1：

task upper << {
    String someString = 'mY_nAmE'
    println "Original: " + someString 
    println "Upper case: " + someString.toUpperCase()
}

執行gradle upper，輸出：

:upper
Original: mY_nAmE
Upper case: MY_NAME

BUILD SUCCESSFUL

例2：

task count << {
    4.times { print "$it " }
}

執行gradle count，輸出：

:count
0 1 2 3
BUILD SUCCESSFUL

五、任務依賴

一、在腳本中定義任務依賴：

task hello << {
    println 'Hello world!'
}
task intro(dependsOn: hello) << {
    println "I'm Gradle"
}

執行gradle intro，輸出：

:hello
Hello world!
:intro
I'm Gradle

BUILD SUCCESSFUL

二、任務能夠依賴還沒有出現的任務：

task taskX(dependsOn: 'taskY') << {
    println 'taskX'
}
task taskY << {
    println 'taskY'
}

本例中任務taskX依賴taskY，可是taskY在taskX以後才定義。執行gradle taskX，輸出：

:taskY
taskY
:taskX
taskX

BUILD SUCCESSFUL

六、動態任務

咱們可使用Groovy的語法動態建立任務，例如：

4.times { counter ->
    task "task$counter" << {
        println "I'm task number $counter"
    }
}

執行gradle -q task1，輸出：

:task1
I'm task number 1

BUILD SUCCESSFUL

七、操縱任務

已經建立的任務能夠經過api（例1用到的api是dependsOn ）進行訪問。

例1：給一個任務添加依賴

4.times { counter ->
    task "task$counter" << {
        println "I'm task number $counter"
    }
}
task0.dependsOn task2, task3

執行gradle task0 ，輸出

:task2
I'm task number 2
:task3
I'm task number 3
:task0
I'm task number 0

BUILD SUCCESSFUL

例2：給一個任務添加行爲

task hello << {
    println 'Hello Earth'
}
hello.doFirst {
    println 'Hello Venus'
}
hello.doLast {
    println 'Hello Mars'
}
hello << {
    println 'Hello Jupiter'
}

執行gradle hello，輸出：

:hello
Hello Venus
Hello Earth
Hello Mars
Hello Jupiter

BUILD SUCCESSFUL

任務先執行了doFirst，再按順序執行了doLast（"<<"能夠理解爲doLast的別名，因此相同的api方法將按照配置文件順序執行）

八、自定義屬性

task myTask {
    ext.myProperty = "myValue"
}

task printTaskProperties << {
    println myTask.myProperty
}

執行gradle printTaskProperties，輸出：

:printTaskProperties
myValue

BUILD SUCCESSFUL

九、默認任務

gradle容許在構建過程當中配置一個或多個任務做爲默認任務來執行，例如：

defaultTasks 'clean', 'run'

task clean << {
    println 'Default Cleaning!'
}

task run << {
    println 'Default Running!'
}

task other << {
    println "I'm not a default task!"
}

執行 gradle ，輸出：

:clean
Default Cleaning!
:run
Default Running!

BUILD SUCCESSFUL

十、DAG（Directed acyclic graph，有向非循環圖）配置

Gradle構建的生命週期包含初始化階段、配置階段和執行階段。Gradle使用DAG來記錄任務執行的順序。配置階段完成後，Gradle就明確了全部須要被執行的任務，這些任務將被存儲到taskGraph。Gradle提供了一個鉤子來使用這個（taskGraph）信息。下面這個例子咱們將判斷taskGraph是否包含release任務來肯定項目發佈的版本號。

task distribution << {
    println "We build the zip with version=$version"}

task release(dependsOn: 'distribution') << {
    println 'We release now'}

gradle.taskGraph.whenReady {taskGraph ->    
    if (taskGraph.hasTask(release)) {
        version = '1.0'
    } else {
        version = '1.0-SNAPSHOT'
    }
}

執行 gradle distribution ，輸出：

:distribution
We build the zip with version=1.0-SNAPSHOT

BUILD SUCCESSFUL

執行gradle release ，輸出：

:distribution
We build the zip with version=1.0
:release
We release now

BUILD SUCCESSFUL

本文是本人初學Gradle所做筆記，是在邊學習Gradle邊寫做的狀況下完成，若是錯漏，還請看客們勿噴。若能友好指出，共同進步，本人不甚感激。