切面

报告问题 查看来源 Nightly · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

本页介绍了使用方面的基础知识和好处,并提供了简单和高级示例。

切面允许使用其他信息和操作来扩充 build 依赖关系图。以下是一些方面可能很有用的典型场景:

  • 集成 Bazel 的 IDE 可以使用方面来收集有关项目的信息。
  • 代码生成工具可以利用方面以与目标无关的方式在其输入上执行操作。例如,BUILD 文件可以指定 protobuf 库定义层次结构,而特定于语言的规则可以使用方面来附加操作,以生成特定语言的 protobuf 支持代码。

切面基础知识

BUILD 文件用于描述项目的源代码:哪些源文件属于项目、应从这些文件构建哪些制品(目标)、这些文件之间的依赖关系是什么等等。Bazel 会使用此信息来执行 build,也就是说,它会确定生成制品所需的一组操作(例如运行编译器或链接器),并执行这些操作。为此,Bazel 会构建目标之间的依赖关系图,并访问此图以收集这些操作。

请考虑以下 BUILD 文件:

java_library(name = 'W', ...)
java_library(name = 'Y', deps = [':W'], ...)
java_library(name = 'Z', deps = [':W'], ...)
java_library(name = 'Q', ...)
java_library(name = 'T', deps = [':Q'], ...)
java_library(name = 'X', deps = [':Y',':Z'], runtime_deps = [':T'], ...)

BUILD 文件定义了下图所示的依赖关系图:

构建图表

图 1. BUILD 文件依赖关系图。

Bazel 会针对上述示例中的每个目标调用相应规则(在本例中为“java_library”)的实现函数,从而分析此依赖关系图。规则实现函数会生成用于构建制品(例如 .jar 文件)的操作,并将信息(例如这些制品的位置和名称)通过 提供程序传递给这些目标的反向依赖项。

从某种意义上来说,方面与规则类似,它们都有一个生成操作并返回提供程序的实现函数。不过,它们的强大之处在于依赖关系图的构建方式。方面具有实现和它传播的所有属性的列表。假设某个方面 A 沿名为“deps”的属性传播。此方面可应用于目标 X,从而生成方面应用节点 A(X)。在应用时,方面 A 会以递归方式应用于 X 在其“deps”属性(A 的传播列表中的所有属性)中引用的所有目标。

因此,将方面 A 应用于目标 X 的单个操作会生成目标原始依赖关系图的“影子图”,如下图所示:

使用 Aspect 构建图表

图 2. 使用方面构建图表。

只有传播集中的属性所对应的边会被遮挡,因此在此示例中,runtime_deps 边不会被遮挡。然后,系统会在影子图中的所有节点上调用方面实现函数,类似于在原始图的节点上调用规则实现。

简单示例

此示例演示了如何以递归方式打印具有 deps 属性的规则及其所有依赖项的源文件。它展示了方面实现、方面定义,以及如何从 Bazel 命令行调用方面。

def _print_aspect_impl(target, ctx):
    # Make sure the rule has a srcs attribute.
    if hasattr(ctx.rule.attr, 'srcs'):
        # Iterate through the files that make up the sources and
        # print their paths.
        for src in ctx.rule.attr.srcs:
            for f in src.files.to_list():
                print(f.path)
    return []

print_aspect = aspect(
    implementation = _print_aspect_impl,
    attr_aspects = ['deps'],
)

下面,我们将此示例拆分为多个部分,并逐一进行检查。

Aspect 定义

print_aspect = aspect(
    implementation = _print_aspect_impl,
    attr_aspects = ['deps'],
)

方面定义与规则定义类似,都是使用 aspect 函数定义的。

与规则一样,方面也有一个实现函数,在本例中为 _print_aspect_impl

attr_aspects 是方面传播所依据的规则属性列表。在这种情况下,方面将沿着所应用规则的 deps 属性传播。

