有关外部依赖项的高级主题

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

WORKSPACE 中的影子依赖项

请尽可能在项目中采用单一版本政策,这是您编译时所依赖的依赖项以及最终二进制文件中所包含的依赖项所必需的。对于其他情况,您可以隐藏依赖项:

myproject/WORKSPACE

workspace(name = "myproject")

local_repository(
    name = "A",
    path = "../A",
)
local_repository(
    name = "B",
    path = "../B",
)

A/WORKSPACE

workspace(name = "A")

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

B/WORKSPACE

workspace(name = "B")

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

依赖项 AB 都依赖于不同版本的 testrunner。通过在 myproject/WORKSPACE 中为它们指定不同的名称,将它们都包含在 myproject 中,而不会发生冲突:

workspace(name = "myproject")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "testrunner-v1",
    urls = ["https://github.com/testrunner/v1.zip"],
    sha256 = "..."
)
http_archive(
    name = "testrunner-v2",
    urls = ["https://github.com/testrunner/v2.zip"],
    sha256 = "..."
)
local_repository(
    name = "A",
    path = "../A",
    repo_mapping = {"@testrunner" : "@testrunner-v1"}
)
local_repository(
    name = "B",
    path = "../B",
    repo_mapping = {"@testrunner" : "@testrunner-v2"}
)

您还可以使用此机制加入钻石。例如,如果 AB 具有相同的依赖项,但以不同的名称调用该依赖项,请在 myproject/WORKSPACE 中联接这些依赖项。

通过命令行替换代码库

如需通过命令行使用本地代码库替换已声明的代码库,请使用 --override_repository 标志。使用此标志会更改外部代码库的内容,但不会更改您的源代码。

例如,如需将 @foo 替换为本地目录 /path/to/local/foo,请传递 --override_repository=foo=/path/to/local/foo 标志。

用例包括:

  • 调试问题。例如,将 http_archive 代码库替换为本地目录,以便更轻松地进行更改。
  • vendoring。如果您所处的环境无法进行网络调用,请替换基于网络的代码库规则,使其指向本地目录。

使用代理

Bazel 会从 HTTPS_PROXYHTTP_PROXY 环境变量中获取代理地址,并使用这些地址下载 HTTPHTTPS 文件(如果已指定)。

对 IPv6 的支持

在仅限 IPv6 的机器上,Bazel 可以下载依赖项,而无需进行任何更改。不过,在双栈 IPv4/IPv6 机器上,Bazel 遵循与 Java 相同的惯例,如果启用 IPv4,则优先使用 IPv4。在某些情况下(例如 IPv4 网络无法解析/访问外部地址时),这可能会导致 Network unreachable 异常和 build 失败。在这种情况下,您可以使用 java.net.preferIPv6Addresses=true 系统属性来替换 Bazel 的行为,使其优先使用 IPv6。 具体而言:

  • 使用 --host_jvm_args=-Djava.net.preferIPv6Addresses=true 启动选项,例如通过在 .bazelrc 文件中添加以下行:

    startup --host_jvm_args=-Djava.net.preferIPv6Addresses=true

  • 运行需要连接到互联网的 Java build 目标(例如用于集成测试)时,请使用 --jvmopt=-Djava.net.preferIPv6Addresses=true 工具标志。例如,在 .bazelrc 文件中包含以下内容:

    build --jvmopt=-Djava.net.preferIPv6Addresses

  • 如果您使用 rules_jvm_external 来解析依赖项版本,还需将 -Djava.net.preferIPv6Addresses=true 添加到 COURSIER_OPTS 环境变量,以便为 Coursier 提供 JVM 选项

离线 build

有时,您可能希望离线运行 build,例如在飞机上旅行时。对于此类简单用例,请使用 bazel fetchbazel sync 预提取所需的代码库。如需在 build 期间停用进一步提取代码库,请使用 --nofetch 选项。

对于真正的离线 build(其中所有必需文件由其他实体提供),Bazel 支持 --distdir 选项。此标志会告知 Bazel,当代码库规则要求 Bazel 获取带有 ctx.downloadctx.download_and_extract 的文件时,Bazel 应先在相应选项指定的目录中查找。通过提供所需文件的哈希和,Bazel 会查找与第一个网址的基本名称匹配的文件,并在哈希匹配时使用本地副本。

Bazel 本身也使用此技术从分发工件离线启动。 为此,它会在内部 distdir_tar收集所有必需的外部依赖项

Bazel 允许在仓库规则中执行任意命令,而无需知道它们是否会调用网络,因此无法强制执行完全离线的 build。如需测试 build 是否在离线状态下正常运行,请手动屏蔽网络(就像 Bazel 在其引导测试中所做的那样)。