代码库规则

报告问题 查看源代码 每夜 build · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

本页介绍了如何创建代码库规则,并提供了示例以供您详细了解。

外部代码库是只能在 WORKSPACE 文件中使用的规则,它可在 Bazel 的加载阶段启用非封闭操作。每个外部代码库规则都会创建自己的工作区,并包含自己的 BUILD 文件和工件。它们可用于依赖第三方库(例如 Maven 打包的库),也可用于生成特定于 Bazel 运行主机的 BUILD 文件。

创建代码库规则

.bzl 文件中,使用 repository_rule 函数创建新的仓库规则并将其存储在全局变量中。

自定义代码库规则的使用方式与原生代码库规则一样。它具有必需的 name 属性,并且其 build 文件中存在的每个目标都可以称为 @<name>//package:target,其中 <name>name 属性的值。

当您明确构建该规则时,或该规则是 build 的依赖项时,系统会加载该规则。在本例中,Bazel 将执行其 implementation 函数。此函数介绍了如何创建代码库及其内容和 BUILD 文件。

属性

属性是规则参数,例如 urlsha256。定义仓库规则时,您必须列出属性及其类型。

local_repository = repository_rule(
    implementation=_impl,
    local=True,
    attrs={"path": attr.string(mandatory=True)})

如需访问属性,请使用 repository_ctx.attr.<attribute_name>

所有 repository_rule 都具有隐式定义的属性(就像 build 规则一样)。这两个隐式属性分别是 name(与 build 规则相同)和 repo_mapping。您可以使用 repository_ctx.name 访问代码库规则的名称。repo_mapping 的含义与原生代码库规则 local_repositorynew_local_repository 相同。

如果属性名称以 _ 开头,则表示该属性是私有的,用户无法对其进行设置。

实现函数

每个代码库规则都需要一个 implementation 函数。它包含规则的实际逻辑,并且仅在加载阶段执行。

该函数只有一个输入参数,即 repository_ctx。该函数会返回 None,表示在指定参数的情况下,该规则是可重现的;或者返回一个字典,其中包含该规则的一组参数,这些参数会将该规则转换为可生成相同代码库的可重现规则。例如,对于跟踪 Git 代码库的规则,这意味着返回特定的提交标识符,而不是最初指定的浮动分支。

输入参数 repository_ctx 可用于访问属性值和非密封函数(查找二进制文件、执行二进制文件、在代码库中创建文件或从互联网下载文件)。如需了解更多背景信息,请参阅该库。示例:

def _impl(repository_ctx):
  repository_ctx.symlink(repository_ctx.attr.path, "")

local_repository = repository_rule(
    implementation=_impl,
    ...)

何时执行实现函数?

如果代码库声明为 local,则依赖项图中的依赖项(包括 WORKSPACE 文件本身)发生更改将导致执行实现函数。

如果实现函数请求的依赖项缺失,则可以重启实现函数。解析依赖项后,将重新执行实现函数的开头。为避免不必要的重启(由于可能需要重复网络访问,重启成本高昂),系统会预提取标签参数,但前提是所有标签参数都可以解析到现有文件。请注意,如果使用仅在函数执行期间构建的字符串或标签来解析路径,则仍可能导致重启。

最后,对于非 local 代码库,只有以下依赖项的更改可能会导致重启:

  • 定义代码库规则所需的 .bzl 文件。
  • WORKSPACE 文件中对代码库规则的声明。
  • 使用 repository_rule 函数的 environ 属性声明的任何环境变量的值。您可以使用 --action_env 标志从命令行强制执行这些环境变量的值(但此标志会使构建的所有操作失效)。
  • 标签使用和引用的任何文件(例如,//mypkg:label.txt,而不是 mypkg/label.txt)的内容。

强制重新提取外部代码库

有时,外部代码库可能会在其定义或依赖项没有任何更改的情况下过时。例如,提取源代码的代码库可能会跟踪第三方代码库的特定分支,并且该分支上有新的提交。在这种情况下,您可以通过调用 bazel sync 要求 bazel 无条件地重新提取所有外部代码库。

此外,某些规则会检查本地机器,如果本地机器升级,这些规则可能会过时。在这里,您可以使用 bazel sync --configure 指示 bazel 仅重新提取 repository_rule 定义设置了 configure 属性的外部代码库。

示例

  • C++ 自动配置工具链:它使用代码库规则,通过查找本地 C++ 编译器、环境和 C++ 编译器支持的标志,自动为 Bazel 创建 C++ 配置文件。

  • Go 代码库使用多个 repository_rule 来定义使用 Go 规则所需的依赖项列表。

  • rules_jvm_external 默认会创建一个名为 @maven 的外部仓库,用于为传递依赖项树中的每个 Maven 工件生成构建目标。