本页介绍了使用 API 的基础知识和好处 面向提供简单和高级的 示例。
通过方面，您可以使用其他信息和操作来增强构建依赖项图。切面可能有用的一些典型场景：
- 集成 Bazel 的 IDE 可以使用切面来收集有关 项目。
- 代码生成工具可以利用方面以与目标无关的方式对其输入进行执行。例如，
BUILD文件可以指定一个层次结构 的 protobuf 库 而特定于语言的规则可以使用切面来附加 用于生成特定语言的 protobuf 支持代码的操作。
切面基础知识
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 文件）并传递位置信息（例如位置信息）
以及这些工件的名称以及与这些目标的反向依赖关系
providers。
方面与规则类似，它们都具有用于生成操作并返回提供程序的实现函数。不过，它们的强大之处在于依赖项图的构建方式。一个方面具有实现以及它沿途传播的所有属性的列表。假设有一个沿着名为“deps”的属性传播的方面 A。此方面可以应用于目标 X，从而生成方面应用节点 A(X)。在应用过程中，A 会递归应用于 X 在其“deps”属性中引用的所有目标（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）的一组属性。公共切面属性
定义参数，并且只能是 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
target 的依赖项以累积总传递文件数。
从规则调用切面
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 目标后，系统会对我们的 aspect 本身以及通过 deps 递归访问的所有目标进行评估。