扩展程序概览

报告问题 查看源代码

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

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

在学习更高级的概念之前，请先：

宏和规则

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

规则比宏更强大。它可以访问 Bazel 内部 并且可以完全控制最新动态例如，它可以将信息传递给其他规则。

如果您想重复使用简单的逻辑，请从宏入手。如果宏变得很复杂，通常最好使其成为规则。对新语言的支持通常通过规则来实现。规则适用于高级用户，大多数用户永远不需要编写规则，而只会加载和调用现有规则。

评估模型

build 由三个阶段组成。

  • 加载阶段。首先，加载并评估 build 所需的所有扩展程序和所有 BUILD 文件。执行 BUILD 文件只是将规则实例化（每次调用规则时，规则都会添加到图表中）。这是对宏求值的位置。

  • 分析阶段。系统会执行规则的代码（其 implementation 函数），并实例化操作。操作描述如何根据一组输入生成一组输出，例如“在 hello.c 上运行 gcc 并获取 hello.o”。在执行实际命令之前，您必须明确列出将生成的文件。换言之，分析阶段会获取加载阶段生成的图表，并生成操作图。

  • 执行阶段。当至少需要其中一个输出时，系统才会执行操作。如果文件缺失或某个命令无法生成一项输出，则构建会失败。在此阶段，系统也会运行测试。

Bazel 使用并行性来读取、解析和评估 .bzl 文件和 BUILD 文件。每个构建最多读取一个文件，并且会缓存和重复使用评估结果。只有在文件的所有依赖项（load() 语句）都得到解决后，系统才会对文件求值。根据设计，加载 .bzl 文件不会产生可见的副作用，它仅定义了值和函数。

Bazel 试图变得聪明：它使用依赖关系分析来了解必须加载哪些文件、必须分析哪些规则以及必须执行哪些操作。例如，如果规则生成的操作对于当前 build 不需要，则不会执行。

创建附加信息

在自行编写扩展程序时，以下两个链接将非常有用。确保这些设备触手可及：

更进一步

除了宏和规则之外，您可能还需要编写方面和仓库规则。