安定版リリースのドキュメントについては、[バージョニングされたドキュメント] プルダウンを使用してください。デフォルトのビューには HEAD の最新バージョンが表示されます。

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

Bazel チュートリアル: Java プロジェクトをビルドする

このチュートリアルでは、Bazel を使用した Java アプリケーションのビルドの基本について説明します。ワークスペースを設定し、ターゲットや BUILD ファイルなど、Bazel の主なコンセプトを示す単純な Java プロジェクトを構築します。

推定完了時間: 30 分。

学習内容

このチュートリアルでは、次の方法を学習します。

ターゲットをビルドする
プロジェクトの依存関係を可視化する
プロジェクトを複数のターゲットとパッケージに分割する
パッケージ全体でのターゲットの公開設定を制御する
ラベルを使用してターゲットを参照する
ターゲットをデプロイする

始める前に

Bazel をインストールする

チュートリアルの準備をするには、まず Bazel をインストールします（まだインストールしていない場合）。

JDK をインストールする

Java JDK をインストールします（推奨バージョンは 11 ですが、サポートされるバージョンは 8 ～ 15 です）。
JDK を参照するように JAVA_HOME 環境変数を設定します。
- Linux/macOS の場合:
```
export JAVA_HOME="$(dirname $(dirname $(realpath $(which javac))))"
```
- Windows の場合:
  1. コントロールパネルを開きます。
  2. [システムとセキュリティ] > [システム] > [システムの詳細設定] > [詳細設定] タブ > [環境変数...] に移動します。.
  3. [ユーザー変数] リスト（最上部にあるリスト）で [新規...] をクリックします。
  4. [変数名] に「JAVA_HOME」と入力します。
  5. [Browse Directory...] をクリックします。
  6. JDK ディレクトリに移動します（例: C:\Program Files\Java\jdk1.8.0_152）。
  7. すべてのダイアログウィンドウで [OK] をクリックします。

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

Bazel の GitHub リポジトリからサンプルプロジェクトを取得します。

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

このチュートリアルのサンプルプロジェクトは examples/java-tutorial ディレクトリにあり、次のような構造になっています。

java-tutorial
├── BUILD
├── src
│   └── main
│       └── java
│           └── com
│               └── example
│                   ├── cmdline
│                   │   ├── BUILD
│                   │   └── Runner.java
│                   ├── Greeting.java
│                   └── ProjectRunner.java
└── MODULE.bazel

Bazel を使用したビルド

ワークスペースをセットアップする

プロジェクトをビルドするには、その前にワークスペースを設定する必要があります。ワークスペースは、プロジェクトのソースファイルと Bazel のビルド出力を格納するディレクトリです。また、Bazel が特殊なファイルとして認識しているファイルも含まれています。

MODULE.bazel ファイル。ディレクトリとそのコンテンツを Bazel ワークスペースとして識別し、プロジェクトのディレクトリ構造のルートにあります。
1 つ以上の BUILD ファイル。プロジェクトのさまざまな部分のビルド方法を Bazel に指定します。（BUILD ファイルを含むワークスペース内のディレクトリはパッケージです。パッケージについては、このチュートリアルの後半で説明します）。

ディレクトリを Bazel ワークスペースとして指定するには、そのディレクトリに MODULE.bazel という名前の空のファイルを作成します。

Bazel がプロジェクトをビルドする場合、すべての入力と依存関係を同じワークスペースにする必要があります。異なるワークスペースに存在するファイルは、リンクされていない限り互いに独立しています。このチュートリアルでは説明しません。

BUILD ファイルについて

BUILD ファイルには、Bazel に関するさまざまな種類の手順が含まれています。最も重要なタイプはビルドルールです。ビルドルールによって、実行可能なバイナリやライブラリなどの必要な出力のビルド方法を Bazel に指示できます。BUILD ファイル内のビルドルールの各インスタンスはターゲットと呼ばれ、ソースファイルと依存関係の特定のセットを参照します。ターゲットは他のターゲットを指すこともできます。

java-tutorial/BUILD ファイルを確認します。

