このページでは、マクロとルールを使用して BUILD 言語を拡張する方法について説明します。
Bazel 拡張機能は、.bzl で終わるファイルです。拡張機能からシンボルをインポートするには、
load ステートメントを使用します。
高度なコンセプトを学ぶ前に、まず次のことを行います。
Starlark 言語について学習します。この言語は、
BUILDファイルと.bzlファイルの両方で使用されます。2 つの
BUILDファイル間で 変数を共有する 方法について学習します。
マクロとルール
マクロは、ルールをインスタンス化する関数です。BUILD
ファイルが繰り返しが多くなりすぎたり、複雑になりすぎたりした場合に便利です。一部のコードを再利用できるためです。関数は、BUILD
ファイルが読み取られるとすぐに評価されます。BUILD ファイルの評価後、Bazel はマクロに関する情報をほとんど持っていません。マクロが
genrule を生成する場合、Bazel は genrule を記述したかのように動作します。その結果、bazel query
には生成された genrule のみが表示されます。
ルールはマクロよりも強力です。Bazel の内部にアクセスして、何が起こっているかを完全に制御できます。たとえば、他のルールに情報を渡すことができます。
単純なロジックを再利用する場合は、マクロから始めます。マクロが複雑になった場合は、ルールにすることをおすすめします。通常、新しい言語のサポートはルールを使用して行われます。ルールは上級ユーザー向けであり、ほとんどのユーザーはルールを作成する必要はありません。既存のルールを読み込んで呼び出すだけです。
評価モデル
ビルドは 3 つのフェーズで構成されます。
読み込みフェーズ 。まず、ビルドに必要なすべての拡張機能とすべての
BUILDファイルを読み込んで評価します。BUILDファイルの実行では、ルールがインスタンス化されます（ルールが呼び出されるたびに、グラフに追加されます）。ここでマクロが評価されます。分析フェーズ 。ルールのコード（
implementation関数）が実行され、アクションがインスタンス化されます。アクションは、一連の入力から一連の出力を生成する方法を記述します（例: hello.c で gcc を実行して hello.o を取得する）。実際のコマンドを実行する前に、生成されるファイルを明示的にリストする必要があります。つまり、分析フェーズでは、読み込みフェーズで生成されたグラフを取得し、アクション グラフを生成します。実行フェーズ 。出力の少なくとも 1 つが必要な場合に、アクションが実行されます。ファイルが見つからない場合や、コマンドで出力が生成されない場合、ビルドは失敗します。このフェーズではテストも実行されます。
Bazel は並列処理を使用して、.bzl ファイルと BUILD
ファイルを読み取り、解析して評価します。ファイルはビルドごとに最大 1 回読み取られ、評価の結果はキャッシュに保存されて再利用されます。ファイルは、すべての依存関係（load()
ステートメント）が解決された場合にのみ評価されます。.bzl
ファイルの読み込みには、目に見える副作用はありません。値と関数のみを定義します。
Bazel は、依存関係分析を使用して、読み込む必要があるファイル、分析する必要があるルール、実行する必要があるアクションを把握します。たとえば、現在のビルドに必要ないアクションをルールが生成した場合、それらのアクションは実行されません。
拡張機能を作成する
コードを再利用するために、 最初のマクロを作成します。次に、マクロの詳細と、 マクロを使用して「カスタム動詞」を作成する方法について学習します。
ルールのチュートリアルに沿って、ルールの使用を開始します。 次に、ルールのコンセプトについて詳しく学習します。
独自の拡張機能を作成する際に、次の 2 つのリンクが非常に役立ちます。すぐにアクセスできるようにしておきましょう。
さらに詳しく
マクロとルールに加えて、 アスペクトとリポジトリ ルールを作成することもできます。
Buildifier を 一貫して使用して、コードのフォーマットとリントを行います。
コードをテストします。
ユーザー向けのドキュメントを生成します。
コードのパフォーマンスを最適化します。
拡張機能を他のユーザーにデプロイします。