attr_aspects 的另一个常见实参是 ['*'],它会将方面传播到规则的所有属性。

Aspect 实现

def _print_aspect_impl(target, ctx):
    # Make sure the rule has a srcs attribute.
    if hasattr(ctx.rule.attr, 'srcs'):
        # Iterate through the files that make up the sources and
        # print their paths.
        for src in ctx.rule.attr.srcs:
            for f in src.files.to_list():
                print(f.path)
    return []

方面实现函数与规则实现函数类似。它们会返回提供程序,可以生成操作,并接受两个实参:

  • target:应用相应方面的目标
  • ctx:可用于访问属性以及生成输出和操作的 ctx 对象。

实现函数可以通过 ctx.rule.attr 访问目标规则的属性。它可以检查由应用它的目标提供的提供程序(通过 target 实参)。

需要提供方面才能返回提供商列表。在此示例中,方面未提供任何内容,因此返回一个空列表。

使用命令行调用方面

应用方面最简单的方法是使用 --aspects 实参从命令行进行应用。假设上述方面是在名为 print.bzl 的文件中定义的,则:

bazel build //MyExample:example --aspects print.bzl%print_aspect

会将 print_aspect 应用于目标 example 以及可通过 deps 属性以递归方式访问的所有目标规则。

--aspects 标志接受一个实参,即以 <extension file label>%<aspect top-level name> 格式指定的宽高比。

高级示例

以下示例演示了如何使用目标规则中的方面来统计目标中的文件数,并可按扩展名进行过滤。它展示了如何使用提供程序返回值、如何使用参数将实参传递到方面实现中,以及如何从规则中调用方面。

file_count.bzl 文件:

FileCountInfo = provider(
    fields = {
        'count' : 'number of files'
    }
)

def _file_count_aspect_impl(target, ctx):
    count = 0
    # Make sure the rule has a srcs attribute.
    if hasattr(ctx.rule.attr, 'srcs'):
        # Iterate through the sources counting files
        for src in ctx.rule.attr.srcs:
            for f in src.files.to_list():
                if ctx.attr.extension == '*' or ctx.attr.extension == f.extension:
                    count = count + 1
    # Get the counts from our dependencies.
    for dep in ctx.rule.attr.deps:
        count = count + dep[FileCountInfo].count
    return [FileCountInfo(count = count)]

file_count_aspect = aspect(
    implementation = _file_count_aspect_impl,
    attr_aspects = ['deps'],
    attrs = {
        'extension' : attr.string(values = ['*', 'h', 'cc']),
    }
)

def _file_count_rule_impl(ctx):
    for dep in ctx.attr.deps:
        print(dep[FileCountInfo].count)

file_count_rule = rule(
    implementation = _file_count_rule_impl,
    attrs = {
        'deps' : attr.label_list(aspects = [file_count_aspect]),
        'extension' : attr.string(default = '*'),
    },
)

BUILD.bazel 文件:

load('//:file_count.bzl', 'file_count_rule')

cc_library(
    name = 'lib',
    srcs = [
        'lib.h',
        'lib.cc',
    ],
)

cc_binary(
    name = 'app',
    srcs = [
        'app.h',
        'app.cc',
        'main.cc',
    ],
    deps = ['lib'],
)

file_count_rule(
    name = 'file_count',
    deps = ['app'],
    extension = 'h',
)

Aspect 定义

file_count_aspect = aspect(
    implementation = _file_count_aspect_impl,
    attr_aspects = ['deps'],
    attrs = {
        'extension' : attr.string(values = ['*', 'h', 'cc']),
    }
)

此示例展示了宽高比如何通过 deps 属性传播。

attrs 定义了某个方面的属性集。公共方面属性定义参数,并且只能是 boolintstring 类型。 对于规则传播方面,intstring 参数必须指定 values。此示例有一个名为 extension 的参数,该参数的值可以是“*”“h”或“cc”。

