构建文件

报告问题 查看源代码

前面部分简要介绍了软件包、目标和标签以及 build 依赖关系图。本部分介绍了用于定义软件包的具体语法。

根据定义,每个软件包都包含一个 BUILD 文件,该文件是一个短程序。

使用命令式语言 StarlarkBUILD 文件进行评估。

它们被解释为依序语句列表。

一般来说,顺序很重要:例如,必须先定义变量,然后才能使用变量。不过,大多数 BUILD 文件仅包含构建规则的声明,这些语句的相对顺序无关紧要;重要的是,在软件包评估完成之前,声明了哪些规则以及使用的值。

当执行构建规则函数(例如 cc_library)时,它会在图中创建一个新目标。此目标日后可以使用标签进行引用。

在简单的 BUILD 文件中,规则声明可以自由重新排序,而不会改变行为。

为鼓励将代码与数据完全分离开来,BUILD 文件不能包含函数定义、for 语句或 if 语句(但允许使用列表理解和 if 表达式)。您可以改为在 .bzl 文件中声明函数。此外,BUILD 文件中不允许使用 *args**kwargs 参数;请改为明确列出所有参数。

至关重要的是,Starlark 中的程序无法执行任意 I/O。这种不变性使 BUILD 文件的解释是封闭的,即仅依赖于一组已知的输入,这对于确保 build 的可重现性至关重要。如需了解详情,请参阅封闭性

BUILD 文件应仅使用 ASCII 字符写入,但从技术上讲,它们是使用 Latin-1 字符集解释的。

由于每当底层代码的依赖项发生变化时都需要更新 BUILD 文件,因此这些文件通常由一个团队中的多人进行维护。BUILD 文件作者应通过注释充分记录每个 build 目标的角色(无论其是否用于公开用途),并记录软件包本身的作用。

加载扩展程序

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

load("//foo/bar:file.bzl", "some_library")

此代码会加载文件 foo/bar/file.bzl 并向环境添加 some_library 符号。此类型可用于加载新规则、函数或常量(例如字符串或列表)。通过在调用 load 时使用其他参数,可以导入多个符号。参数必须是字符串字面量(无变量),并且 load 语句必须出现在顶层 - 它们不能位于函数正文中。

load 的第一个参数是标识 .bzl 文件的标签。如果是相对标签,则会根据包含当前 bzl 文件的软件包(而非目录)进行解析。load 语句中的相对标签应使用前导 :

load 也支持别名,因此,您可以为导入的符号分配不同的名称。

load("//foo/bar:file.bzl", library_alias = "some_library")

您可以在一个 load 语句中定义多个别名。此外,参数列表可以同时包含别名和常规符号名称。以下示例是完全合法的(请注意何时使用引号)。

load(":my_rules.bzl", "some_rule", nice_alias = "some_other_rule")

.bzl 文件中,以 _ 开头的符号不会被导出,并且无法从其他文件加载。

您可以使用加载可见性来限制哪些用户可以加载 .bzl 文件。

构建规则的类型

大多数构建规则都属于系列规则,并按语言分组。例如,cc_binarycc_librarycc_test 分别是 C++ 二进制文件、库和测试的构建规则。其他语言使用相同的命名方案,但前缀不同,例如 Java 的 java_*构建百科全书中记录了其中一些函数,但任何人都可以创建新规则。

  • *_binary 规则用于构建使用给定语言的可执行程序。构建完成后,可执行文件将位于构建工具的二进制输出树中与规则标签的相应名称处,因此 //my:program 将显示在(举例来说)$(BINDIR)/my/program 处。

    在某些语言中,此类规则还会创建一个 runfiles 目录,其中包含属于该规则的 data 属性或其传递性闭包中的任何规则中提及的所有文件;为便于部署到生产环境,将这组文件收集到一个位置。

  • *_test 规则是 *_binary 规则的专用规则,用于自动测试。测试就是在成功时返回零的程序。

    与二进制文件一样,测试也具有 runfile 树,并且其下的文件是测试在运行时可以合法打开的唯一文件。例如,程序 cc_test(name='x', data=['//foo:bar']) 可能会在执行期间打开并读取 $TEST_SRCDIR/workspace/foo/bar。(每种编程语言都有自己的实用函数来访问 $TEST_SRCDIR 的值,但它们都等同于直接使用环境变量)。如果未能遵守规则,将导致在远程测试主机上执行测试时失败。

  • *_library 规则指定采用给定编程语言单独编译的模块。库可以依赖于其他库,而二进制文件和测试可以依赖于库,并具有预期的单独编译行为。

标签 依赖项