构建文件

报告问题 查看源代码 每夜 build · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

前面几部分抽象地介绍了软件包、目标和标签以及构建依赖项图。本部分介绍了用于定义软件包的具体语法。

从定义上讲,每个软件包都包含一个 BUILD 文件,这是一个简短的程序。

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

它们会被解释为一系列顺序语句。

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

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

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

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

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

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 文件。

build 规则类型

大多数 build 规则都属于某个家族,并按语言分组。例如,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 规则用于指定给定编程语言中单独编译的模块。库可以依赖于其他库,二进制文件和测试可以依赖于库,并具有预期的分开发译行为。

标签 依赖项