BazelCon 2025 の登録と CFP が開始されました。

このページは Cloud Translation API によって翻訳されました。

クエリのクイックスタート

問題を報告ソースを表示 Nightly · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

このチュートリアルでは、Bazel を使用して、事前に作成された Bazel プロジェクトでコードの依存関係をトレースする方法について説明します。

言語と --output フラグの詳細については、Bazel クエリリファレンスと Bazel cquery リファレンスのマニュアルをご覧ください。IDE でヘルプを表示するには、コマンドラインで bazel help query または bazel help cquery と入力します。

目標

このガイドでは、プロジェクトのファイル依存関係について詳しく知るために使用できる一連の基本的なクエリについて説明します。このガイドは、Bazel と BUILD ファイルの仕組みに関する基本的な知識を持つ新しい Bazel デベロッパーを対象としています。

前提条件

まだインストールしていない場合は、まず Bazel をインストールします。このチュートリアルではソース管理に Git を使用するため、最良の結果を得るには Git もインストールしてください。

依存関係グラフを可視化するには、Graphviz というツールを使用します。このツールは、ダウンロードして、このガイドに沿って操作できます。

サンプルプロジェクトを取得する

次に、任意のコマンドラインツールで次のコマンドを実行して、Bazel のサンプルリポジトリからサンプルアプリを取得します。

git clone https://github.com/bazelbuild/examples.git

このチュートリアルのサンプルプロジェクトは examples/query-quickstart ディレクトリにあります。

スタートガイド

Bazel クエリとは

クエリは、BUILD ファイル間の関係を分析し、結果の出力を調べて有用な情報を得ることで、Bazel コードベースについて学習するのに役立ちます。このガイドでは、基本的なクエリ関数をいくつか紹介しますが、その他のオプションについては、クエリガイドをご覧ください。クエリを使用すると、BUILD ファイルを手動でナビゲートすることなく、大規模なプロジェクトの依存関係を把握できます。

クエリを実行するには、コマンドラインターミナルを開いて次のように入力します。

bazel query 'query_function'

シナリオ

Cafe Bazel とそれぞれのシェフの関係を掘り下げるシナリオを考えてみましょう。このカフェでは、ピザとマカロニチーズのみを販売しています。プロジェクトの構造は次のとおりです。

bazelqueryguide
├── BUILD
├── src
│   └── main
│       └── java
│           └── com
│               └── example
│                   ├── customers
│                   │   ├── Jenny.java
│                   │   ├── Amir.java
│                   │   └── BUILD
│                   ├── dishes
│                   │   ├── Pizza.java
│                   │   ├── MacAndCheese.java
│                   │   └── BUILD
│                   ├── ingredients
│                   │   ├── Cheese.java
│                   │   ├── Tomatoes.java
│                   │   ├── Dough.java
│                   │   ├── Macaroni.java
│                   │   └── BUILD
│                   ├── restaurant
│                   │   ├── Cafe.java
│                   │   ├── Chef.java
│                   │   └── BUILD
│                   ├── reviews
│                   │   ├── Review.java
│                   │   └── BUILD
│                   └── Runner.java
└── WORKSPACE

このチュートリアルでは、特に指示がない限り、必要な情報を BUILD ファイルで探すのではなく、クエリ関数のみを使用してください。

プロジェクトは、Cafe を構成するさまざまなパッケージで構成されます。restaurant、ingredients、dishes、customers、reviews に分割されます。これらのパッケージ内のルールは、さまざまなタグと依存関係を持つ Cafe のさまざまなコンポーネントを定義します。

ビルドの実行

このプロジェクトには、Runner.java 内に main メソッドが含まれています。このメソッドを実行すると、カフェのメニューが出力されます。bazel build コマンドを使用して Bazel でプロジェクトをビルドし、: を使用してターゲットの名前が runner であることを示します。ターゲットを参照する方法については、ターゲット名をご覧ください。

このプロジェクトをビルドするには、このコマンドをターミナルに貼り付けます。

bazel build :runner

ビルドが成功すると、出力は次のようになります。

INFO: Analyzed target //:runner (49 packages loaded, 784 targets configured).
INFO: Found 1 target...
Target //:runner up-to-date:
  bazel-bin/runner.jar
  bazel-bin/runner
INFO: Elapsed time: 16.593s, Critical Path: 4.32s
INFO: 23 processes: 4 internal, 10 darwin-sandbox, 9 worker.
INFO: Build completed successfully, 23 total actions

ビルドが正常に完了したら、次のコマンドを貼り付けてアプリケーションを実行します。

bazel-bin/runner

--------------------- MENU -------------------------

Pizza - Cheesy Delicious Goodness
Macaroni & Cheese - Kid-approved Dinner

----------------------------------------------------

