此页面由 Cloud Translation API 翻译。

模块扩展

借助模块扩展，用户可以通过从依赖项图中的模块读取输入数据、执行必要的逻辑来解析依赖项，最后通过调用仓库规则创建仓库来扩展模块系统。这些扩展程序具有与 Repo 规则类似的功能，使它们能够执行文件 I/O、发送网络请求等。除此之外，它们还允许 Bazel 与其他软件包管理系统交互，同时还遵循由 Bazel 模块构建的依赖关系图。

您可以在 .bzl 文件中定义模块扩展，就像定义 Repo 规则一样。它们不是直接调用的；相反，每个模块都会指定一段称为“标记”的数据，以供扩展程序读取。Bazel 会在评估任何扩展程序之前运行模块解析。该扩展程序会读取整个依赖关系图中属于它的所有标记。

扩展程序使用情况

扩展程序托管在 Bazel 模块本身中。如需在模块中使用扩展程序，请先在托管扩展程序的模块上添加 bazel_dep，然后调用 use_extension 内置函数以将其纳入范围内。请考虑以下示例 - MODULE.bazel 文件中的一段，可使用 rules_jvm_external 模块中定义的“maven”扩展程序：

bazel_dep(name = "rules_jvm_external", version = "4.5")
maven = use_extension("@rules_jvm_external//:extensions.bzl", "maven")

这会将 use_extension 的返回值绑定到变量，从而允许用户使用点语法为扩展程序指定标记。这些标记必须遵循扩展程序定义中指定的相应标记类所定义的架构。例如，指定一些 maven.install 和 maven.artifact 标记：

maven.install(artifacts = ["org.junit:junit:4.13.2"])
maven.artifact(group = "com.google.guava",
               artifact = "guava",
               version = "27.0-jre",
               exclusions = ["com.google.j2objc:j2objc-annotations"])

使用 use_repo 指令将扩展程序生成的代码库纳入当前模块的作用域内。

use_repo(maven, "maven")

扩展程序生成的代码库是其 API 的一部分。在此示例中，“maven”模块扩展程序会承诺生成一个名为 maven 的代码库。使用上述声明，扩展程序可以正确解析 @maven//:org_junit_junit 等标签，使其指向由“maven”扩展程序生成的代码库。

扩展定义

您可以使用 module_extension 函数定义与 Repo 规则类似的模块扩展。不过，虽然 repo 规则具有许多属性，但模块扩展具有 tag_class，每个属性都具有多个属性。标记类用于定义此扩展程序所使用的标记的架构。例如，上面的“maven”扩展可能定义如下：

# @rules_jvm_external//:extensions.bzl

_install = tag_class(attrs = {"artifacts": attr.string_list(), ...})
_artifact = tag_class(attrs = {"group": attr.string(), "artifact": attr.string(), ...})
maven = module_extension(
  implementation = _maven_impl,
  tag_classes = {"install": _install, "artifact": _artifact},
)

这些声明表明，可以使用指定的属性架构指定 maven.install 和 maven.artifact 标记。

模块扩展的实现功能与 Repo 规则类似，只不过它们会获取 module_ctx 对象，该对象会授予对使用扩展程序和所有相关标记的所有模块的访问权限。然后，实现函数会调用 Repo 规则以生成代码库。

# @rules_jvm_external//:extensions.bzl

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_file")  # a repo rule
def _maven_impl(ctx):
  # This is a fake implementation for demonstration purposes only

  # collect artifacts from across the dependency graph
  artifacts = []
  for mod in ctx.modules:
    for install in mod.tags.install:
      artifacts += install.artifacts
    artifacts += [_to_artifact(artifact) for artifact in mod.tags.artifact]

  # call out to the coursier CLI tool to resolve dependencies
  output = ctx.execute(["coursier", "resolve", artifacts])
  repo_attrs = _process_coursier_output(output)

  # call repo rules to generate repos
  for attrs in repo_attrs:
    http_file(**attrs)
  _generate_hub_repo(name = "maven", repo_attrs)

扩展程序身份

模块扩展由名称和 use_extension 调用中显示的 .bzl 文件标识。在以下示例中，扩展名 maven 由 .bzl 文件 @rules_jvm_external//:extension.bzl 和名称 maven 标识：

maven = use_extension("@rules_jvm_external//:extensions.bzl", "maven")

从其他 .bzl 文件重新导出扩展程序会为其获得新的身份，如果传递模块图中同时使用了扩展程序的两个版本，则会分别对其进行评估，并且只会看到与该特定身份关联的标记。

作为扩展程序的作者，您应确保用户只会使用一个 .bzl 文件中的模块扩展程序。

代码库名称和可见性

扩展程序生成的代码库具有 module_repo_canonical_name~extension_name~repo_name 形式的规范名称。对于托管在根模块中的扩展程序，module_repo_canonical_name 部分会被替换为字符串 _main。请注意，规范名称格式不是您应依赖的 API，它随时可能发生变化。

此命名政策意味着每个扩展程序都有自己的“代码库命名空间”；两个不同的扩展程序可以分别定义一个同名的代码库，而不会存在任何冲突。这也意味着，repository_ctx.name 会报告代码库的规范名称，该名称与 Repo 规则调用中指定的名称不同。

考虑到模块扩展程序生成的代码库，需要遵循一些代码库可见性规则：

Bazel 模块代码库可以通过 bazel_dep 和 use_repo 查看其 MODULE.bazel 文件中引入的所有代码库。
由模块扩展程序生成的代码库可以查看对托管扩展程序的模块可见的所有代码库，以及由同一模块扩展程序生成的所有其他代码库（使用在 Repo 规则调用中指定的名称作为其表观名称）。
- 这可能会导致冲突。如果模块代码库可以看到名为 foo 的代码库，并且该扩展程序生成了一个具有指定名称 foo 的代码库，那么对于该扩展程序生成的所有代码库，foo 都会引用前者。

最佳实践

本部分介绍了编写扩展程序时的最佳实践，以便能够轻松使用、可维护并很好地适应随着时间的推移而发生的更改。

将每个扩展名放在单独的文件中

当扩展程序位于其他文件中时，可让一个扩展程序加载由另一个扩展程序生成的代码库。即使您不使用该功能，最好将它们放在单独的文件中，以备日后需要。这是因为扩展程序的身份基于其文件，因此将扩展程序移至另一个文件稍后会更改您的公共 API，并且对用户来说是向后不兼容的更改。