Bazel 根据源代码构建软件,这些源代码在目录树中称为工作区。工作区中的源文件按软件包的嵌套层次结构进行整理,其中每个软件包都是一个目录,其中包含一组相关源文件和一个 BUILD
文件。BUILD
文件指定可以从源代码构建哪些软件输出。
工作区
工作区是文件系统中的一个目录树,其中包含要构建的软件的源文件。每个工作区都有一个名为 WORKSPACE
的文本文件,该文件可能为空,也可能包含对构建输出所需的外部依赖项的引用。
包含名为 WORKSPACE
的文件的目录被视为工作区的根目录。因此,Bazel 会忽略根目录位于包含 WORKSPACE
文件的子目录的工作区中的任何目录树,因为它们会形成另一个工作区。
Bazel 还支持将 WORKSPACE.bazel
文件用作 WORKSPACE
文件的别名。如果这两个文件都存在,则系统会使用 WORKSPACE.bazel
。
代码库
代码整理到各个repositories中。包含 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 作为输入。此依赖项的影响是,B 的头文件在编译期间可供 A 使用,B 的符号在关联期间可供 A 使用,并且 B 的运行时数据在执行期间可供 A 使用。
所有规则都有一个不变的原则是,规则生成的文件始终与该规则本身属于同一个软件包;系统无法将文件生成到另一个软件包中。不过,规则的输入来自另一个软件包的情况并不少见。
软件包组是一系列软件包,其目的是限制某些规则的可访问性。软件包组由 package_group
函数定义。它们具有三个属性:所包含的软件包列表、名称以及所包含的其他软件包组。唯一允许的方式是通过规则的 visibility
属性或 package
函数的 default_visibility
属性引用它们;它们不会生成或使用文件。如需了解详情,请参阅 package_group
文档。