java_binary(
    name = "ProjectRunner",
    srcs = glob(["src/main/java/com/example/*.java"]),
)

この例では、ProjectRunner ターゲットは Bazel の組み込み java_binary ルールをインスタンス化します。このルールは、.jar ファイルとラッパーシェルスクリプト（どちらもターゲットにちなんだ名前）をビルドするよう Bazel に指示します。

ターゲットの属性には、その依存関係とオプションが明示的に記述されています。name 属性は必須ですが、多くは省略可能です。たとえば、ProjectRunner ルールターゲットでは、name はターゲットの名前、srcs は Bazel がターゲットのビルドに使用するソースファイルを指定します。main_class はメインメソッドを含むクラスを指定します。（この例では、ソースファイルを 1 つずつリストするのではなく、glob を使用して Bazel にソースファイルを渡します）。

プロジェクトをビルドする

サンプルプロジェクトをビルドするには、java-tutorial ディレクトリに移動して次のコマンドを実行します。

bazel build //:ProjectRunner

ターゲットラベルの // の部分は、ワークスペースのルートからの BUILD ファイルの場所（この場合はルート自体）で、ProjectRunner は BUILD ファイルのターゲット名です。（ターゲットラベルについては、このチュートリアルの最後に詳しく説明します）。

Bazel では、次のような出力が生成されます。

   INFO: Found 1 target...
   Target //:ProjectRunner up-to-date:
      bazel-bin/ProjectRunner.jar
      bazel-bin/ProjectRunner
   INFO: Elapsed time: 1.021s, Critical Path: 0.83s

これで、最初の Bazel ターゲットをビルドできました。Bazel は、ビルド出力をワークスペースのルートの bazel-bin ディレクトリに配置します。内容を読んで、Bazel の出力構造を理解してください。

新しく作成したバイナリをテストします。

bazel-bin/ProjectRunner

依存関係グラフを確認する

Bazel では、BUILD ファイルでビルド依存関係を明示的に宣言する必要があります。Bazel は、これらのステートメントを使用してプロジェクトの依存関係グラフを作成します。これにより、正確な増分ビルドが可能になります。

サンプルプロジェクトの依存関係を可視化するには、ワークスペースのルートで次のコマンドを実行して、依存関係グラフのテキスト表現を生成します。

bazel query  --notool_deps --noimplicit_deps "deps(//:ProjectRunner)" --output graph

上記のコマンドは、ターゲット //:ProjectRunner のすべての依存関係（ホストと暗黙的な依存関係を除く）を検索し、出力をグラフとしてフォーマットするように Bazel に指示します。

次に、テキストを GraphViz に貼り付けます。

このように、プロジェクトには、追加の依存関係なしで 2 つのソースファイルをビルドする 1 つのターゲットがあります。

ターゲット「ProjectRunner」の依存関係グラフ

ワークスペースを設定し、プロジェクトをビルドして依存関係を確認したら、複雑さを増すことができます。

Bazel ビルドを改善する

小規模プロジェクトでは単一のターゲットで十分ですが、大規模なプロジェクトを複数のターゲットとパッケージに分割して、増分ビルド（変更されたもののみを再ビルド）を高速化し、プロジェクトの複数の部分を一度にビルドすることでビルドを高速化することもできます。

複数のビルドターゲットを指定する

サンプルプロジェクトのビルドは、2 つのターゲットに分割できます。java-tutorial/BUILD ファイルの内容を次のように置き換えます。

java_binary(
    name = "ProjectRunner",
    srcs = ["src/main/java/com/example/ProjectRunner.java"],
    main_class = "com.example.ProjectRunner",
    deps = [":greeter"],
)

java_library(
    name = "greeter",
    srcs = ["src/main/java/com/example/Greeting.java"],
)

この構成では、Bazel は最初に greeter ライブラリをビルドし、次に ProjectRunner バイナリをビルドします。java_binary の deps 属性は、ProjectRunner バイナリのビルドに greeter ライブラリが必要であることを Bazel に伝えます。

この新しいバージョンのプロジェクトをビルドするには、次のコマンドを実行します。

