扩展程序概览

本页介绍了如何使用宏和规则扩展 BUILD 语言。

Bazel 扩展程序是以 .bzl 结尾的文件。使用 load 语句从扩展程序导入符号。

在学习更高级的概念之前,请先执行以下操作:

宏和规则

是用于实例化规则的函数。当 BUILD 文件重复或过于复杂时,该工具很有用,因为它允许您重复使用一些代码。系统会在读取 BUILD 文件后立即对该函数进行求值。评估 BUILD 文件后,Bazel 几乎没有关于宏的信息:如果您的宏生成了 genrule,则 Bazel 的行为方式就像您编写了 genrule 一样。因此,bazel query 将仅列出生成的 genrule

规则比宏更强大。它可以访问 Bazel 内部 并完全控制相关情况例如,它可能会将信息传递给其他规则。

如果您想重复使用简单的逻辑,请从宏入手。如果宏变得复杂,通常最好将其设为规则。对新语言的支持通常通过规则来完成。规则面向高级用户,大多数用户永远无需编写规则,他们只会加载和调用现有规则。

评估模型

一个构建包含三个阶段。

  • 加载阶段。首先,加载并评估构建所需的所有扩展程序和所有 BUILD 文件。BUILD 文件的执行只是将规则实例化(每次调用规则时,系统都会将其添加到图中)。这是对宏求值的位置。

  • 分析阶段。系统会执行规则的代码(其 implementation 函数),并实例化操作。操作描述了如何根据一组输入生成一组输出,例如“run gcc on hello.c and get hello.o”。在执行实际命令之前,您必须明确列出将生成哪些文件。换言之,分析阶段将采用加载阶段生成的图并生成操作图。

  • 执行阶段。当需要至少一个输出时,便会执行操作。如果文件缺失或命令无法生成输出,构建会失败。也会在此阶段运行测试。

Bazel 使用并行处理来读取、解析和评估 .bzl 文件和 BUILD 文件。每个构建最多读取一次文件,并缓存评估结果并重复使用。只有在所有依赖项(load() 语句)都解析完后,才会对文件求值。根据设计,加载 .bzl 文件不会产生明显的附带效应,它只定义值和函数。

Bazel 试图变得聪明:它使用依赖关系分析来确定必须加载哪些文件、必须分析哪些规则以及必须执行哪些操作。例如,如果规则生成当前构建不需要的操作,系统不会执行这些操作。

创建附加信息

您编写自己的扩展程序时,以下两个链接会非常有用。让用户触手可及:

更进一步

除了规则之外,您可能还想编写方面仓库规则