Gradle | 進階篇（Project & Task & 構建生命週期）| 七日打卡

點贊關注，再也不迷路，你的支持對我意義重大！

🔥 Hi，我是醜醜。本文 GitHub · Android-NoteBook 已收錄，這裏有 Android 進階成長路線筆記 & 博客，歡迎跟着彭醜醜一塊兒成長。（聯繫方式在 GitHub）

---

目錄

---

1. 前置知識

在 Gradle 中，build.gradle 腳本文件中每一個元素都會映射一個 Java 類。其中最重要的兩個類是 「Project」&「Task」。在這篇文章裏，我將帶你分析 Gradle 中 Project 與 Task 的原理與使用，以及分析 Gradle 構建的生命週期。

這篇文章的內容會涉及如下前置 / 相關知識，貼心的我都幫你準備好了，請享用~

• Gradle 築基： 「Gradle」| 築基篇（概念 & Groovy & 配置 & 命令）

• 官方文檔：Project API 文檔

• 官方文檔：Task API 文檔

---

2. Project 項目

Project 表明一個構建組件，在「構建-初始化階段」，Gradle 引擎會爲每一個 build.gradle 腳本文件實例化一個 Project 實例。 因此咱們在 build.gradle 中編寫的構建邏輯，本質上至關於編寫在 Project 類內部。

org.gradle.api.Project.java

public interface Project extends Comparable<Project>, ExtensionAware, PluginAware {
}
複製代碼

Editting...

---

3. Task 任務

一個 Project 由一個或多個 Task 組成，Task 表明一個可執行的任務。

org.gradle.api.Task.java

public interface Task extends Comparable<Task>, ExtensionAware
}
複製代碼

3.1 定義 Task

定義 Task 的語法主要有三種：

• 使用 task 函數：

task('hello')
task('world') {
}
複製代碼

• 使用 DSL 語言：

task(hello)
task(world) {
}
複製代碼

• 使用 tasks container：

tasks.create('hello')
tasks.create('world') {
}
複製代碼

3.2 Task 屬性

定義 Task 以後，就能夠設置屬性，設置屬性的語法主要有兩種：

• 在建立 Task 時設置：

task hello(group : 'MyTask')
複製代碼

• 調用 setter 設置：

task hello {
    setGroup('MyTask')
}
複製代碼

訪問屬性可使用$符號或者 getter 方法，例如：

task hello(group : 'MyTask') {
    println "$group"
    println getGroup()
}
複製代碼

Task 中比較經常使用的屬性有：

屬性	描述
name	Task 標識符，在定義 Task 時指定
group	Task 所屬的組
description	Task 的描述信息
type	Task類型，默認爲 DefaultTask（見 第 3.7 節）
actions	動做列表（見 第 3.3 節）
dependsOn	依賴 Task 集合

Task 最重要的三個概念是「Task 動做」&「Task 依賴」&「Task 配置」：

3.3 Task 動做

動做（action）就是 Task 中的構建邏輯，這些構建邏輯在「構建-執行階段」運行。Task 接口提供了兩個方法來聲明 Task 任務：

動做	描述
doFirst(Closure)	表示 Task 的第一個動做
doLast(Closure)	表示 Task 的最後一個動做

例如：

task helloworld {
    doFirst {
        println "hello"
    }
    doLast {
        println "world"
    }
}
複製代碼

除此以外，還能夠在 Task 閉包外部添加動做：

task helloworld

helloworld.doFirst { println "hello" }
helloworld.doLast { println "world" }
複製代碼

3.4 Task 輸入 / 輸出

3.5 Task 依賴

Task 每每不是獨立存在的，而是與其餘 Task 存在依賴關係，使用 dependsOn 方法來聲明依賴一個或多個 Task ，例如：

task first {
    doFirst { println "first" }
}
task second {
    doFirst { println "second" }
}
task third {
    doFirst { println "third" }
}
// 單依賴
third.dependsOn first
// 多依賴
third.dependsOn([first,second])
複製代碼

3.6 Task 配置

不在 Task 動做中定義的代碼屬於 Task 配置，二者徹底不一樣：Task 配置運行在「構建-配置階段」，Task 動做運行在「構建-執行階段」，配置代碼永遠在動做代碼以前執行。

3.7 自定義 Task

3.8 Task 類型

---

4. 理解 Gradle 構建生命週期

不管何時執行 Gradle 構建，都會前後執行三個生命週期階段 ——「初始化」&「配置」&「執行」：

4.1 初始化階段（Initiliazation phase）

在初始化階段，Gradle 會解析工程根目錄下的setting.gradle文件，並構造一個 Settings 實例。Settings 是一個接口，主要包含如下方法：

org.gradle.api.initialization.Settings.Java

public interface Settings extends PluginAware, ExtensionAware {
    String DEFAULT_SETTINGS_FILE = "settings.gradle";

    void include(String... var1);
    void includeFlat(String... var1);
    File getSettingsDir();
    File getRootDir();
    Gradle getGradle();
    ...
}
複製代碼

其中的 include 方法你應該很熟悉了，include 方法指定了參與構建的項目（build.gradle）。在初始化階段，Gradle 會爲「包含」的每一個的項目實例化一個 Project 實例。

setting.gradle

include ':app'
複製代碼

在 setting.gradle 裏，你還能夠作這些事：

• include 指定目錄下的項目

Gradle 默認會在工程根目錄下尋找 include 包含的項目，那麼若是你想包含其餘目錄下的項目，能夠這樣配置：

include ':app'
include 'video' 不要加 : 符號

