详解Gradle项目构建的生命周期

本文作者：黄少存，叩丁狼高级讲师。原创文章，转载请注明出处。

上一篇咱们已经知道了如何自定义任务了,而且也知道执行任务只需要点击下任务就 ok 了,还有直接写在任务中的代码在执行任意任务时都会被执行. 那为什么这些代码会被执行? 执行的顺序又是怎样的呢?请看一下Gradle 构建的生命周期就明了了.

Gradle 项目构建生命周期

Gradle 的生命周期分三个阶段,初始化阶段,配置阶段,执行阶段.那这三个阶段在做什么事情呢?请看每个阶段的描述

初始化阶段

通过 settings.gradle 判断有哪些项目需要初始化,加载所有需要初始化的项目的build.gradle 文件并为每个项目创建 project 对象

配置阶段

执行各项目下的 build.gradle 脚本，完成 project 的配置，并且构造 Task 任务依赖关系图以便在执行阶段按照依赖关系执行Task.执行task 中的配置代码

配置代码: 配置阶段就需要执行的代码,如下

task configCode{
   println 'config Code'
}

执行阶段

通过配置阶段的 Task 图,按顺序执行需要执行的 任务中的动作代码,就是执行任务中写在 doFirst 或 doLast 中的代码.

动作代码: 任务调用才会执行的代码.

task executeCode << {
   println 'execute Code'
}

以上就是 Gradle 构建项目时的生命周期,由于Gradle 的强大和易配性,如果想在构建的过程中去做一些额外的操作的话可以使用Gradle 自带的钩子方法.以下咱们通过一个图来描述 Gradle 的生命周期和钩子方法.

Gradle 生命周期和钩子方法

Gradle 项目构建中的钩子方法

上图表明了Gradle 构建的整个流程,在生命周期的三个阶段中有很多的钩子方法供用户自行覆盖使用.
注意:
1 初始化阶段的钩子方法和 gradle.beforeProject() 只能定义在 setting.gradle 或 init.gradle 脚本中.
执行 build.gradle 时已经有了 project 对象.且执行前就调用了beforeProject钩子方法.

2 gradle.buildStarted() 钩子方法无法执行到.
通过源码得知,在初始化前就已经调用了 buildStarted 方法,所以在初始化阶段无法回调的到.

例子

setting.gradle

rootProject.name = 'gradleWeb'

// 初始化阶段
gradle.settingsEvaluated {
    println '初始化阶段settingsEvaluated'

}
gradle.projectsLoaded  {
    println '初始化阶段 projectsLoaded'
}

// 配置阶段
gradle.beforeProject {
    println '配置阶段 beforeProject'
}

build.gradle

// 自定义任务
task t1 {
    println 't1 configuration'
    doLast {
        println 't1 execute doLast'
    }
    doFirst {
        println 't1 execute doFirst'
    }
}
// 钩子方法
gradle.afterProject {
    println '配置阶段 afterProject'
}
project.beforeEvaluate {
    println '配置阶段 beforeEvaluate'
}
gradle.projectsEvaluated {
    println '配置阶段 projectsEvaluated'
}
project.afterEvaluate {
    println '配置阶段 afterEvaluate'
}
gradle.taskGraph.whenReady {
    println '配置任务 whenReady'
}

// 执行阶段
gradle.taskGraph.beforeTask {
    println "执行阶段 before task"
}
gradle.taskGraph.afterTask {
    println "执行阶段 afterTask "
}
gradle.buildFinished {
    println '构建结束 buildFinished'
}

执行 gradle t1 结果如下

初始化阶段settingsEvaluated
初始化阶段 projectsLoaded

> Configure project :gradleWeb
15:16:02: Executing task 't1'...

初始化阶段 settingsEvaluated
初始化阶段 projectsLoaded

> Configure project :
配置阶段 beforeProject
t1 configuration
配置阶段 afterProject
配置阶段 afterEvaluate
配置阶段 projectsEvaluated
配置任务 whenReady

> Task :t1
执行阶段 before task
t1 execute doFirst
t1 execute doLast
执行阶段 afterTask 

BUILD SUCCESSFUL in 1s
1 actionable task: 1 executed
构建结束 buildFinished
15:16:03: Task execution finished 't1'.

以上就是Gradle 项目构建的生命周期和钩子方法的介绍,这些钩子方法一般使用得少,特殊需求情况下可以使用.
了解了生命周期之后让咱们对 Gradle 有一个更深入的理解.当然Gradle有很多的点值得咱们去学习和研究.比如一个比较重要的点,依赖管理.期待下篇 Gradle 的依赖管理.

想获取更多技术视频，请前往叩丁狼官网：http://www.wolfcode.cn/openClassWeb_listDetail.html