外部依赖项概览

Bazel 支持外部依赖项，即 build 中使用的并非来自工作区的源文件（文本和二进制文件）。例如，它们可能是托管在 GitHub 代码库中的规则集、Maven 工件或本地机器上当前工作区之外的目录。

从 Bazel 6.0 开始，您可以通过两种方法使用 Bazel 管理外部依赖项：以仓库为中心的传统 WORKSPACE 系统，以及以模块为中心的新版 MODULE.bazel 系统（代号为 Bzlmod 且使用标志 --enable_bzlmod 启用）。这两个系统可以一起使用，但 Bzlmod 将在未来 Bazel 版本中替换 WORKSPACE 系统，请参阅 Bz1} 迁移指南，了解 Bazel 的迁移指南。

本文档首先介绍了与 Bazel 中的外部依赖项管理相关的概念，然后有条理地详细介绍了这两个系统。

概念

代码库

一个目录树，其根目录包含边界标记文件，其中包含可在 Bazel build 中使用的源文件。通常缩写为“repo”。

代码库边界标记文件可以是 MODULE.bazel（表示此代码库代表 Bazel 模块）、REPO.bazel（请参阅下文），或者在旧版上下文中，可以是 WORKSPACE 或 WORKSPACE.bazel。任何代码库边界标记文件都将表示代码库的边界；一个目录中可以共存多个此类文件。

主代码库

当前 Bazel 命令正在运行的代码库。

主代码库的根目录也称为工作区根目录。

工作区

在同一主仓库中运行的所有 Bazel 命令共享的环境。它包含主代码库以及所有已定义的外部代码库的集合。

请注意，过去“仓库”和“工作区”的概念已被混淆；术语“工作区”通常用于指代主仓库，有时甚至用作“仓库”的同义词。

规范代码库名称

代码库的规范名称。在工作区环境中，每个代码库都有一个规范名称。对于规范名称为 canonical_name 的代码库中的目标，可以使用标签 @@canonical_name//pac/kage:target（请注意，双精度 @）寻址。

主代码库始终使用空字符串作为规范名称。

显而易见的代码库名称

在某个其他代码库的上下文中可用于访问某个代码库的名称。这可以被视为代码库的“别名”：具有规范名称 michael 的代码库在代码库 alice 的上下文中可能具有显式名称 mike，但在代码库 bob 的上下文中可能具有显式名称 mickey。在这种情况下，michael 内的目标可以在 alice 上下文中通过标签 @mike//pac/kage:target 进行寻址（请注意，只有一个 @）。

反之，这也可以理解为代码库映射：每个代码库都维护一个从“表面代码库名称”到“规范代码库名称”的映射。

代码库规则

代码库定义的架构，用于告知 Bazel 如何具体化代码库。例如，它可以是“从特定网址下载 zip 归档文件并将其解压缩”，也可以是“提取特定 Maven 工件并将其作为 java_import 目标提供”，或者只是“创建本地目录符号”。每个代码库都是通过调用包含适当数量参数的代码库规则来定义的。

如需详细了解如何编写您自己的代码库规则，请参阅代码库规则。

到目前为止，最常见的代码库规则是 http_archive，用于从网址下载归档文件并将其解压缩，以及 local_repository，用于符号链接已是 Bazel 代码库的本地目录。

提取代码库

通过运行与代码库关联的代码库规则使代码库在本地磁盘上可用的操作。在提取之前，工作区中定义的代码库无法在本地磁盘上使用。

通常情况下，只有在 Bazel 需要从某个代码库中获取内容且该代码库尚未提取时，才会提取该代码库。如果之前已提取过代码库，则只有在其定义发生更改时，Bazel 才会重新提取该代码库。

fetch 命令可用于为代码库、目标或所有必要的代码库启动预提取，以便执行任何 build。此功能支持使用 --nofetch 选项进行离线构建。

--fetch 选项用于管理网络访问权限。其默认值为 true。 不过，如果设置为 false (--nofetch)，该命令将使用依赖项的任何缓存版本，如果不存在，该命令将导致失败。

如需详细了解如何控制提取，请参阅提取选项。

目录布局

提取后，您可以在输出基础目录的子目录 external 中找到该代码库，并在其规范名称下找到该代码库。

您可以运行以下命令来查看规范名称为 canonical_name 的代码库的内容：

ls $(bazel info output_base)/external/ canonical_name

