工作区、软件包和目标

报告问题 查看源代码 每夜版 · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

Bazel 根据源代码构建软件,这些源代码组织在一个名为工作区的目录树中。工作区中的源文件以嵌套的软件包层次结构进行整理,其中每个软件包都是一个目录,包含一组相关的源文件和一个 BUILD 文件。BUILD 文件指定了可以从源代码构建哪些软件输出。

工作区

工作区是文件系统上的一个目录树,其中包含您要构建的软件的源文件。每个工作区都有一个名为 WORKSPACE 的文本文件,该文件可以为空,也可以包含构建输出所需的外部依赖项的引用。

包含名为 WORKSPACE 的文件的目录被视为工作区的根目录。因此,如果工作区中的任何目录树以包含 WORKSPACE 文件的子目录为根,Bazel 都会忽略这些目录树,因为它们会构成另一个工作区。

Bazel 还支持将 WORKSPACE.bazel 文件作为 WORKSPACE 文件的别名。如果这两个文件都存在,则使用 WORKSPACE.bazel

代码库

代码整理在代码库中。包含 WORKSPACE 文件的目录是主代码库的根目录,也称为 @。其他(外部)代码库在 WORKSPACE 文件中使用工作区规则定义,或从 Bzlmod 系统中的模块和扩展程序生成。如需了解详情,请参阅外部依赖项概览

Bazel 捆绑的工作区规则记录在构建百科全书工作区规则部分以及有关嵌入式 Starlark 代码库规则的文档中。

由于外部代码库本身也是代码库,因此通常也包含 WORKSPACE 文件。不过,Bazel 会忽略这些额外的 WORKSPACE 文件。特别是,以传递方式依赖的代码库不会自动添加。

软件包

代码库中的主要代码组织单元是软件包。软件包是一组相关文件,以及有关如何使用这些文件来生成输出制品的规范。

软件包是指包含名为 BUILD(或 BUILD.bazel)的文件的目录。软件包包含其目录中的所有文件以及其下的所有子目录,但本身包含 BUILD 文件的子目录除外。根据此定义,任何文件或目录都不得属于两个不同的软件包。

例如,在以下目录树中,有两个软件包,即 my/app 和子软件包 my/app/tests。请注意,my/app/data 不是软件包,而是属于软件包 my/app 的目录。

src/my/app/BUILD
src/my/app/app.cc
src/my/app/data/input.txt
src/my/app/tests/BUILD
src/my/app/tests/test.cc

目标

软件包是目标的容器,目标在软件包的 BUILD 文件中定义。大多数目标都属于两种主要类型之一:文件规则

文件进一步分为两类。源文件通常由人工编写,并签入到代码库中。生成的文件(有时称为派生文件或输出文件)不会签入,而是从源文件生成。

第二种目标通过规则进行声明。每个规则实例都指定了一组输入文件与一组输出文件之间的关系。规则的输入可以是源文件,也可以是其他规则的输出。

在大多数情况下,规则的输入是源文件还是生成的文件并不重要;重要的是该文件的内容。这样一来,您就可以轻松地将复杂的源文件替换为由规则生成的文件,例如,当手动维护高度结构化的文件的负担变得过于繁重时,有人编写了一个程序来派生该文件。该文件的使用者无需进行任何更改。相反,如果源文件仅包含本地更改,则可以轻松替换生成的文件。

规则的输入还可以包括其他规则。此类关系的精确含义通常非常复杂,并且取决于语言或规则,但从直观上讲,它很简单:C++ 库规则 A 可能有另一个 C++ 库规则 B 作为输入。此依赖项的效果是,在编译期间,A 可以使用 B 的头文件;在链接期间,A 可以使用 B 的符号;在执行期间,A 可以使用 B 的运行时数据。

所有规则的一个不变量是,规则生成的文件始终属于与规则本身相同的软件包;无法将文件生成到另一个软件包中。不过,规则的输入来自其他软件包的情况并不少见。

软件包组是一组软件包,其目的是限制某些规则的可访问性。软件包组由 package_group 函数定义。它们具有三个属性:所包含的软件包列表、名称以及所包含的其他软件包组。引用它们的唯一允许方式是通过规则的 visibility 属性或 package 函数的 default_visibility 属性;它们不会生成或使用文件。如需了解详情,请参阅 package_group 文档

标签