代码库规则

报告问题 查看源代码

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

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

创建代码库规则

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

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

该规则会在您明确构建时或者是 build 的依赖项时加载。在这种情况下,Bazel 将执行其 implementation 函数。此函数描述了如何创建代码库及其内容和 BUILD 文件。

属性

属性是作为 dict 传递给 attrs 规则参数的规则参数。定义代码库规则时,系统会列出属性及其类型。以下示例将 urlsha256 属性定义为字符串:

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

如需访问实现函数中的属性,请使用 repository_ctx.attr.<attribute_name>

def _impl(repository_ctx):
    url = repository_ctx.attr.url
    checksum = repository_ctx.attr.sha256

所有 repository_rule 都具有隐式定义的属性(就像构建规则一样)。两个隐式属性是 name(就像构建规则一样)和 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,
    ...)

何时执行实现函数?

当 Bazel 需要某个代码库中的目标时,例如当另一个代码库中的另一个目标依赖于该目标时,或者命令行中提及该目标时,系统会执行代码库的实现函数。然后,实现函数需要在文件系统中创建仓库。这称为“提取”代码库。

与常规目标相反,当代码库发生更改时,更改不一定要重新提取代码库,这将导致代码库有所不同。这是因为 Bazel 无法检测到对更改的更改,或者会在每次构建时产生过多开销(例如,从网络中提取的内容)。因此,只有在以下条件之一发生变化时,系统才会重新提取代码库:

  • 传递给 WORKSPACE 文件中的代码库声明的参数。
  • 组成代码库实现的 Starlark 代码。
  • 传递给 repository_ctxgetenv() 方法或使用 repository_ruleenviron 属性声明的任何环境变量的值。这些环境变量的值可以在命令行中使用 --repo_env 标志进行硬连接。
  • 传递给 read()execute() 以及由标签引用的 repository_ctx 的类似方法的任何文件的内容(例如,//mypkg:label.txt,而不是 mypkg/label.txt
  • 当执行 bazel sync 时。

repository_rule 有两个参数,用于控制何时重新提取代码库:

  • 如果设置了 configure 标志,则仅当将 --configure 参数传递给仓库时,系统才会在 bazel sync 上重新提取仓库(如果未设置该属性,此命令不会导致重新提取)
  • 如果设置了 local 标志,则除了上述情况之外,当 Bazel 服务器重启或影响代码库声明的任何文件(例如 WORKSPACE 文件或加载的文件)发生更改时,系统也会重新提取代码库,无论这些更改是否导致了代码库或其代码的声明发生变化。

    在这些情况下,系统不会重新提取非本地代码库。这是因为系统会假定这些代码库与网络通信或开销高昂。

重新启动实现函数

如果实现函数请求的依赖项缺失,可以在提取代码库时重启实现函数。在这种情况下,实现函数的执行将停止,缺少的依赖项会被解析,而函数将在依赖项解决后重新执行。为了避免不必要的重启(因为网络访问可能必须重复导致代价高昂),系统会预提取标签参数,前提是所有标签参数都可以解析为现有文件。请注意,如果通过仅在函数执行期间构造的字符串或标签解析路径,仍可能会导致重启。

强制重新提取外部代码库

有时,外部代码库可能会过时,而不更改其定义或依赖项。例如,代码库提取来源可能遵循第三方代码库的特定分支,并且该分支上提供了新的提交内容。在这种情况下,您可以通过调用 bazel sync 让 bazel 无条件地重新提取所有外部代码库。

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

示例

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

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

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