Gradle 如何工作(第二部分)- Daemon 内部

目录

介绍

回顾《Gradle 如何工作》系列

  1. Gradle 如何工作(第一部分)- 启动

这是《Gradle 如何工作》系列的第二篇博客。在这篇博客中,我们将解释 Gradle Daemon JVM 内部发生了什么。

为什么我们需要 Gradle Daemon? #

上一篇博客中,我们提到 Gradle 启动了一个 Gradle Daemon JVM(“daemon”)来运行构建。《用户指南》解释了为什么我们需要 daemon。

Daemon 是一个长期运行的后台进程,可以减少运行构建所需的时间。Daemon 通过以下方式减少构建时间:

  • 跨构建缓存项目信息

  • 在后台运行,因此每个 Gradle 构建都不必等待 JVM 启动

  • 受益于 JVM 中的持续运行时优化

  • 监视文件系统,以便在运行构建之前准确计算出需要重建的内容

Gradle daemon 在 Gradle 3.0 中引入,并在多年发展中变得成熟。它默认启用,我们不建议在任何情况下禁用它。

Daemon 中发生了什么? #

在 Gradle Client JVM(“客户端”)连接到兼容的空闲 daemon 后,它会将必要的构建信息(命令行参数、项目目录、环境变量等)发送到 daemon。然后,daemon 开始运行构建,并将构建输出(日志记录、stdout/stderr 等)发送回客户端。通信通过本地套接字连接进行。

但是 daemon 内部究竟发生了什么?《用户指南》解释说,Gradle 构建中有三个阶段:初始化配置执行

初始化阶段:构建对象的创建 #

现在 daemon 了解了关于构建的所有信息,它开始为构建创建内部表示。由于 Gradle 在 JVM 上运行,因此这些表示是 Java 对象。

例如,整个 Gradle 构建调用由一个 Gradle 实例表示。配置项目层级结构所需的配置由一个 Settings 实例表示。我们尝试构建的每个项目都有一个对应的 Project 实例。

GradleSettingsProject 也是 init、settings 和构建脚本的默认委托。这意味着这些对象可以在构建脚本中稍后进行交互。例如,当我们在构建脚本中说 println(name) 时,我们实际上是在 Project 实例上调用 Project.getName() 方法

配置阶段:构建脚本执行 #

在必要的 JVM 对象创建完成后,Gradle 将在 daemon 中加载并执行构建脚本。构建脚本通常在项目目录中命名为 X.gradle (Groovy DSL) 或 X.gradle.kts (Kotlin DSL)。Groovy 和 Kotlin 都是 JVM 语言,这意味着它们可以在 JVM(即 daemon JVM)内部无缝运行。

例如,以下 Groovy 构建脚本创建了一个 Groovy Closure 实例,并将 Closure 实例传递给在之前的初始化阶段创建的 Project 实例上的 Project.repositories(Closure) 方法

repositories {
    mavenCentral()
}

如果您在此阶段没有完全理解构建脚本执行,请不要担心。我们将在本系列的下一篇博客中解释构建脚本执行的细节。目前,我们可以简单地将 Gradle 理解为一个解释器,它逐行、从上到下地执行构建脚本。

构建脚本在 daemon JVM 内部填充构建的数据结构。例如,以下构建脚本代码片段将一个 hello 任务注册到 Gradle 的任务容器数据结构(即 TaskContainer 类),这意味着在需要时将创建一个 Task 实例。这个过程通常称为“配置”,即配置数据结构;这就是为什么这个阶段被称为“配置阶段”。

tasks.register("hello") {
    doLast {
        println("Hello world!")
    }
}

在构建脚本执行完成后,构建数据结构已配置了构建所需的必要数据。现在我们准备好进入下一个阶段:选择一些任务并执行它们。

执行阶段:选定任务的执行 #

在配置阶段之后,Gradle 在 daemon JVM 中存储了构建所需的所有必要数据。然后,它根据传递给 gradle 命令的参数确定要执行的任务子集,并执行每个选定的任务。

每个 Task 都有一个由要执行的代码块组成的动作列表。例如,如果您想知道 Test 任务的作用,只需在源代码中搜索 @TaskAction,您会找到

class Test {
    ...

    @TaskAction
    public void executeTests() {
        ...
    }
}

当我们说“执行一个任务”时,我们的意思是“其动作中的代码在 daemon JVM 中执行”。任务动作始终在 daemon JVM 中执行,但动作可以决定 fork 一些新的 JVM 并在 fork 的 JVM 中运行一些代码。

例如,Gradle Worker API 提供了一种将任务动作的执行分解成多个部分,然后在子进程中执行它们的方法。

另一个自定义任务动作 fork 额外 JVM 的示例是 Test 任务Test 任务动作在 daemon JVM 中执行,但在执行过程中,它会 fork 一些 JVM,并在 fork 的 JVM 中运行测试代码,以避免测试代码干扰 daemon JVM。

在构建结束时,daemon 将执行一些额外的操作,例如执行回调、报告错误(如果有)、发布构建扫描等。之后,Gradle Client JVM 与 daemon 断开连接并退出。daemon 现在已准备好进行下一次构建调用。

下一步 #

在本系列的下一篇博客中,我们将解释构建脚本执行的幕后原理。

讨论