bazel build //:ProjectRunner

Bazel では、次のような出力が生成されます。

INFO: Found 1 target...
Target //:ProjectRunner up-to-date:
  bazel-bin/ProjectRunner.jar
  bazel-bin/ProjectRunner
INFO: Elapsed time: 2.454s, Critical Path: 1.58s

新しく作成したバイナリをテストします。

bazel-bin/ProjectRunner

ここで ProjectRunner.java を変更してプロジェクトを再ビルドすると、Bazel はそのファイルのみを再コンパイルします。

依存関係グラフを見ると、ProjectRunner が以前と同じ入力に依存していますが、ビルドの構造が異なります。

依存関係を追加した後のターゲット「ProjectRunner」の依存関係グラフ

これで、2 つのターゲットを持つプロジェクトをビルドできました。ProjectRunner ターゲットは 2 つのソースファイルをビルドし、もう 1 つのターゲット（:greeter）に依存します。これは 1 つの追加のソースファイルをビルドします。

複数のパッケージを使用する

プロジェクトを複数のパッケージに分割しましょう。src/main/java/com/example/cmdline ディレクトリを見ると、BUILD ファイルといくつかのソースファイルも含まれていることがわかります。したがって、Bazel では、ワークスペースに //src/main/java/com/example/cmdline と // の 2 つのパッケージが含まれるようになりました（ワークスペースのルートに BUILD ファイルがあるため）。

src/main/java/com/example/cmdline/BUILD ファイルを確認します。

java_binary(
    name = "runner",
    srcs = ["Runner.java"],
    main_class = "com.example.cmdline.Runner",
    deps = ["//:greeter"],
)

runner ターゲットは // パッケージの greeter ターゲットに依存します（したがってターゲットラベル //:greeter になります）。Bazel はこれを deps 属性で認識します。依存関係グラフを見てみましょう。

ターゲット「ランナー」の依存関係グラフ

ただし、ビルドを成功させるには、visibility 属性を使用して、//src/main/java/com/example/cmdline/BUILD の runner ターゲットに //BUILD のターゲットの公開設定を明示的に指定する必要があります。これは、デフォルトでは、ターゲットは同じ BUILD ファイル内の他のターゲットにのみ表示されるためです。（Bazel は、ターゲットの可視性を使用して、実装の詳細を含むライブラリが公開 API に漏洩するなどの問題を防ぎます）。

そのためには、次のように java-tutorial/BUILD の greeter ターゲットに visibility 属性を追加します。

java_library(
    name = "greeter",
    srcs = ["src/main/java/com/example/Greeting.java"],
    visibility = ["//src/main/java/com/example/cmdline:__pkg__"],
)

これで、ワークスペースのルートで次のコマンドを実行して、新しいパッケージをビルドできます。

bazel build //src/main/java/com/example/cmdline:runner

Bazel では、次のような出力が生成されます。

INFO: Found 1 target...
Target //src/main/java/com/example/cmdline:runner up-to-date:
  bazel-bin/src/main/java/com/example/cmdline/runner.jar
  bazel-bin/src/main/java/com/example/cmdline/runner
  INFO: Elapsed time: 1.576s, Critical Path: 0.81s

新しく作成したバイナリをテストします。

./bazel-bin/src/main/java/com/example/cmdline/runner

これで、それぞれ 1 つのターゲットを含む 2 つのパッケージとしてビルドするようにプロジェクトを変更し、それらの間の依存関係を理解できました。

ラベルを使用してターゲットを参照する

BUILD ファイルとコマンドラインでは、Bazel はターゲットラベルを使用してターゲット（//:ProjectRunner や //src/main/java/com/example/cmdline:runner など）を参照します。これらの構文は次のとおりです。

//path/to/package:target-name

ターゲットがルールのターゲットの場合、path/to/package は BUILD ファイルを含むディレクトリへのパス、target-name は BUILD ファイル（name 属性）内でターゲットに指定した名前です。ターゲットがファイルターゲットの場合、path/to/package はパッケージのルートのパス、target-name はターゲットファイルの名前（フルパスを含む）です。

