外部依赖项概览

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

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

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

本文档将先介绍 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。在这种情况下，在 alice 的上下文中，michael 内的目标可以通过标签 @mike//pac/kage:target 来寻址（请注意单个 @）。

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

代码库规则

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

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

目前最常见的代码库规则是 http_archive（用于从网址下载归档并提取归档）和 local_repository（用于对已是 Bazel 代码库的本地目录进行符号链接）。

提取代码库

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

通常，Bazel 仅在需要从代码库中获取某些内容且尚未获取该代码库时才会提取代码库。如果之前已提取过相应代码库，则 Bazel 仅在代码库的定义发生变化时重新提取。

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

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

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

目录布局

提取后，您可以在输出库的子目录 external 中找到该代码库，其名称为标准名称。

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

ls $(bazel info output_base)/external/ canonical_name

REPO.bazel 文件

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

REPO.bazel 文件的语法与 BUILD 文件类似，但不支持 load 语句，并且仅提供一个函数 repo()。repo() 采用与 BUILD 文件中的 package() 函数相同的实参；而 package() 用于指定软件包内所有 build 目标的通用属性，repo() 则以类似方式指定 repo 内所有 build 目标的通用属性。

例如，您可以通过创建以下 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 文件类似，但采用的是 repo 规则，而不是 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。