「Gradle」| 進(jìn)階篇（Project & Task & 構(gòu)建生命周期）

點(diǎn)贊關(guān)注，不再迷路，你的支持對我意義重大！

?? Hi，我是丑丑。本文 「Android 路線」| 導(dǎo)讀 —— 從零到無窮大 已收錄，這里有 Android 進(jìn)階成長路線筆記 & 博客，歡迎跟著彭丑丑一起成長。（聯(lián)系方式在 GitHub）

目錄

1. 前置知識

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

這篇文章的內(nèi)容會涉及以下前置 / 相關(guān)知識，貼心的我都幫你準(zhǔn)備好了，請享用~

2. Project 項(xiàng)目

Project 代表一個(gè)構(gòu)建組件，在「構(gòu)建-初始化階段」，Gradle 引擎會為每個(gè) build.gradle 腳本文件實(shí)例化一個(gè) Project 實(shí)例。 所以我們在 build.gradle 中編寫的構(gòu)建邏輯，本質(zhì)上相當(dāng)于編寫在 Project 類內(nèi)部。

org.gradle.api.Project.java

public interface Project extends Comparable<Project>, ExtensionAware, PluginAware {
}

Editting...

3. Task 任務(wù)

一個(gè) Project 由一個(gè)或多個(gè) Task 組成，Task 代表一個(gè)可執(zhí)行的任務(wù)。

org.gradle.api.Task.java

public interface Task extends Comparable<Task>, ExtensionAware
}

3.1 定義 Task

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

  • 使用 task 函數(shù)：
task('hello')
task('world') {
}
  • 使用 DSL 語言：
task(hello)
task(world) {
}
  • 使用 tasks container：
tasks.create('hello')
tasks.create('world') {
}

3.2 Task 屬性

定義 Task 之后，就可以設(shè)置屬性，設(shè)置屬性的語法主要有兩種：

  • 在創(chuàng)建 Task 時(shí)設(shè)置：
task hello(group : 'MyTask')
  • 調(diào)用 setter 設(shè)置：
task hello {
    setGroup('MyTask')
}

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

task hello(group : 'MyTask') {
    println "$group"
    println getGroup()
}

Task 中比較常用的屬性有：

屬性 描述
name Task 標(biāo)識符，在定義 Task 時(shí)指定
group Task 所屬的組
description Task 的描述信息
type Task類型，默認(rèn)為 DefaultTask（見 第 3.7 節(jié)）
actions 動作列表（見 第 3.3 節(jié)）
dependsOn 依賴 Task 集合

Task 最重要的三個(gè)概念是「Task 動作」&「Task 依賴」&「Task 配置」：

3.3 Task 動作

動作（action）就是 Task 中的構(gòu)建邏輯，這些構(gòu)建邏輯在「構(gòu)建-執(zhí)行階段」運(yùn)行。Task 接口提供了兩個(gè)方法來聲明 Task 任務(wù)：

動作 描述
doFirst(Closure) 表示 Task 的第一個(gè)動作
doLast(Closure) 表示 Task 的最后一個(gè)動作

例如：

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 往往不是獨(dú)立存在的，而是與其他 Task 存在依賴關(guān)系，使用 dependsOn 方法來聲明依賴一個(gè)或多個(gè) 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 配置運(yùn)行在「構(gòu)建-配置階段」，Task 動作運(yùn)行在「構(gòu)建-執(zhí)行階段」，配置代碼永遠(yuǎn)在動作代碼之前執(zhí)行。

3.7 自定義 Task

3.8 Task 類型

4. 理解 Gradle 構(gòu)建生命周期

無論什么時(shí)候執(zhí)行 Gradle 構(gòu)建，都會先后執(zhí)行三個(gè)生命周期階段 ——「初始化」&「配置」&「執(zhí)行」：

4.1 初始化階段（Initiliazation phase）

在初始化階段，Gradle 會解析工程根目錄下的setting.gradle文件，并構(gòu)造一個(gè) Settings 實(shí)例。Settings 是一個(gè)接口，主要包含以下方法：

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 方法你應(yīng)該很熟悉了，include 方法指定了參與構(gòu)建的項(xiàng)目（build.gradle）。在初始化階段，Gradle 會為「包含」的每個(gè)的項(xiàng)目實(shí)例化一個(gè) Project 實(shí)例。

setting.gradle

include ':app'

在 setting.gradle 里，你還可以做這些事：

  • include 指定目錄下的項(xiàng)目

Gradle 默認(rèn)會在工程根目錄下尋找 include 包含的項(xiàng)目，那么如果你想包含其他目錄下的項(xiàng)目，可以這樣配置：

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

project(:video).projectDir = new File("..\\libs\\video")
  • 監(jiān)聽生命周期