リポジトリのルートでターゲットを参照する場合、パッケージパスは空です。//:target-name を使用するだけです。同じ BUILD ファイル内のターゲットを参照する場合は、// ワークスペースのルート識別子をスキップして、:target-name のみを使用することもできます。

たとえば、java-tutorial/BUILD ファイル内のターゲットの場合、ワークスペースのルート自体がパッケージ（//）であり、2 つのターゲットラベルは単に //:ProjectRunner と //:greeter であるため、パッケージパスを指定する必要はありません。

ただし、//src/main/java/com/example/cmdline/BUILD ファイル内のターゲットの場合、//src/main/java/com/example/cmdline のフルパッケージパスを指定する必要があり、ターゲットラベルは //src/main/java/com/example/cmdline:runner でした。

デプロイ用の Java ターゲットをパッケージ化する

それでは、すべてのランタイム依存関係を含むバイナリをビルドして、デプロイ用の Java ターゲットをパッケージ化しましょう。これにより、開発環境外でバイナリを実行できます。

java_binary ビルドルールは、.jar とラッパーシェルスクリプトを生成します。次のコマンドを使用して、runner.jar の内容を確認します。

jar tf bazel-bin/src/main/java/com/example/cmdline/runner.jar

内容は次のとおりです。

META-INF/
META-INF/MANIFEST.MF
com/
com/example/
com/example/cmdline/
com/example/cmdline/Runner.class

ご覧のとおり、runner.jar には Runner.class が含まれていますが、依存関係の Greeting.class は含まれていません。Bazel が生成する runner スクリプトは、クラスパスに greeter.jar を追加します。そのため、このままにするとローカルでは実行されますが、別のマシンではスタンドアロンで動作しません。幸い、java_binary ルールを使用すると、自己完結型のデプロイ可能なバイナリを作成できます。ビルドするには、ターゲット名に _deploy.jar を追加します。

bazel build //src/main/java/com/example/cmdline:runner_deploy.jar

Bazel では、次のような出力が生成されます。

INFO: Found 1 target...
Target //src/main/java/com/example/cmdline:runner_deploy.jar up-to-date:
  bazel-bin/src/main/java/com/example/cmdline/runner_deploy.jar
INFO: Elapsed time: 1.700s, Critical Path: 0.23s

これで runner_deploy.jar をビルドできました。これには必要なランタイム依存関係が含まれているため、開発環境からスタンドアロンで実行できます。前と同じコマンドを使用して、このスタンドアロン JAR の内容を確認します。

jar tf bazel-bin/src/main/java/com/example/cmdline/runner_deploy.jar

コンテンツには、実行に必要なすべてのクラスが含まれています。

META-INF/
META-INF/MANIFEST.MF
build-data.properties
com/
com/example/
com/example/cmdline/
com/example/cmdline/Runner.class
com/example/Greeting.class

参考資料

詳しくは以下をご覧ください。

rules_jvm_external。一時的な Maven 依存関係を管理するルールに使用します。
外部依存関係。ローカルリポジトリとリモートリポジトリの操作について詳しく説明しています。
Bazel の詳細に関するその他のルール。
C++ ビルドチュートリアル: Bazel を使用して C++ プロジェクトのビルドを開始するための方法を説明します。
Android アプリケーションチュートリアル、iOS アプリケーションチュートリアルなど）で、Bazel を使用した Android および iOS 向けのモバイルアプリの構築を開始してください。

ご利用をお待ちしております。

Bazel チュートリアル: Java プロジェクトをビルドする

学習内容

始める前に

Bazel をインストールする

JDK をインストールする

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

Bazel を使用したビルド

ワークスペースをセットアップする

BUILD ファイルについて

プロジェクトをビルドする

依存関係グラフを確認する

Bazel ビルドを改善する

複数のビルド ターゲットを指定する

複数のパッケージを使用する

ラベルを使用してターゲットを参照する

デプロイ用の Java ターゲットをパッケージ化する

参考資料

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

複数のビルドターゲットを指定する