project(:video).projectDir = new File("..\\libs\\video")
複製代碼

• 監聽生命週期

在 setting.gradle 裏，能夠對構建過程當中的節點增長監聽，監聽器添加在Setting.getGradle() 實例上：

setting.gradle

include ':app'

gradle.addBuildListener(new BuildListener() {
    void buildStarted(Gradle var1) {
        println '【開始構建】'
    }
    void settingsEvaluated(Settings var1) {
        // 注意：在這裏不能訪問 var1.gradle.rootProject，由於 Project 尚未初始化
        println '【settings.gradle 解析完成】'
    }
    void projectsLoaded(Gradle var1) {
        println '【初始化階段結束】'
    }
    void projectsEvaluated(Gradle var1) {
        println '【配置階段結束】'
    }
    void buildFinished(BuildResult var1) {
        println '【構建過程結束】'
    }
})
複製代碼

構建過程輸出（Build Output）以下：

Executing tasks: [:app:generateDebugSources] in project E:\workspace ...

【settings.gradle 解析完成】
【初始化階段結束】

【這裏是配置階段】
【配置階段結束】

> Task :app:preBuild UP-TO-DATE
> Task :app:preDebugBuild UP-TO-DATE
> Task :app:checkDebugManifest UP-TO-DATE
> ...
> Task :app:assembleDebug
【構建過程結束】

BUILD SUCCESSFUL in 14s
24 actionable tasks: 19 executed, 5 up-to-date
複製代碼

除了設置監聽器方法，還能夠直接設置閉包，例如：

gradle.projectsLoaded {
    println '【初始化階段結束】'
}
複製代碼

4.2 配置階段（Configration phase）

在配置階段，Gradle 會解析每一個項目中的 build.gradle 文件，完成「Project 配置」&「Task 配置」，並根據 Task 依賴關係來建立一個有向無環圖。例如：

build.gradle

apply plugin: 'com.android.application'

println '配置 app project'

task hello {
    println '配置 hello task'
    doFirst{
        println 'hello 動做'
    }
}
...
複製代碼

構建過程輸出（Build Output）以下：

Executing tasks: [:app:assembleDebug] in project E:\workspace\...

【settings.gradle 解析完成】
【初始化階段結束】

> Configure project :app
配置 app project
配置 hello task
【配置階段結束】

> Task :app:preBuild UP-TO-DATE
> Task :app:preDebugBuild UP-TO-DATE
> Task :app:checkDebugManifest UP-TO-DATE
> ...
> Task :app:assembleDebug
【構建過程結束 】

BUILD SUCCESSFUL in 14s
24 actionable tasks: 19 executed, 5 up-to-date
複製代碼

易混淆： Task 配置運行在「配置階段」，Task 動做運行在「執行階段」。

• 監聽 Task 有向無環圖生成

setting.gradle

gradle.getTaskGraph().addTaskExecutionGraphListener(new TaskExecutionGraphListener() {
    @Override
    void graphPopulated(TaskExecutionGraph graph) {
        println '【Task 有向無環圖生成】'
    }
})
複製代碼

4.3 執行階段（Execution phase）

在得到 Task 的有向無環圖以後，執行階段就是根據依賴關係依次執行 Task 動做。

4.4 監聽構建過程的耗時狀況

long beginOfSetting = System.currentTimeMillis()
def beginOfConfig = false
def configHasBegin = false
def beginOfProjectConfig = new HashMap()
def beginOfProjectExecute

gradle.projectsLoaded {
    println "【初始化階段結束】，總共耗時：" + (System.currentTimeMillis() - beginOfSetting) + "ms"
}
gradle.beforeProject { project ->
    if (!configHasBegin) {
        configHasBegin = true
        beginOfConfig = System.currentTimeMillis()
    }
    beginOfProjectConfig.put(project, System.currentTimeMillis())
}
gradle.afterProject { project ->
    def begin = beginOfProjectConfig.get(project)
    println "【配置 " + project + "】，耗時：" + (System.currentTimeMillis() - begin) + "ms"
}
gradle.taskGraph.whenReady {
    println "【配置階段結束】，總耗時：" + (System.currentTimeMillis() - beginOfConfig) + "ms"
    beginOfProjectExecute = System.currentTimeMillis()
}
gradle.taskGraph.beforeTask { task ->
    task.doFirst {
        task.ext.beginOfTask = System.currentTimeMillis()
    }
    task.doLast {
        println "【執行 " + task + "】，耗時：" + (System.currentTimeMillis() - task.beginOfTask) + "ms"
    }
}
gradle.buildFinished {
    // 若是工程中包含 buildSrc 目錄，對 buildSrc 項目的構建在這裏會 beginOfProjectExecute 空指針
    if(null != beginOfProjectExecute){
        println "【執行階段結束】，總耗時：" + (System.currentTimeMillis() - beginOfProjectExecute) + "ms"
    }
}
複製代碼

---

5. 總結

• 初始化階段： 解析 setting.gradle，爲包含的每一個項目實例化 Project 實例；
• 配置階段： 解析每一個項目中的 build.gradle 文件，完成「Project 配置」&「Task 配置」，並根據 Task 依賴關係來建立一個有向無環圖；
• 執行階段： 根據依賴關係依次執行 Task 動做。

---

參考資料

• 《實戰 Gradle》—— [美] Benjamin Muschko 著
• 《深度探索 Gradle 自動化構建技術（3、Gradle 核心解密）》 —— JsonChao 著

---

創做不易，你的「三連」是醜醜最大的動力，咱們下次見！