本页介绍了使用 API 的基础知识和好处 面向提供简单和高级的 示例。
通过方面，您可以使用其他信息和操作来增强构建依赖项图。切面可能有用的一些典型场景：
- 集成了 Bazel 的 IDE 可以使用 aspect 收集有关项目的信息。
- 代码生成工具可以利用方面对输入的
与目标无关的方式。例如，
BUILD文件可以指定一个层次结构 的 protobuf 库 而特定于语言的规则可以使用切面来附加 用于生成特定语言的 protobuf 支持代码的操作。
宽高比基础知识
BUILD 文件用于描述项目的源代码：项目包含哪些源文件、应根据这些文件构建哪些工件（目标）、这些文件之间的依赖项是什么等等。Bazel 使用这些信息执行构建，即确定生成工件所需的一组操作（例如运行编译器或链接器），并执行这些操作。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 文件）并传递位置信息（例如位置信息）
以及这些工件的名称以及与这些目标的反向依赖关系
providers。
切面与规则类似，因为它们有一个实现函数， 生成操作和退货提供器。不过，它们的强大力量来自于 为它们构建依赖关系图的方式。切面有一个实现 以及它传播的所有属性的列表。假设有一个沿着名为“deps”的属性传播的方面 A。此切面可以应用于 目标 X，从而生成切面应用节点 A(X)。在应用过程中 方面 A 以递归方式应用于 X 在其“依赖项”中引用的所有目标 属性（A 传播列表中的所有属性）。
因此，将 A 方面应用于目标 X 的单次操作会产生目标原始依赖项图的“阴影图”，如下图所示：
图 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'],
)
我们将该示例拆分为各个部分，并分别对其进行检查。
切面定义
print_aspect = aspect(
implementation = _print_aspect_impl,
attr_aspects = ['deps'],
)
方面定义与规则定义类似，并使用 aspect 函数进行定义。
与规则一样，一个方面也有一个实现函数，在本例中为 _print_aspect_impl。
attr_aspects 是切面传播的规则属性列表。
在这种情况下，该方面将沿其应用到的规则的 deps 属性传播。
attr_aspects 的另一个常见参数是 ['*']，该参数会传播
对规则的所有属性加以说明
方面实现
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 []
方面实现函数类似于规则实现函数。它们会返回提供程序，可以生成操作，并接受两个参数：
实现函数可以通过 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',
)
切面定义
file_count_aspect = aspect(
implementation = _file_count_aspect_impl,
attr_aspects = ['deps'],
attrs = {
'extension' : attr.string(values = ['*', 'h', 'cc']),
}
)
此示例展示了切面如何通过 deps 属性传播。
attrs 用于定义某个方面（aspect）的一组属性。公开的 aspect 属性用于定义参数，并且只能是 bool、int 或 string 类型。对于通过规则传播的方面，int 和 string 参数必须指定 values。此示例包含一个名为 extension 的参数，其值可以是“*”“h”或“cc”。
对于规则传播的方面，系统会使用具有相同名称和类型的规则属性，从请求该方面的规则中获取参数值。（请参阅 file_count_rule 的定义）。
对于命令行切面，可以使用
--aspects_parameters
标志。int 和 string 参数的 values 限制可能为
。
方面还可以具有类型为 label 或 label_list 的私有属性。自有品牌属性可用于指定由方面生成的操作所需的工具或库的依赖项。没有
此示例中定义的私有属性，但以下代码段
演示了如何将工具传递给切面：
...
attrs = {
'_protoc' : attr.label(
default = Label('//tools:protoc'),
executable = True,
cfg = "exec"
)
}
...
切面实现
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 是 Target 对象，是将此 aspect 应用于已应用此 aspect 的原始 target 的“依赖项”的结果。
在该示例中，该方面从目标的依赖项访问 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 = '*'),
},
)
规则实施演示了如何访问 FileCountInfo
通过 ctx.attr.deps 发送。
规则定义演示了如何定义参数 (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 参数传递到 aspect。由于 extension 参数在
则 extension 会被视为可选参数。
构建 file_count 目标后，系统将针对
本身，以及可通过 deps 以递归方式访问的所有目标。