このページでは、アスペクトを使用する際の基本とメリットについて説明し、簡単な例と高度な例を示します。
アスペクトを使用すると、ビルド依存関係グラフに追加情報とアクションを追加できます。アスペクトが役立つ一般的なシナリオは次のとおりです。
- Bazel を統合する IDE は、アスペクトを使用してプロジェクトに関する情報を収集できます。
- コード生成ツールは、アスペクトを活用して、ターゲットに依存しない方法で入力に対して実行できます。たとえば、
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 ファイルなどのアーティファクトをビルドするアクションを生成し、それらのアーティファクトの場所や名前などの情報を、プロバイダ内のターゲットの逆依存関係に渡します。
アスペクトは、アクションを生成してプロバイダを返す実装関数を持つという点でルールに似ています。ただし、その機能は依存関係グラフの構築方法に由来します。アスペクトには、実装と、伝播するすべての属性のリストがあります。「deps」という名前の属性に沿って伝播するアスペクト A について考えてみましょう。このアスペクトをターゲット X に適用すると、アスペクト アプリケーション ノード A(X) が生成されます。適用中、アスペクト A は、X の「deps」属性で参照されるすべてのターゲット（A の伝播リスト内のすべての属性）に再帰的に適用されます。
したがって、ターゲット X にアスペクト A を適用する単一の操作により、次の図に示すターゲットの元の依存関係グラフの「シャドー グラフ」が生成されます。
図 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 のもう 1 つの一般的な引数は ['*'] です。これは、アスペクトをルールのすべての属性に伝播します。
アスペクトの実装
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 []
アスペクト実装関数は、ルール実装関数に似ています。プロバイダを返し、アクションを生成できます。また、次の 2 つの引数を取ります。
実装関数は、ctx.rule.attr を介してターゲット ルールの属性にアクセスできます。（target 引数を介して）適用先のターゲットによって提供されるプロバイダを調べることができます。
プロバイダのリストを返すには、アスペクトが必要です。この例では、アスペクトは何も提供しないため、空のリストを返します。
コマンドラインを使用してアスペクトを呼び出す
アスペクトを適用する最も簡単な方法は、--aspects 引数を使用してコマンドラインから適用することです。上記のアスペクトが print.bzl という名前のファイルで定義されているとします。
bazel build //MyExample:example --aspects print.bzl%print_aspect
は、ターゲット example と、deps 属性を介して再帰的にアクセス可能なすべてのターゲット ルールに print_aspect を適用します。
--aspects フラグは、<extension file label>%<aspect top-level name> 形式のアスペクトの仕様である引数を 1 つ取ります。
高度な例
次の例は、ターゲット内のファイルをカウントするターゲット ルールの側面を使用する方法を示しています。この側面では、拡張子でフィルタリングすることもできます。プロバイダを使用して値を返す方法、パラメータを使用して引数をアスペクト実装に渡す方法、ルールからアスペクトを呼び出す方法を示します。
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 は、アスペクトの属性のセットを定義します。公開アスペクト属性はパラメータを定義し、bool、int、string のいずれかの型のみにできます。ルール伝播アスペクトの場合、int パラメータと string パラメータには values を指定する必要があります。この例には、値として「*」、「h」、「cc」を指定できる extension というパラメータがあります。
ルール伝播アスペクトの場合、パラメータ値は、同じ名前とタイプのルール属性を使用して、アスペクトをリクエストするルールから取得されます。（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 は 1 つのフィールド 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 を介して再帰的にアクセス可能なすべてのターゲットが評価されます。