REPO.bazel 文件

REPO.bazel 文件用于标记构成代码库的目录树的最顶层边界。它无需包含任何内容即可用作代码库边界文件；不过，它还可用于为代码库内的所有构建目标指定一些常见属性。

REPO.bazel 文件的语法与 BUILD 文件类似，不同之处在于它不支持 load 语句，并且只有一个函数 repo()。repo() 采用与 BUILD 文件中的 package() 函数相同的参数；而 package() 为软件包内的所有构建目标指定通用属性，而 repo() 则以类似方式为代码库中的所有构建目标指定通用属性。

例如，您可以使用以下 REPO.bazel 文件为代码库中的所有目标指定通用许可：

repo(
    default_package_metadata = ["//:my_license"],
)

使用 Bzlmod 管理外部依赖项

新的外部依赖项子系统 Bzlmod 不直接使用代码库定义。相反，它会从模块构建依赖关系图，在该图表之上运行扩展，并相应地定义代码库。

Bazel 模块是指可以有多个版本的 Bazel 项目，每个版本都会发布有关其所依赖的其他模块的元数据。模块必须在其代码库根目录的 WORKSPACE 文件旁边有一个 MODULE.bazel 文件。此文件是模块的清单，用于声明其名称、版本、依赖项列表等信息。以下是一个基本示例：

module(name = "my-module", version = "1.0")

bazel_dep(name = "rules_cc", version = "0.0.1")
bazel_dep(name = "protobuf", version = "3.19.0")

模块只能列出其直接依赖项，Bzlmod 会在 Bazel 注册库（默认为 Bazel 中央注册库）中查找这些依赖项。注册表提供了依赖项的 MODULE.bazel 文件，可让 Bazel 在执行版本解析之前发现整个传递依赖关系图。

版本解析（即为每个模块选择一个版本）后，Bazel 会再次查询注册表，以了解如何为每个模块定义代码库（在大多数情况下，使用 http_archive）。

模块还可以指定称为“标记”的自定义数据，它们在模块解析后由模块扩展使用，以定义其他代码库。这些扩展程序具有与 Repo 规则类似的功能，使它们能够执行文件 I/O 和发送网络请求等操作。除此之外，它们还允许 Bazel 与其他软件包管理系统交互，同时遵循由 Bazel 模块构建的依赖项图。

使用 WORKSPACE 定义代码库

过去，您可以通过在 WORKSPACE（或 WORKSPACE.bazel）文件中定义代码库来管理外部依赖项。此文件的语法与 BUILD 文件类似，采用的是代码库规则，而不是 build 规则。

以下代码段展示了如何在 WORKSPACE 文件中使用 http_archive 代码库规则：

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "foo",
    urls = ["https://example.com/foo.zip"],
    sha256 = "c9526390a7cd420fdcec2988b4f3626fe9c5b51e2959f685e8f4d170d1a9bd96",
)

该代码段定义了一个规范名称为 foo 的代码库。在 WORKSPACE 系统中，默认情况下，代码库的规范名称也是所有其他代码库的明显名称。

请参阅 WORKSPACE 文件中可用函数的完整列表。

WORKSPACE 系统的缺点

在 WORKSPACE 系统推出后的几年中，用户反馈了许多痛点，包括：

  • Bazel 不会评估任何依赖项的 WORKSPACE 文件，因此除了直接依赖项之外，所有传递依赖项都必须在主代码库的 WORKSPACE 文件中定义。
  • 为了解决此问题，项目采用了“deps.bzl”模式，该模式定义了一个宏，而该宏又定义了多个代码库，并要求用户在其 WORKSPACE 文件中调用此宏。
    • 这有自己的问题：宏无法 load 其他 .bzl 文件，因此这些项目必须在此“deps”宏中定义其传递依赖项，或者让用户调用多个分层的“deps”宏来解决此问题。
    • Bazel 会依序评估 WORKSPACE 文件。此外，依赖项是使用 http_archive 和网址指定的，不含任何版本信息。这意味着，在钻石依赖项的情况下（A 依赖于 B 和 C；B 和 C 都依赖于不同版本的 D），没有可靠的方法来执行版本解析。

由于 WORKSPACE 存在缺点，Bzlmod 将在未来的 Bazel 版本中取代旧版 WORKSPACE 系统。请参阅 Bzlmod 迁移指南，了解如何迁移到 Bzlmod。