此页面由 Cloud Translation API 翻译。

模块扩展

借助模块扩展程序，用户可通过以下方式扩展模块系统：从依赖关系图中读取模块的输入数据、执行必要的逻辑来解析依赖项，最后通过调用代码库规则创建代码库。这些扩展程序具有与代码库规则类似的功能，可执行文件 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 标记。

模块扩展的实现函数与代码库规则的实现函数类似，只不过前者会获取一个 module_ctx 对象，该对象会向使用该扩展和所有相关标记的所有模块授予访问权限。然后，实现函数会调用代码库规则来生成代码库。

# @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 会报告代码库的规范名称，此名称与代码库规则调用中指定的名称不相同。

考虑到模块扩展生成的代码库，存在以下几种代码库可见性规则：

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

最佳实践

本部分介绍了编写扩展程序时的最佳实践，以便扩展程序简单易用、可维护，并且能够随着时间推移而不断变化。

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

当多个扩展程序位于不同的文件中时，它允许一个扩展程序加载由另一个扩展程序生成的代码库。即使您不使用该功能，最好也将其放在单独的文件中，以备日后需要。这是因为扩展程序的标识取决于其文件，因此将扩展程序移至另一个文件之后会更改您的公共 API，对于用户来说，这是一种向后不兼容的更改。