代码库、工作区、软件包和目标

7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bazel 会根据以目录树(称为代码库)形式整理的源代码构建软件。工作区由一组定义的代码库组成。代码库中的源文件按软件包的嵌套层次结构进行整理,其中每个软件包都是一个目录,其中包含一组相关源文件和一个 BUILD 文件。BUILD 文件指定可以从源代码构建哪些软件输出。

代码库

Bazel 构建中使用的源文件会整理到代码库(通常缩写为代码库)中。代码库是指在根目录中包含边界标记文件的目录树;此类边界标记文件可以是 MODULE.bazelREPO.bazel,或者在旧版上下文中,可以是 WORKSPACEWORKSPACE.bazel

当前正在运行 Bazel 命令的代码库称为主代码库。其他(外部)代码库由代码库规则定义;如需了解详情,请参阅外部依赖项概览

工作区

工作区是从同一主代码库运行的所有 Bazel 命令共享的环境。它包含主代码库和一组所有已定义的外部代码库。

请注意,在历史上,“代码库”和“工作区”这两个概念一直被混淆;“工作区”一词通常用于指代主代码库,有时甚至用作“代码库”的同义词。

软件包

代码库中代码组织的主要单元是软件包。软件包是相关文件的集合,以及有关如何使用它们来生成输出工件的规范。

软件包定义为包含名为 BUILDBUILD.bazelBUILD 文件的目录。软件包包含其目录中的所有文件,以及其下方的所有子目录(自身包含 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 文档

标签