メニュー項目のリストと簡単な説明が表示されます。

ターゲットの探索

このプロジェクトでは、材料と料理が独自のパッケージにリストされています。クエリを使用してパッケージのルールを表示するには、bazel query package/… コマンドを実行します。

この場合、次のコマンドを実行して、このカフェの食材と料理を確認できます。

bazel query //src/main/java/com/example/dishes/...

bazel query //src/main/java/com/example/ingredients/...

ingredients パッケージのターゲットをクエリすると、出力は次のようになります。

//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/ingredients:dough
//src/main/java/com/example/ingredients:macaroni
//src/main/java/com/example/ingredients:tomato

依存関係を見つける

ランナーはどのような目標を立てて走っていますか？

たとえば、ファイルシステムを調べずに（大規模なプロジェクトでは実行できない可能性があります）、プロジェクトの構造を詳しく調べたいとします。Cafe Bazel はどのようなルールを使用していますか？

この例のように、ランナーのターゲットが runner の場合は、次のコマンドを実行してターゲットの基盤となる依存関係を検出します。

bazel query --noimplicit_deps "deps(target)"

bazel query --noimplicit_deps "deps(:runner)"

//:runner
//:src/main/java/com/example/Runner.java
//src/main/java/com/example/dishes:MacAndCheese.java
//src/main/java/com/example/dishes:Pizza.java
//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/dishes:pizza
//src/main/java/com/example/ingredients:Cheese.java
//src/main/java/com/example/ingredients:Dough.java
//src/main/java/com/example/ingredients:Macaroni.java
//src/main/java/com/example/ingredients:Tomato.java
//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/ingredients:dough
//src/main/java/com/example/ingredients:macaroni
//src/main/java/com/example/ingredients:tomato
//src/main/java/com/example/restaurant:Cafe.java
//src/main/java/com/example/restaurant:Chef.java
//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef

ほとんどの場合、クエリ関数 deps() を使用して、特定のターゲットの個々の出力依存関係を確認します。

依存関係グラフの可視化（省略可）

このセクションでは、特定のクエリの依存関係パスを可視化する方法について説明します。Graphviz を使用すると、パスをフラットなリストではなく有向非巡回グラフ画像として表示できます。さまざまな --output コマンドラインオプションを使用して、Bazel クエリグラフの表示を変更できます。オプションについては、出力形式をご覧ください。

まず、目的のクエリを実行し、--noimplicit_deps フラグを追加して、過剰なツール依存関係を削除します。次に、クエリの後に出力フラグを追加し、グラフを graph.in というファイルに保存して、グラフのテキスト表現を作成します。

ターゲット :runner のすべての依存関係を検索し、出力をグラフとしてフォーマットするには:

bazel query --noimplicit_deps 'deps(:runner)' --output graph > graph.in

これにより、ビルドグラフのテキスト表現である graph.in というファイルが作成されます。Graphviz は、テキストを視覚化するツールである dot を使用して png を作成します。

dot -Tpng < graph.in > graph.png

graph.png を開くと、次のように表示されます。以下のグラフは、このガイドで重要なパスの詳細をわかりやすくするために簡略化されています。

カフェからシェフ、料理（ピザとマカロニチーズ）への関係を示す図。料理は、チーズ、トマト、生地、マカロニなどの個別の材料に分岐しています。

このガイド全体でさまざまなクエリ関数の出力を確認する場合に役立ちます。

逆依存関係を見つける

特定のターゲットを分析して、他のターゲットでそのターゲットが使用されているかどうかを確認する場合は、クエリを使用して、特定のルールに依存するターゲットを調べることができます。これは「逆依存関係」と呼ばれます。rdeps() を使用すると、よく知らないコードベースでファイルを編集する際に、そのファイルに依存する他のファイルを誤って破損させることを防ぐことができます。

たとえば、材料 cheese を編集するとします。Cafe Bazel に問題が発生しないようにするには、cheese を使用している料理を確認する必要があります。

特定のターゲット/パッケージに依存するターゲットを確認するには、rdeps(universe_scope, target) を使用します。rdeps() クエリ関数は、少なくとも 2 つの引数（関連するディレクトリである universe_scope と target）を受け取ります。Bazel は、指定された universe_scope 内でターゲットの逆依存関係を検索します。rdeps() 演算子は、オプションの 3 番目の引数として、検索の深さの上限を指定する整数リテラルを受け取ります。

プロジェクト全体（//…）のスコープ内でターゲット cheese の逆依存関係を探すには、次のコマンドを実行します。

bazel query "rdeps(universe_scope, target)"

ex) bazel query "rdeps(//... , //src/main/java/com/example/ingredients:cheese)"

//:runner
//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/dishes:pizza
//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef

