Bazel动态生成deps的技巧与实践

本文揭秘了如何借助 Bazel Skylib 中的 `subpackages()` 函数，实现真正动态、零维护的跨包依赖管理——无需每次新增插件目录就手动修改根 BUILD 文件，只需在各子包中定义语义清晰的 `:all` 目标，即可自动发现并聚合所有匹配（如 `plugin*`）子目录的依赖，让大型模块化项目（尤其是插件系统）的构建配置既可扩展又健壮，彻底告别硬编码路径和易出错的手动同步。

本文介绍如何利用 subpackages() 函数（来自 Bazel Skylib）自动发现并引用多个子包中的目标，避免在根 BUILD 文件中硬编码依赖路径，实现可扩展、可维护的插件式依赖管理。

本文介绍如何利用 subpackages() 函数（来自 Bazel Skylib）自动发现并引用多个子包中的目标，避免在根 BUILD 文件中硬编码依赖路径，实现可扩展、可维护的插件式依赖管理。

在构建大型模块化项目（如插件系统）时，手动维护 deps 列表极易出错且难以扩展：每当新增一个插件目录（如 plugin3/），就必须同步修改根 BUILD 文件。Bazel 本身不支持运行时动态解析目标（glob() 只匹配文件，不能生成 target label），但可通过 subpackages() —— 一个专为跨包自动发现设计的函数 —— 实现真正的动态依赖注入。

✅ 推荐方案：使用 bazel_skylib 的 subpackages()

首先确保已在 WORKSPACE 或 MODULE.bazel 中引入 bazel_skylib（推荐 v1.5.0+）：

# MODULE.bazel (Bazel 6+)
bazel_dep(name = "bazel_skylib", version = "1.5.0")

或 WORKSPACE（旧版）：

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "bazel_skylib",
    urls = ["https://github.com/bazelbuild/bazel-skylib/releases/download/1.5.0/bazel-skylib-1.5.0.tar.gz"],
    sha256 = "cd55a077489f52a3c927b5948532dc120f6542e1d44a02e8478a1e9285e92674",
)

然后在根 plugins_folder/BUILD 中定义动态聚合目标：

# plugins_folder/BUILD
load("@bazel_skylib//lib:subpackages.bzl", "subpackages")

py_library(
    name = "code0",
    srcs = ["code0.py"],
    # 动态收集所有匹配 plugin* 的子包，并引用其 :all 目标（需各子包 BUILD 中定义）
    deps = [
        "//plugins_folder/%s:all" % pkg
        for pkg in subpackages(include = ["plugin*"])
    ],
)

⚠️ 关键前提：每个插件子目录（如 plugin1/, plugin2/）必须在其自身的 BUILD 文件中明确定义 py_library(name = "all", ...)，例如：

# plugins_folder/plugin1/BUILD
py_library(
    name = "code1-0",
    srcs = ["code1-0.py"],
)

py_library(
    name = "code1-1",
    srcs = ["code1-1.py"],
)

# 必须提供聚合目标，供父级引用
py_library(
    name = "all",
    srcs = glob(["*.py"]),
    # 若有内部依赖，也在此处声明
)

同理，plugin2/BUILD 也需包含 name = "all"。

? 验证与调试

运行以下命令确认依赖图是否按预期生成：

bazel query 'deps(//plugins_folder:code0)' --notool_deps --noimplicit_deps

输出应包含类似：

//plugins_folder:code0
//plugins_folder/plugin1:all
//plugins_folder/plugin2:all
//plugins_folder/plugin1:code1-0
//plugins_folder/plugin1:code1-1
//plugins_folder/plugin2:code2-0
//plugins_folder/plugin2:code2-1

若未出现子包目标，请检查：

• subpackages(include = [...]) 的路径前缀是否与实际目录结构一致（此处为 "//plugins_folder/"，故 subpackages() 内部自动补全）；
• 各子包 BUILD 文件中是否存在 name = "all" 目标；
• subpackages() 返回的是包名后缀（如 "plugin1"），不是完整路径，因此拼接时用 "//plugins_folder/%s:all" 是正确的。

? 进阶建议

• 若插件需差异化控制（如排除测试插件），可结合 exclude 参数：
  subpackages(include = ["plugin*"], exclude = ["plugin_test"])
• 对于更复杂逻辑（如按标签筛选目标），可配合 bazel query + --output package 在生成时预处理，但会牺牲纯 Starlark 可移植性；
• 始终优先使用 :all 等语义化聚合目标，而非依赖 glob() 生成的隐式目标，以提升可读性与可调试性。

通过 subpackages()，你将获得一个零维护成本、天然适配新增插件的依赖模型——无需修改根 BUILD，只需添加目录并编写其内部 BUILD，一切自动就绪。

好了，本文到此结束，带大家了解了《Bazel动态生成deps的技巧与实践》，希望本文对你有所帮助！关注golang学习网公众号，给大家分享更多文章知识！