「Gradle」| 进阶篇(Project & Task & 构建生命周期)

点赞关注,不再迷路,你的支持对我意义重大!

🔥 Hi,我是丑丑。本文 「Android 路线」| 导读 —— 从零到无穷大 已收录,这里有 Android 进阶成长路线笔记 & 博客,欢迎跟着彭丑丑一起成长。(联系方式在 GitHub)


目录


1. 前置知识

在 Gradle 中,build.gradle 脚本文件中每个元素都会映射一个 Java 类。其中最重要的两个类是 「Project」&「Task」。在这篇文章里,我将带你分析 Gradle 中 Project 与 Task 的原理与使用,以及分析 Gradle 构建的生命周期

这篇文章的内容会涉及以下前置 / 相关知识,贴心的我都帮你准备好了,请享用~


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 动作。

参考资料


创作不易,你的「三连」是丑丑最大的动力,我们下次见!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,542评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,596评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,021评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,682评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,792评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,985评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,107评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,845评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,299评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,612评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,747评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,441评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,072评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,828评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,069评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,545评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,658评论 2 350

推荐阅读更多精彩内容