はじめに
Bazel を初めて使用する場合ここでは、この最初のビルド チュートリアルでは、Bazel の使用方法を簡単に説明します。このチュートリアルでは、Bazel のコンテキストで使用される主な用語を定義し、Bazel ワークフローの基本について説明します。まず、必要なツールから始めて、複雑さが増す 3 つのプロジェクトをビルドして実行し、複雑さが増す理由と方法について学びます。
Bazel は多言語ビルドをサポートするビルドシステムですが、このチュートリアルでは C++ プロジェクトを例として使用し、ほとんどの言語に適用される一般的なガイドラインとフローについて説明します。
完了までの予想時間: 30 分。
前提条件
まず、Bazel をインストールします(まだインストールしていない場合)。このチュートリアルではソース管理に Git を使用するため、最良の結果を得るには、Git もインストールしてください。
次に、任意のコマンドライン ツールで次のコマンドを実行して、Bazel の GitHub リポジトリからサンプル プロジェクトを取得します。
git clone https://github.com/bazelbuild/examples
このチュートリアルのサンプル プロジェクトは、examples/cpp-tutorial
ディレクトリにあります。
次のように構成されています。
examples
└── cpp-tutorial
├──stage1
│ ├── main
│ │ ├── BUILD
│ │ └── hello-world.cc
│ └── WORKSPACE
├──stage2
│ ├── main
│ │ ├── BUILD
│ │ ├── hello-world.cc
│ │ ├── hello-greet.cc
│ │ └── hello-greet.h
│ └── WORKSPACE
└──stage3
├── main
│ ├── BUILD
│ ├── hello-world.cc
│ ├── hello-greet.cc
│ └── hello-greet.h
├── lib
│ ├── BUILD
│ ├── hello-time.cc
│ └── hello-time.h
└── WORKSPACE
3 つのファイルセットがあり、このチュートリアルでは、各セットがステージを表しています。最初のステージでは、1 つのパッケージ内に 1 つのターゲットをビルドします。2 番目のステージでは、バイナリとライブラリの両方を 1 つのパッケージからビルドします。3 番目の最終ステージでは、複数のパッケージを使用してプロジェクトをビルドし、複数のターゲットを使用してビルドします。
概要: はじめに
Bazel(と Git)をインストールして、このチュートリアルのリポジトリのクローンを作成することで、Bazel を使用した最初のビルドの基盤が整いました。次のセクションに進み、用語を定義し、ワークスペースを設定します。
ご利用にあたって
ワークスペースを設定する
プロジェクトを作成する前に、ワークスペースを設定する必要があります。ワークスペースは、プロジェクトのソースファイルと Bazel のビルド出力を保持するディレクトリです。また、次の重要なファイルも含まれています。
。ディレクトリとその内容を Bazel ワークスペースとして識別し、プロジェクトのディレクトリ構造のルートに存在します。WORKSPACE
file- 1 つ以上の
。プロジェクトのさまざまな部分をビルドする方法を Bazel に指示します。BUILD
filesBUILD
ファイルを含むワークスペース内のディレクトリはパッケージです。(パッケージの詳細については、このチュートリアルの後半で説明します)。
今後のプロジェクトで、ディレクトリを Bazel ワークスペースとして指定するには、そのディレクトリに WORKSPACE
という名前の空のファイルを作成します。このチュートリアルでは、各ステージに WORKSPACE
ファイルがすでに存在します。
注: Bazel がプロジェクトをビルドする場合、すべての入力が同じワークスペースに存在する必要があります。異なるワークスペースに存在するファイルは、リンクされていない限り、互いに独立しています。ワークスペース ルールの詳細については、こちらのガイドをご覧ください。
BUILD ファイルについて
BUILD
ファイルには、Bazel に関するさまざまな種類の手順が含まれています。各 BUILD
ファイルには、一連の手順として少なくとも 1 つのルールが必要です。このルールは、実行可能なバイナリやライブラリなどの目的の出力をビルドする方法を Bazel に指示します。BUILD
ファイル内のビルドルールの各インスタンスは「ターゲット」と呼ばれ、ソースファイルと依存関係の特定のセットを参照します。ターゲットは他のターゲットを指すこともできます。
cpp-tutorial/stage1/main
ディレクトリの BUILD
ファイルを確認します。
cc_binary(
name = "hello-world",
srcs = ["hello-world.cc"],
)
この例では、hello-world
ターゲットが Bazel の組み込み cc_binary rule
をインスタンス化しています。このルールは、依存関係のない hello-world.cc
ソースファイルから自己完結型の実行可能バイナリをビルドするよう Bazel に指示します。
概要: スタートガイド
これで、いくつかの重要な用語と、このプロジェクトと Bazel 全般のコンテキストでの意味を理解できました。次のセクションではプロジェクトのステージ 1 を ビルドしてテストします
ステージ 1: 単一のターゲット、単一のパッケージ
いよいよプロジェクトの第 1 部を完成します。プロジェクトのステージ 1 セクションの構造は次のとおりです。
examples
└── cpp-tutorial
└──stage1
├── main
│ ├── BUILD
│ └── hello-world.cc
└── WORKSPACE
次のコマンドを実行して cpp-tutorial/stage1
ディレクトリに移動します。
cd cpp-tutorial/stage1
続いて、次のコマンドを実行します。
bazel build //main:hello-world
ターゲット ラベルの //main:
の部分は、ワークスペースのルートを基準とする BUILD
ファイルの場所です。hello-world
は、BUILD
ファイル内のターゲット名です。
Bazel は次のようなコードを生成します。
INFO: Found 1 target...
Target //main:hello-world up-to-date:
bazel-bin/main/hello-world
INFO: Elapsed time: 2.267s, Critical Path: 0.25s
最初の Bazel ターゲットをビルドできました。Bazel は、ワークスペースのルートの bazel-bin
ディレクトリにビルド出力を配置します。
次に、新たにビルドされたバイナリをテストします。
bazel-bin/main/hello-world
これにより、「Hello world
」のメッセージが出力されます。
以下は、ステージ 1 の依存関係グラフです。
まとめ: ステージ 1
最初のビルドが完了したので、ビルドの構成について基本的な考え方を理解できました。次のステージでは、別のターゲットを追加して複雑さを高めます。
ステージ 2: 複数のビルド ターゲット
小規模なプロジェクトでは 1 つのターゲットで十分ですが、大規模なプロジェクトは複数のターゲットやパッケージに分割することもできます。これにより、Bazel は変更された箇所のみを再構築するなど、高速な増分ビルドが可能になります。また、プロジェクトの複数の部分を一度にビルドすることで、ビルドを高速化できます。チュートリアルのこのステージではターゲットを追加し、次のステージではパッケージを追加します。
これは、ステージ 2 で作業するディレクトリです。
├──stage2
│ ├── main
│ │ ├── BUILD
│ │ ├── hello-world.cc
│ │ ├── hello-greet.cc
│ │ └── hello-greet.h
│ └── WORKSPACE
cpp-tutorial/stage2/main
ディレクトリの BUILD
ファイルは次のようになります。
cc_library(
name = "hello-greet",
srcs = ["hello-greet.cc"],
hdrs = ["hello-greet.h"],
)
cc_binary(
name = "hello-world",
srcs = ["hello-world.cc"],
deps = [
":hello-greet",
],
)
この BUILD
ファイルを使用して、Bazel はまず hello-greet
ライブラリを(Bazel の組み込み cc_library rule
を使用して)ビルドし、次に hello-world
バイナリをビルドします。hello-world
ターゲットの deps
属性は、hello-world
バイナリをビルドするには hello-greet
ライブラリが必要であることを Bazel に伝えます。
この新しいバージョンのプロジェクトをビルドする前に、ディレクトリを変更し、次のコマンドを実行して cpp-tutorial/stage2
ディレクトリに切り替える必要があります。
cd ../stage2
これで、以下の使い慣れたコマンドを使用して新しいバイナリをビルドできるようになりました。
bazel build //main:hello-world
この場合も、Bazel は次のようなコードを生成します。
INFO: Found 1 target...
Target //main:hello-world up-to-date:
bazel-bin/main/hello-world
INFO: Elapsed time: 2.399s, Critical Path: 0.30s
これで、新たにビルドされたバイナリをテストできるようになりました。これにより、別の「Hello world
」が返されます。
bazel-bin/main/hello-world
ここで hello-greet.cc
を変更してプロジェクトを再ビルドすると、Bazel はそのファイルのみを再コンパイルします。
依存関係グラフを見ると、hello-world
が hello-greet
という名前の追加入力に依存していることがわかります。
まとめ: ステージ 2
これで、2 つのターゲットを持つプロジェクトがビルドされました。hello-world
ターゲットは 1 つのソースファイルをビルドし、他の 1 つのターゲット(//main:hello-greet
)に依存します。このターゲットは 2 つの追加のソースファイルをビルドします。次のセクションでは、さらに一歩進んで別のパッケージを追加します。
ステージ 3: 複数のパッケージ
次のステージでは、ウォッチフェイスの追加機能をさらに追加し、複数のパッケージを使用してプロジェクトをビルドします。cpp-tutorial/stage3
ディレクトリの構造と内容を以下に示します。
└──stage3
├── main
│ ├── BUILD
│ ├── hello-world.cc
│ ├── hello-greet.cc
│ └── hello-greet.h
├── lib
│ ├── BUILD
│ ├── hello-time.cc
│ └── hello-time.h
└── WORKSPACE
2 つのサブディレクトリがあり、それぞれに BUILD
ファイルがあることがわかります。したがって、Bazel では、ワークスペースに lib
と main
の 2 つのパッケージが含まれるようになりました。
lib/BUILD
ファイルを確認します。
cc_library(
name = "hello-time",
srcs = ["hello-time.cc"],
hdrs = ["hello-time.h"],
visibility = ["//main:__pkg__"],
)
main/BUILD
ファイルで次のようにします。
cc_library(
name = "hello-greet",
srcs = ["hello-greet.cc"],
hdrs = ["hello-greet.h"],
)
cc_binary(
name = "hello-world",
srcs = ["hello-world.cc"],
deps = [
":hello-greet",
"//lib:hello-time",
],
)
メイン パッケージの hello-world
ターゲットは、lib
パッケージの hello-time
ターゲットに依存します(したがって、ターゲット ラベルは //lib:hello-time
)。Bazel は、deps
属性を通じてこれを認識します。これは依存関係グラフに反映されています。
ビルドを成功させるには、 visibility 属性を使用して、lib/BUILD
の //lib:hello-time
ターゲットを main/BUILD
のターゲットに明示的に表示します。これは、デフォルトではターゲットは同じ BUILD
ファイル内の他のターゲットにのみ表示されるためです。Bazel はターゲットの可視性を使用して、実装の詳細を含むライブラリが公開 API に漏れるなどの問題を防ぎます。
プロジェクトのこの最終バージョンをビルドします。次のコマンドを実行して cpp-tutorial/stage3
ディレクトリに切り替えます。
cd ../stage3
もう一度、次のコマンドを実行します。
bazel build //main:hello-world
Bazel は次のようなコードを生成します。
INFO: Found 1 target...
Target //main:hello-world up-to-date:
bazel-bin/main/hello-world
INFO: Elapsed time: 0.167s, Critical Path: 0.00s
次に、このチュートリアルの最後のバイナリで、最終的な Hello world
メッセージをテストします。
bazel-bin/main/hello-world
まとめ: ステージ 3
これで、プロジェクトを 3 つのターゲットを持つ 2 つのパッケージとしてビルドし、それらの依存関係を理解できました。これにより、Bazel を使用して将来のプロジェクトをビルドできるようになります。次のセクションでは、Bazel による作業を継続する方法について説明します。
次のステップ
これで、Bazel を使用した最初の基本的なビルドが完了しましたが、これは始まりにすぎません。Bazel を使用した学習を続けるためのリソースをいくつかご紹介します。
- 引き続き C++ に注目する場合は、一般的な C++ ビルドのユースケースをご覧ください。
- Bazel を使用した他のアプリケーションのビルドを開始するには、Java、Android アプリケーション、または iOS アプリケーションのチュートリアルをご覧ください。
- ローカル リポジトリとリモート リポジトリの操作の詳細については、外部依存関係をご覧ください。
- Bazel のその他のルールについて詳しくは、こちらのリファレンス ガイドをご覧ください。
ご利用をお待ちしております。