クエリの戻り値は、チーズがピザとマカロニチーズの両方で使用されていることを示しています。なんていうことだろう！

タグに基づいてターゲットを見つける

Bazel Cafe に 2 人のお客様（Amir と Jenny）が入店しました。名前以外の情報は何もわかっていません。幸いなことに、注文には「customers」BUILD ファイルでタグが付けられています。このタグにアクセスするにはどうすればよいですか？

デベロッパーは、多くの場合テスト目的で、さまざまな識別子を使用して Bazel ターゲットにタグ付けできます。たとえば、テストのタグは、デバッグプロセスとリリースプロセスにおけるテストの役割をアノテーションできます。特に、ランタイムアノテーション機能がない C++ テストと Python テストで役立ちます。タグとサイズ要素を使用すると、コードベースのチェックインポリシーに基づいてテストスイートを柔軟に組み立てることができます。

この例では、タグはメニュー項目を表す pizza または macAndCheese のいずれかです。このコマンドは、特定のパッケージ内で識別子に一致するタグを持つターゲットをクエリします。

bazel query 'attr(tags, "pizza", //src/main/java/com/example/customers/...)'

このクエリは、「pizza」というタグを持つ「customers」パッケージ内のすべてのターゲットを返します。

理解度チェック

このクエリを使用して、Jenny が注文したいものを確認します。

回答

マカロニチーズ

新しい依存関係を追加する

Cafe Bazel のメニューが拡充され、スムージーを注文できるようになりました。このスムージーは、Strawberry と Banana の材料で構成されています。

まず、スムージーが依存する材料（Strawberry.java と Banana.java）を追加します。空の Java クラスを追加します。

src/main/java/com/example/ingredients/Strawberry.java

package com.example.ingredients;

public class Strawberry {

}

src/main/java/com/example/ingredients/Banana.java

package com.example.ingredients;

public class Banana {

}

次に、Smoothie.java を適切なディレクトリ dishes に追加します。

src/main/java/com/example/dishes/Smoothie.java

package com.example.dishes;

public class Smoothie {
    public static final String DISH_NAME = "Smoothie";
    public static final String DESCRIPTION = "Yummy and Refreshing";
}

最後に、これらのファイルを適切な BUILD ファイルのルールとして追加します。新しい材料ごとに、名前、公開設定、新しく作成した「src」ファイルを含む新しい Java ライブラリを作成します。更新された BUILD ファイルは次のようになります。

src/main/java/com/example/ingredients/BUILD

java_library(
    name = "cheese",
    visibility = ["//visibility:public"],
    srcs = ["Cheese.java"],
)

java_library(
    name = "dough",
    visibility = ["//visibility:public"],
    srcs = ["Dough.java"],
)

java_library(
    name = "macaroni",
    visibility = ["//visibility:public"],
    srcs = ["Macaroni.java"],
)

java_library(
    name = "tomato",
    visibility = ["//visibility:public"],
    srcs = ["Tomato.java"],
)

java_library(
    name = "strawberry",
    visibility = ["//visibility:public"],
    srcs = ["Strawberry.java"],
)

java_library(
    name = "banana",
    visibility = ["//visibility:public"],
    srcs = ["Banana.java"],
)

料理の BUILD ファイルで、Smoothie の新しいルールを追加します。これにより、Smoothie 用に作成された Java ファイルが「src」ファイルとして含まれ、スムージーの各材料用に作成した新しいルールも含まれます。

src/main/java/com/example/dishes/BUILD

java_library(
    name = "macAndCheese",
    visibility = ["//visibility:public"],
    srcs = ["MacAndCheese.java"],
    deps = [
        "//src/main/java/com/example/ingredients:cheese",
        "//src/main/java/com/example/ingredients:macaroni",
    ],
)

java_library(
    name = "pizza",
    visibility = ["//visibility:public"],
    srcs = ["Pizza.java"],
    deps = [
        "//src/main/java/com/example/ingredients:cheese",
        "//src/main/java/com/example/ingredients:dough",
        "//src/main/java/com/example/ingredients:tomato",
    ],
)

java_library(
    name = "smoothie",
    visibility = ["//visibility:public"],
    srcs = ["Smoothie.java"],
    deps = [
        "//src/main/java/com/example/ingredients:strawberry",
        "//src/main/java/com/example/ingredients:banana",
    ],
)

最後に、スムージーを Chef の BUILD ファイルの依存関係として含めます。

src/main/java/com/example/restaurant/BUILD

java\_library(
    name = "chef",
    visibility = ["//visibility:public"],
    srcs = [
        "Chef.java",
    ],

    deps = [
        "//src/main/java/com/example/dishes:macAndCheese",
        "//src/main/java/com/example/dishes:pizza",
        "//src/main/java/com/example/dishes:smoothie",
    ],
)