对于规则传播的方面,参数值取自请求该方面的规则,使用具有相同名称和类型的规则属性。 (请参阅 file_count_rule 的定义)。

对于命令行方面,可以使用 --aspects_parameters 标志传递参数值。intstring 参数的 values 限制可以省略。

方面也可以具有 labellabel_list 类型的私有属性。私有标签属性可用于指定方面生成的操作所需的工具或库的依赖项。此示例中未定义私有属性,但以下代码段演示了如何将工具传递给方面:

...
    attrs = {
        '_protoc' : attr.label(
            default = Label('//tools:protoc'),
            executable = True,
            cfg = "exec"
        )
    }
...

Aspect 实现

FileCountInfo = provider(
    fields = {
        'count' : 'number of files'
    }
)

def _file_count_aspect_impl(target, ctx):
    count = 0
    # Make sure the rule has a srcs attribute.
    if hasattr(ctx.rule.attr, 'srcs'):
        # Iterate through the sources counting files
        for src in ctx.rule.attr.srcs:
            for f in src.files.to_list():
                if ctx.attr.extension == '*' or ctx.attr.extension == f.extension:
                    count = count + 1
    # Get the counts from our dependencies.
    for dep in ctx.rule.attr.deps:
        count = count + dep[FileCountInfo].count
    return [FileCountInfo(count = count)]

与规则实现函数一样,方面实现函数也会返回一个提供程序结构,供其依赖项访问。

在此示例中,FileCountInfo 定义为具有一个字段 count 的提供程序。最佳实践是使用 fields 属性明确定义提供程序的字段。

方面应用 A(X) 的提供程序集是来自目标 X 的规则实现和来自方面 A 的实现的提供程序的并集。规则实现所传播的提供程序是在应用方面之前创建并冻结的,无法从方面进行修改。如果目标和应用于该目标的方面各自提供相同类型的提供程序,则会发生错误,但 OutputGroupInfo(只要规则和方面指定不同的输出组,就会合并)和 InstrumentedFilesInfo(从方面获取)除外。这意味着,方面实现可能永远不会返回 DefaultInfo

参数和不公开的属性在 ctx 的属性中传递。此示例引用了 extension 参数,并确定要统计哪些文件。

对于返回提供程序,方面传播所依据的属性(来自 attr_aspects 列表)的值会被应用方面后的结果替换。例如,如果目标 X 的依赖项中包含 Y 和 Z,则 A(X) 的 ctx.rule.attr.deps 将为 [A(Y), A(Z)]。在此示例中,ctx.rule.attr.deps 是应用方面后的原始目标“deps”的结果。

在此示例中,方面从目标的依赖项访问 FileCountInfo 提供程序,以累积文件的总传递数量。

从规则中调用方面

def _file_count_rule_impl(ctx):
    for dep in ctx.attr.deps:
        print(dep[FileCountInfo].count)

file_count_rule = rule(
    implementation = _file_count_rule_impl,
    attrs = {
        'deps' : attr.label_list(aspects = [file_count_aspect]),
        'extension' : attr.string(default = '*'),
    },
)

规则实现演示了如何通过 ctx.attr.deps 访问 FileCountInfo

此规则定义演示了如何定义参数 (extension) 并为其指定默认值 (*)。请注意,如果默认值不是“cc”“h”或“*”之一,则会因方面定义中对参数的限制而导致错误。

通过目标规则调用方面

load('//:file_count.bzl', 'file_count_rule')

cc_binary(
    name = 'app',
...
)

file_count_rule(
    name = 'file_count',
    deps = ['app'],
    extension = 'h',
)

此示例演示了如何通过规则将 extension 参数传递到方面。由于 extension 参数在规则实现中具有默认值,因此 extension 将被视为可选参数。

构建 file_count 目标时,系统会评估我们的方面本身,以及通过 deps 以递归方式访问的所有目标。

参考