在 setting.gradle 里，可以對構(gòu)建過程中的節(jié)點(diǎn)增加監(jiān)聽，監(jiān)聽器添加在Setting.getGradle() 實(shí)例上：

setting.gradle

include ':app'

gradle.addBuildListener(new BuildListener() {
    void buildStarted(Gradle var1) {
        println '【開始構(gòu)建】'
    }
    void settingsEvaluated(Settings var1) {
        // 注意：在這里不能訪問 var1.gradle.rootProject，因?yàn)?Project 還沒有初始化
        println '【settings.gradle 解析完成】'
    }
    void projectsLoaded(Gradle var1) {
        println '【初始化階段結(jié)束】'
    }
    void projectsEvaluated(Gradle var1) {
        println '【配置階段結(jié)束】'
    }
    void buildFinished(BuildResult var1) {
        println '【構(gòu)建過程結(jié)束】'
    }
})

構(gòu)建過程輸出（Build Output）如下：

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

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

【這里是配置階段】
【配置階段結(jié)束】

> Task :app:preBuild UP-TO-DATE
> Task :app:preDebugBuild UP-TO-DATE
> Task :app:checkDebugManifest UP-TO-DATE
> ...
> Task :app:assembleDebug
【構(gòu)建過程結(jié)束】

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

除了設(shè)置監(jiān)聽器方法，還可以直接設(shè)置閉包，例如：

gradle.projectsLoaded {
    println '【初始化階段結(jié)束】'
}

4.2 配置階段（Configration phase）

在配置階段，Gradle 會解析每個(gè)項(xiàng)目中的 build.gradle 文件，完成「Project 配置」&「Task 配置」，并根據(jù) Task 依賴關(guān)系來創(chuàng)建一個(gè)有向無環(huán)圖。例如：

build.gradle

apply plugin: 'com.android.application'

println '配置 app project'

task hello {
    println '配置 hello task'
    doFirst{
        println 'hello 動作'
    }
}
...

構(gòu)建過程輸出（Build Output）如下：

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

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

> Configure project :app
配置 app project
配置 hello task
【配置階段結(jié)束】

> Task :app:preBuild UP-TO-DATE
> Task :app:preDebugBuild UP-TO-DATE
> Task :app:checkDebugManifest UP-TO-DATE
> ...
> Task :app:assembleDebug
【構(gòu)建過程結(jié)束 】

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

易混淆： Task 配置運(yùn)行在「配置階段」，Task 動作運(yùn)行在「執(zhí)行階段」。

  • 監(jiān)聽 Task 有向無環(huán)圖生成

setting.gradle

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

4.3 執(zhí)行階段（Execution phase）

在獲得 Task 的有向無環(huán)圖之后，執(zhí)行階段就是根據(jù)依賴關(guān)系依次執(zhí)行 Task 動作。

4.4 監(jiān)聽構(gòu)建過程的耗時(shí)情況

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

gradle.projectsLoaded {
    println "【初始化階段結(jié)束】，總共耗時(shí)：" + (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 + "】，耗時(shí)：" + (System.currentTimeMillis() - begin) + "ms"
}
gradle.taskGraph.whenReady {
    println "【配置階段結(jié)束】，總耗時(shí)：" + (System.currentTimeMillis() - beginOfConfig) + "ms"
    beginOfProjectExecute = System.currentTimeMillis()
}
gradle.taskGraph.beforeTask { task ->
    task.doFirst {
        task.ext.beginOfTask = System.currentTimeMillis()
    }
    task.doLast {
        println "【執(zhí)行 " + task + "】，耗時(shí)：" + (System.currentTimeMillis() - task.beginOfTask) + "ms"
    }
}
gradle.buildFinished {
    // 如果工程中包含 buildSrc 目錄，對 buildSrc 項(xiàng)目的構(gòu)建在這里會 beginOfProjectExecute 空指針
    if(null != beginOfProjectExecute){
        println "【執(zhí)行階段結(jié)束】，總耗時(shí)：" + (System.currentTimeMillis() - beginOfProjectExecute) + "ms"
    }
}

5. 總結(jié)

  • 初始化階段： 解析 setting.gradle，為包含的每個(gè)項(xiàng)目實(shí)例化 Project 實(shí)例；
  • 配置階段： 解析每個(gè)項(xiàng)目中的 build.gradle 文件，完成「Project 配置」&「Task 配置」，并根據(jù) Task 依賴關(guān)系來創(chuàng)建一個(gè)有向無環(huán)圖；
  • 執(zhí)行階段： 根據(jù)依賴關(guān)系依次執(zhí)行 Task 動作。

參考資料

創(chuàng)作不易，你的「三連」是丑丑最大的動力，我們下次見！

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容