java\_library(
    name = "cafe",
    visibility = ["//visibility:public"],
    srcs = [
        "Cafe.java",
    ],
    deps = [
        ":chef",
    ],
)

cafe を再度ビルドして、エラーがないことを確認します。ビルドが正常に完了したら、おめでとうございます。「Cafe」の新しい依存関係を追加しました。そうでない場合は、スペルミスやパッケージの命名に注意してください。BUILD ファイルの作成について詳しくは、BUILD スタイルガイドをご覧ください。

Smoothie を追加した新しい依存関係グラフを可視化して、以前のグラフと比較します。わかりやすくするために、グラフの入力を graph2.in と graph2.png にします。

bazel query --noimplicit_deps 'deps(:runner)' --output graph > graph2.in

dot -Tpng < graph2.in > graph2.png

graph2.png を見ると、Smoothie は他の料理と共有の依存関係がなく、Chef が依存する別のターゲットにすぎないことがわかります。

somepath() と allpaths()

あるパッケージが別のパッケージに依存している理由をクエリする場合はどうすればよいですか？2 つの間の依存関係パスを表示すると、答えが得られます。

依存関係パスを見つけるには、somepath() と allpaths() の 2 つの関数を使用できます。開始ターゲット S と終了ポイント E が与えられた場合、somepath(S,E) を使用して S と E の間のパスを見つけます。

「Chef」ターゲットと「Cheese」ターゲットの関係を確認して、この 2 つの関数の違いを確認します。あるターゲットから別のターゲットに到達するには、さまざまな方法があります。

Chef → MacAndCheese → Cheese
Chef → Pizza → Cheese

somepath() は 2 つのオプションのうちの 1 つのパスを返しますが、allpaths() は可能なすべてのパスを出力します。

Cafe Bazel を例として、次のコマンドを実行します。

bazel query "somepath(//src/main/java/com/example/restaurant/..., //src/main/java/com/example/ingredients:cheese)"

//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef
//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/ingredients:cheese

出力は、Cafe → Chef → MacAndCheese → Cheese の最初のパスに従います。代わりに allpaths() を使用すると、次のようになります。

bazel query "allpaths(//src/main/java/com/example/restaurant/..., //src/main/java/com/example/ingredients:cheese)"

//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/dishes:pizza
//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef

カフェからシェフ、ピザ、マカロニチーズ、チーズへの出力パス

allpaths() の出力は、依存関係のフラット化されたリストであるため、少し読みにくくなります。Graphviz を使用してこのグラフを可視化すると、関係をより明確に理解できます。

理解度チェック

Cafe Bazel のお客様が、このレストランの最初のクチコミを投稿しました。申し訳ございませんが、レビューの投稿者の身元や、どの料理について言及しているかなどの詳細が不明です。幸いなことに、Bazel を使用してこの情報にアクセスできます。reviews パッケージには、ミステリーショッパーのレビューを出力するプログラムが含まれています。次のコマンドでビルドして実行します。

bazel build //src/main/java/com/example/reviews:review

bazel-bin/src/main/java/com/example/reviews/review

Bazel クエリのみを使用して、レビューを書いたユーザーと、そのユーザーが説明している料理を特定します。

ヒント

タグと依存関係で役立つ情報を確認します。

回答

このレビューはピザについてのもので、レビューしたのは Amir でした。bazel query --noimplicit\_deps 'deps(//src/main/java/com/example/reviews:review)' を使用してこのルールの依存関係を確認すると、Amir が審査者であることがわかります。次に、レビュー担当者が Amir であることがわかっているので、クエリ関数を使用して、Amir が `BUILD` ファイルに持っているタグを検索し、どの料理があるかを確認できます。コマンド bazel query 'attr(tags, "pizza", //src/main/java/com/example/customers/...)' は、ピザを注文した唯一の顧客が Amir であり、レビューアーであることを出力します。これが答えです。

まとめ

これで、これで、いくつかの基本的なクエリを実行しました。これらのクエリは、独自のプロジェクトで試すことができます。クエリ言語の構文について詳しくは、クエリのリファレンスページをご覧ください。より高度なクエリが必要な場合は、クエリガイドでは、このガイドで説明するよりも多くのユースケースの詳細なリストを紹介しています。

クエリのクイックスタート

目標

前提条件

サンプル プロジェクトを取得する

スタートガイド

Bazel クエリとは

シナリオ

ビルドの実行

ターゲットの探索

依存関係を見つける

依存関係グラフの可視化（省略可）

逆依存関係を見つける

タグに基づいてターゲットを見つける

理解度チェック

回答

新しい依存関係を追加する

somepath() と allpaths()

理解度チェック

ヒント

回答

まとめ

サンプルプロジェクトを取得する