Bazel 6.3.0 中引入的 mod 命令提供了一系列工具，可帮助用户在启用 Bzlmod 后了解其外部依赖关系图。借助此工具，您可以直观呈现依赖关系图、找出图中显示特定模块或某个模块版本的原因、查看支持模块的代码库定义、检查模块扩展和它们生成的代码库的使用情况，以及其他函数。
语法
bazel mod <subcommand> [<options>] [<arg> [<arg>...]]
以下是可用的子命令及其各自的必需参数：
graph：显示项目的完整依赖关系图（从根模块开始）。如果在--from中指定了一个或多个模块，则这些模块会直接显示在根目录下，并且图仅会从其开始展开（请参阅示例）。deps <arg>...：显示每个指定模块的已解析直接依赖项，类似于graph。all_paths <arg>...：显示从根目录到指定<arg>...的所有现有路径。如果在--from中指定了一个或多个模块，则这些模块会直接显示在根目录下，并且该图包含从--from模块到参数模块的任何现有路径（请参阅示例）。path <arg>...：与all_paths具有相同的语义，但仅显示从其中一个--from模块到其中一个参数模块的单路径。explain <arg>...：显示指定模块在依赖关系图中显示的所有位置，以及直接依赖于这些模块的模块。explain命令的输出实质上是all_paths命令的删减版本，其中包含 1) 根模块；2) 根模块指向参数模块的直接依赖项；3) 参数模块的直接依赖项；以及 4) 参数模块本身（请参阅示例）。show_repo <arg>...：显示指定代码库的定义（请参阅示例）。show_extension <extension>...：显示每个指定扩展程序的相关信息：生成的代码库以及使用use_repo导入这些扩展程序的模块的列表，以及使用该扩展程序的每个模块中的用法列表，其中包含指定的标记和use_repo调用（请参阅示例）。
<arg> 是指一个或多个模块或代码库。可为以下项之一：
字面量字符串
<root>：表示当前项目的根模块。<name>@<version>：版本<version>的模块<name>。对于具有非注册表覆盖的模块，请使用下划线 (_) 作为<version>。<name>：模块<name>的所有现有版本。@<repo_name>：在--base_module的上下文中具有给定表观名称的代码库。@@<repo_name>：具有指定规范名称的代码库。
在需要指定模块的上下文中，也可以使用 <arg>（引用与模块对应的代码库，而不是扩展程序生成的代码库）。相反，在需要指定代码库的上下文中，引用模块的 <arg> 可以代表相应的代码库。
<extension> 必须采用 <arg><label_to_bzl_file>%<extension_name> 格式。<label_to_bzl_file> 部分必须是与代码库相关的标签（例如 //pkg/path:file.bzl）。
以下选项只会影响用于输出图表的子命令（graph、deps、all_paths、path 和 explain）：
--from <arg>[,<arg>[,...]]默认值：<root>：在graph、all_paths、path和explain中展开图的模块。如需了解详情，请查看子命令的说明。--verbosedefault: "false"：在输出图中添加有关每个模块版本分辨率的额外信息。如果在解析期间模块版本发生了更改，则显示哪个版本替换了新版本或是原来的版本、替换的原因，以及哪些模块请求了新版本（如果原因为选择最低版本）。--include_unuseddefault: "false"：将原本出现在依赖关系图中但在模块解析后不再使用的模块添加到输出图中。--extension_info <mode>：在输出图中包含模块扩展使用情况的相关信息（请参阅示例）。<mode>可以是以下项之一：hidden（默认）：不显示与附加信息有关的任何内容。usages：在使用扩展程序的每个模块下显示它们。它们以$<extension>的形式输出。repos：除了usages之外，还在每种扩展程序用法下显示使用use_repo导入的代码库。all：除了usages和repos之外，还会显示由扩展程序生成但未由任何模块导入的代码库。这些额外的代码库会显示在输出中其生成扩展名的首次出现下方，并用虚线连接。
--extension_filter <extension>[,<extension>[,...]]：如果指定，则输出图仅包含使用指定扩展的模块以及指向这些模块的路径。指定空扩展列表（如--extension_filter=中所示）相当于指定依赖关系图中的任何模块使用的所有扩展。--depth <N>：输出图的深度。深度为 1 仅显示根目录及其直接依赖项。对于explain，默认为 1；对于deps，默认为 2；对于其他值，默认为 2。--cyclesdefault: "false"：在输出图中包含周期边缘。--include_builtindefault: "false"：在输出图中包含内置模块（例如@bazel_tools）。此标志默认处于停用状态，因为内置模块由每个其他模块隐式依赖，这会导致输出非常混乱。--charset <charset>默认值：utf8：指定用于文本输出的字符集。有效值为"utf8"和"ascii"。唯一显著的区别在于，用于以"text"输出格式绘制图表的特殊字符在"ascii"字符集中不存在。因此，"ascii"字符集的存在是为了支持在无法使用 Unicode 的旧版平台上使用。--output <mode>：在输出图中包含模块扩展使用情况的相关信息。<mode> 可以是以下项之一：text（默认）：输出图的人类可读表示法（扁平化为树）。json：以 JSON 对象的形式输出图表（扁平化为树）。graph：以 Graphviz dot 表示法输出图表。
bazel mod graph --output graph | dot -Tsvg > /tmp/graph.svg
其他选项包括：
--base_module <arg>默认值：<root>：指定相对于该模块来解读参数中的明显代码库名称。请注意，此参数本身可以为@<repo_name>形式；始终相对于根模块进行解释。--extension_usages <arg>[,<arg>[,...]]：过滤show_extension，以仅显示指定模块中的扩展程序使用情况。
示例
下面介绍了在实际 Bazel 项目中使用 mod 命令时可能用到的一些方式，让您大致了解如何使用该命令来检查项目的外部依赖项。
MODULE.bazel 文件：
module(
name = "my_project",
version = "1.0",
)
bazel_dep(name = "bazel_skylib", version = "1.1.1", repo_name = "skylib1")
bazel_dep(name = "bazel_skylib", version = "1.2.0", repo_name = "skylib2")
multiple_version_override(module_name = "bazel_skylib", versions = ["1.1.1", "1.2.0"])
bazel_dep(name = "stardoc", version = "0.5.0")
bazel_dep(name = "rules_java", version = "5.0.0")
toolchains = use_extension("@rules_java//java:extensions.bzl", "toolchains")
use_repo(toolchains, my_jdk="remotejdk17_linux")
|
|
显示项目的整个依赖关系图。
bazel mod graph<root> (my_project@1.0) ├───bazel_skylib@1.1.1 │ └───platforms@0.0.4 ├───bazel_skylib@1.2.0 │ └───platforms@0.0.4 ... ├───rules_java@5.0.0 │ ├───platforms@0.0.4 ... │ ├───rules_cc@0.0.1 │ │ ├───bazel_skylib@1.1.1 ... │ │ └───platforms@0.0.4 ... │ └───rules_proto@4.0.0 │ ├───bazel_skylib@1.1.1 ... │ └───rules_cc@0.0.1 ... └───stardoc@0.5.0 ├───bazel_skylib@1.1.1 ... └───rules_java@5.0.0 ...显示整个依赖关系图（包括未使用的模块以及有关版本解析的额外信息）。
bazel mod graph --include_unused --verbose<root> (my_project@1.0) ├───bazel_skylib@1.1.1 │ └───platforms@0.0.4 ├───bazel_skylib@1.2.0 │ └───platforms@0.0.4 ... ├───rules_java@5.0.0 │ ├───platforms@0.0.4 ... │ ├───rules_cc@0.0.1 │ │ ├───bazel_skylib@1.0.3 ... (to 1.1.1, cause multiple_version_override) │ │ ├───bazel_skylib@1.1.1 ... (was 1.0.3, cause multiple_version_override) │ │ └───platforms@0.0.4 ... │ └───rules_proto@4.0.0 │ ├───bazel_skylib@1.0.3 ... (to 1.1.1, cause multiple_version_override) │ ├───bazel_skylib@1.1.1 ... (was 1.0.3, cause multiple_version_override) │ └───rules_cc@0.0.1 ... └───stardoc@0.5.0 ├───bazel_skylib@1.1.1 ... (was 1.0.3, cause multiple_version_override) ├───rules_java@5.0.0 ... (was 4.0.0, cause <root>, bazel_tools@_) ├───bazel_skylib@1.0.3 (to 1.1.1, cause multiple_version_override) │ └───platforms@0.0.4 ... └───rules_java@4.0.0 (to 5.0.0, cause <root>, bazel_tools@_) ├───bazel_skylib@1.0.3 ... (to 1.1.1, cause multiple_version_override) └───bazel_skylib@1.1.1 ... (was 1.0.3, cause multiple_version_override)显示从某些特定模块展开的依赖关系图。
bazel mod graph --from rules_java --include_unused<root> (my_project@1.0) ├───rules_java@5.0.0 │ ├───platforms@0.0.4 │ ├───rules_cc@0.0.1 │ │ ├───bazel_skylib@1.0.3 ... (unused) │ │ ├───bazel_skylib@1.1.1 ... │ │ └───platforms@0.0.4 ... │ └───rules_proto@4.0.0 │ ├───bazel_skylib@1.0.3 ... (unused) │ ├───bazel_skylib@1.1.1 ... │ └───rules_cc@0.0.1 ... └╌╌rules_java@4.0.0 (unused) ├───bazel_skylib@1.0.3 (unused) │ └───platforms@0.0.4 ... └───bazel_skylib@1.1.1 └───platforms@0.0.4 ...显示两个模块之间的所有路径。
bazel mod all_paths bazel_skylib@1.1.1 --from rules_proto<root> (my_project@1.0) └╌╌rules_proto@4.0.0 ├───bazel_skylib@1.1.1 └───rules_cc@0.0.1 └───bazel_skylib@1.1.1 ...了解项目依赖于某些模块的原因和方式。
bazel mod explain @skylib1 --verbose --include_unused<root> (my_project@1.0) ├───bazel_skylib@1.1.1 ├───rules_java@5.0.0 │ ├───rules_cc@0.0.1 │ │ └───bazel_skylib@1.1.1 ... (was 1.0.3, cause multiple_version_override) │ └───rules_proto@4.0.0 │ ├───bazel_skylib@1.1.1 ... (was 1.0.3, cause multiple_version_override) │ └───rules_cc@0.0.1 ... └───stardoc@0.5.0 ├───bazel_skylib@1.1.1 ... (was 1.0.3, cause multiple_version_override) ├╌╌rules_cc@0.0.1 │ └───bazel_skylib@1.1.1 ... (was 1.0.3, cause multiple_version_override) └╌╌rules_proto@4.0.0 ├───bazel_skylib@1.1.1 ... (was 1.0.3, cause multiple_version_override) └───rules_cc@0.0.1 ...查看某些模块代码库的基本规则。
bazel mod show_repo rules_cc stardoc## rules_cc@0.0.1: # <builtin> http_archive( name = "rules_cc~", urls = ["https://bcr.bazel.build/test-mirror/github.com/bazelbuild/rules_cc/releases/download/0.0.1/rules_cc-0.0.1.tar.gz", "https://github.com/bazelbuild/rules_cc/releases/download/0.0.1/rules_cc-0.0.1.tar.gz"], integrity = "sha256-Tcy/0iwN7xZMj0dFi9UODHFI89kgAs20WcKpamhJgkE=", strip_prefix = "", remote_patches = {"https://bcr.bazel.build/modules/rules_cc/0.0.1/patches/add_module_extension.patch": "sha256-g3+zmGs0YT2HKOVevZpN0Jet89Ylw90Cp9XsIAY8QqU="}, remote_patch_strip = 1, ) # Rule http_archive defined at (most recent call last): # /home/user/.cache/bazel/_bazel_user/6e893e0f5a92cc4cf5909a6e4b2770f9/external/bazel_tools/tools/build_defs/repo/http.bzl:355:31 in <toplevel> ## stardoc: # <builtin> http_archive( name = "stardoc~", urls = ["https://bcr.bazel.build/test-mirror/github.com/bazelbuild/stardoc/releases/download/0.5.0/stardoc-0.5.0.tar.gz", "https://github.com/bazelbuild/stardoc/releases/download/0.5.0/stardoc-0.5.0.tar.gz"], integrity = "sha256-yXlNzIAmow/2fPfPkeviRcopSyCwcYRdEsGSr+JDrXI=", strip_prefix = "", remote_patches = {}, remote_patch_strip = 0, ) # Rule http_archive defined at (most recent call last): # /home/user/.cache/bazel/_bazel_user/6e893e0f5a92cc4cf5909a6e4b2770f9/external/bazel_tools/tools/build_defs/repo/http.bzl:355:31 in <toplevel>查看依赖项图中使用了哪些模块扩展。
bazel mod graph --extension_info=usages --extension_filter=all<root> (my_project@1.0) ├───$@@rules_java.5.0.0//java:extensions.bzl%toolchains ├───rules_java@5.0.0 # │ ├───$@@rules_java.5.0.0//java:extensions.bzl%toolchains │ ├───rules_cc@0.0.1 # │ │ └───$@@rules_cc.0.0.1//bzlmod:extensions.bzl%cc_configure │ └───rules_proto@4.0.0 │ └───rules_cc@0.0.1 ... └───stardoc@0.5.0 └───rules_java@5.0.0 ...查看在依赖关系图中生成和从某个特定扩展程序导入了哪些代码库。
bazel mod show_extension @@rules_java~5.0.0//java:extensions.bzl%toolchains<root> (my_project@1.0) ├───$@@rules_java.5.0.0//java:extensions.bzl%toolchains │ ├───remotejdk17_linux │ ├╌╌remotejdk11_linux │ ├╌╌remotejdk11_linux_aarch64 │ ├╌╌remotejdk11_linux_ppc64le │ ├╌╌remotejdk11_linux_s390x ...(some lines omitted)... ├───rules_java@5.0.0 # │ └───$@@rules_java.5.0.0//java:extensions.bzl%toolchains ... │ ├───local_jdk │ ├───remote_java_tools │ ├───remote_java_tools_darwin │ ├───remote_java_tools_linux │ ├───remote_java_tools_windows │ ├───remotejdk11_linux_aarch64_toolchain_config_repo │ ├───remotejdk11_linux_ppc64le_toolchain_config_repo ...(some lines omitted)... └───stardoc@0.5.0 └───rules_java@5.0.0 ...请参阅为扩展程序生成的代码库的列表，以及该扩展程序在每个模块中的使用方式。
bazel mod graph --extension_info=all --extension_filter=@rules_java//java:extensions.bzl%toolchains## @@rules_java.5.0.0//java:extensions.bzl%toolchains: Fetched repositories: - local_jdk (imported by bazel_tools@_, rules_java@5.0.0) - remote_java_tools (imported by bazel_tools@_, rules_java@5.0.0) - remote_java_tools_darwin (imported by bazel_tools@_, rules_java@5.0.0) - remote_java_tools_linux (imported by bazel_tools@_, rules_java@5.0.0) - remote_java_tools_windows (imported by bazel_tools@_, rules_java@5.0.0) - remotejdk11_linux_aarch64_toolchain_config_repo (imported by rules_java@5.0.0) - remotejdk11_linux_ppc64le_toolchain_config_repo (imported by rules_java@5.0.0) ...(some lines omitted)... - remotejdk17_linux (imported by <root>) - remotejdk11_linux - remotejdk11_linux_aarch64 - remotejdk11_linux_ppc64le - remotejdk11_linux_s390x - remotejdk11_macos ...(some lines omitted)... # Usage in <root> at <root>/MODULE.bazel:14:27 with the specified attributes: use_repo( toolchains, my_jdk="remotejdk17_linux", ) # Usage in bazel_tools@_ at bazel_tools@_/MODULE.bazel:23:32 with the specified attributes: use_repo( toolchains, "local_jdk", "remote_java_tools", "remote_java_tools_linux", "remote_java_tools_windows", "remote_java_tools_darwin", ) # Usage in rules_java@5.0.0 at rules_java@5.0.0/MODULE.bazel:30:27 with the specified attributes: use_repo( toolchains, "remote_java_tools", "remote_java_tools_linux", "remote_java_tools_windows", "remote_java_tools_darwin", "local_jdk", "remotejdk11_linux_toolchain_config_repo", "remotejdk11_macos_toolchain_config_repo", "remotejdk11_macos_aarch64_toolchain_config_repo", ...(some lines omitted)... )查看某些扩展程序生成的代码库的基本规则。
bazel mod show_repo --base_module=rules_java @remote_java_tools## @remote_java_tools: # <builtin> http_archive( name = "rules_java~~toolchains~remote_java_tools", urls = ["https://mirror.bazel.build/bazel_java_tools/releases/java/v11.5/java_tools-v11.5.zip", "https://github.com/bazelbuild/java_tools/releases/download/java_v11.5/java_tools-v11.5.zip"], sha256 = "b763ee80e5754e593fd6d5be6d7343f905bc8b73d661d36d842b024ca11b6793", ) # Rule http_archive defined at (most recent call last): # /home/user/.cache/bazel/_bazel_user/6e893e0f5a92cc4cf5909a6e4b2770f9/external/bazel_tools/tools/build_defs/repo/http.bzl:355:31 in <toplevel>