このページには、Java プロジェクトで Bazel を使用する際に役立つリソースが記載されています。このページには、Bazel を使用して Java プロジェクトをビルドするためのチュートリアル、ビルドルール、その他の情報へのリンクが記載されています。
Bazel の使用
次のリソースは、Java プロジェクトで Bazel を使用する際に役立ちます。
Bazel への移行
現在 Maven で Java プロジェクトをビルドしている場合は、移行ガイドの手順に沿って、Bazel で Maven プロジェクトのビルドを開始します。
Java のバージョン
構成フラグで設定される関連する Java のバージョンは 2 つあります。
- リポジトリ内のソースファイルのバージョン
- コードの実行とテストに使用される Java ランタイムのバージョン
リポジトリ内のソースコードのバージョンを構成する
追加の構成がない場合、Bazel はリポジトリ内のすべての Java ソースファイルが単一の Java バージョンで記述されていると想定します。リポジトリ内のソースのバージョンを指定するには、.bazelrc ファイルに build --java_language_version={ver} を追加します。ここで、{ver} は 11 などです。Bazel リポジトリのオーナーは、Bazel とそのユーザーがソースコードの Java バージョン番号を参照できるように、このフラグを設定する必要があります。詳細については、Java 言語バージョン フラグをご覧ください。
コードの実行とテストに使用する JVM の構成
Bazel は、コンパイルに 1 つの JDK を使用し、コードの実行とテストに別の JVM を使用します。
デフォルトでは、Bazel はダウンロードした JDK を使用してコードをコンパイルし、ローカルマシンにインストールされた JVM でコードを実行してテストします。Bazel は JAVA_HOME またはパスを使用して JVM を検索します。
生成されたバイナリは、システム ライブラリにローカルにインストールされた JVM と互換性があります。つまり、生成されたバイナリはマシンにインストールされているものに依存します。
実行とテストに使用する JVM を構成するには、--java_runtime_version フラグを使用します。デフォルト値は local_jdk です。
密閉型テストとコンパイル
密閉コンパイルを作成するには、コマンドライン フラグ --java_runtime_version=remotejdk_11 を使用します。コードは、リモート リポジトリからダウンロードされた JVM でコンパイル、実行、テストされます。詳細については、Java ランタイム バージョン フラグをご覧ください。
Java でのビルドツールのコンパイルと実行を構成する
ツールをビルドして実行するために使用される JDK と JVM のペアがもう 1 つあります。これはビルドプロセスで使用されますが、ビルド結果には含まれません。この JDK と JVM は、--tool_java_language_version と --tool_java_runtime_version を使用して制御されます。デフォルト値はそれぞれ 11 と remotejdk_11 です。
ローカルにインストールされた JDK を使用してコンパイルする
Bazel は JDK の内部をオーバーライドするため、デフォルトでリモート JDK を使用してコンパイルします。ローカルにインストールされた JDK を使用するコンパイル ツールチェーンは構成されていますが、使用されていません。
ローカルにインストールされた JDK を使用してコンパイルする（ローカル JDK のコンパイル ツールチェーンを使用する）には、追加のフラグ --extra_toolchains=@local_jdk//:all を使用します。ただし、任意のベンダーの JDK では動作しない可能性があります。
詳細については、Java ツールチェーンの構成をご覧ください。
ベスト プラクティス
一般的な Bazel のベスト プラクティスに加えて、Java プロジェクトに固有のベスト プラクティスを以下に示します。
ディレクトリ構造
Maven の標準ディレクトリ レイアウト（ソースは src/main/java、テストは src/test/java）を優先します。
BUILD ファイル
BUILD ファイルを作成する際は、次のガイドラインに従ってください。
ビルドのパフォーマンスを向上させるため、Java ソースを含むディレクトリごとに 1 つの
BUILDファイルを使用します。すべての
BUILDファイルには、次のようなjava_libraryルールが 1 つ含まれている必要があります。java_library( name = "directory-name", srcs = glob(["*.java"]), deps = [...], )ライブラリの名前は、
BUILDファイルを含むディレクトリの名前にする必要があります。これにより、ライブラリのラベルが短くなります（"//package:package"ではなく"//package"を使用します）。ソースは、ディレクトリ内のすべての Java ファイルの非再帰的
globである必要があります。テストは
src/testの下の対応するディレクトリに配置し、このライブラリに依存させる必要があります。
高度な Java ビルドの新しいルールの作成
注: 新しいルールの作成は、高度なビルドとテストのシナリオを対象としています。Bazel の使用を開始する際には必要ありません。
次のモジュール、構成フラグメント、プロバイダは、Java プロジェクトのビルド時に Bazel の機能を拡張するのに役立ちます。
- メインの Java モジュール:
java_common - メインの Java プロバイダ:
JavaInfo - 構成フラグメント:
java その他のモジュール:
Java ツールチェーンを構成する
Bazel は 2 種類の Java ツールチェーンを使用します。
- 実行: Java バイナリの実行とテストに使用され、--java_runtime_version フラグで制御されます。
- コンパイル: Java ソースのコンパイルに使用され、--java_language_version フラグで制御されます。
追加の実行ツールチェーンを構成する
実行ツールチェーンは、ローカルまたはリポジトリの JVM で、バージョン、オペレーティング システム、CPU アーキテクチャに関する追加情報が含まれています。
Java 実行ツールチェーンは、モジュール拡張機能の local_java_repository または remote_java_repository リポジトリ ルールを使用して追加できます。ルールを追加すると、フラグを使用して JVM を使用できるようになります。同じオペレーティング システムと CPU アーキテクチャに対して複数の定義が指定されている場合は、最初の定義が使用されます。
ローカル JVM の構成例:
load("@rules_java//toolchains:local_java_repository.bzl", "local_java_repository")
local_java_repository(
name = "additionaljdk", # Can be used with --java_runtime_version=additionaljdk, --java_runtime_version=11 or --java_runtime_version=additionaljdk_11
version = 11, # Optional, if not set it is autodetected
java_home = "/usr/lib/jdk-15/", # Path to directory containing bin/java
)
リモート JVM の構成例:
load("@rules_java//toolchains:remote_java_repository.bzl", "remote_java_repository")
remote_java_repository(
name = "openjdk_canary_linux_arm",
prefix = "openjdk_canary", # Can be used with --java_runtime_version=openjdk_canary_11
version = "11", # or --java_runtime_version=11
target_compatible_with = [ # Specifies constraints this JVM is compatible with
"@platforms//cpu:arm",
"@platforms//os:linux",
],
urls = ..., # Other parameters are from http_repository rule.
sha256 = ...,
strip_prefix = ...
)
追加のコンパイル ツールチェーンを構成する
コンパイル ツールチェーンは、コンパイル中に Bazel が使用する JDK と複数のツールで構成され、Error Prone、厳密な Java 依存関係、ヘッダー コンパイル、Android の脱糖、カバレッジ計測、IDE の genclass 処理などの追加機能を提供します。
JavaBuilder は、コンパイルを実行し、前述の機能を提供する Bazel バンドル ツールです。実際のコンパイルは、JDK の内部コンパイラを使用して実行されます。コンパイルに使用する JDK は、ツールチェーンの java_runtime 属性で指定します。
Bazel は一部の JDK 内部をオーバーライドします。JDK バージョンが 9 より大きい場合、JDK のフラグ --patch_module を使用して java.compiler モジュールと jdk.compiler モジュールがパッチ適用されます。JDK バージョン 8 の場合、Java コンパイラは -Xbootclasspath フラグを使用してパッチが適用されます。
VanillaJavaBuilder は JavaBuilder の 2 番目の実装で、JDK の内部コンパイラを変更せず、追加機能もありません。VanillaJavaBuilder は、組み込みツールチェーンでは使用されません。
Bazel は、JavaBuilder の他に、コンパイル時にいくつかのツールを使用します。
ijar ツールは jar ファイルを処理して、呼び出しシグネチャ以外のすべてを削除します。生成された jar はヘッダー jar と呼ばれます。これらは、関数の本体が変更された場合にのみ下流の依存関係を再コンパイルすることで、コンパイルの増分性を向上させるために使用されます。
singlejar ツールは、複数の jar ファイルを 1 つにまとめます。
genclass ツールは、Java コンパイルの出力を後処理し、アノテーション プロセッサによって生成されたソースのクラスファイルのみを含む jar を生成します。
JacocoRunner ツールは、計測されたファイルに対して Jacoco を実行し、結果を LCOV 形式で出力します。
TestRunner ツールは、制御された環境で JUnit 4 テストを実行します。
コンパイルを再構成するには、BUILD ファイルに default_java_toolchain マクロを追加し、MODULE.bazel ファイルに register_toolchains ルールを追加するか、--extra_toolchains フラグを使用して登録します。
ツールチェーンは、source_version 属性が --java_language_version フラグで指定された値と一致する場合にのみ使用されます。
ツールチェーンの構成例:
load(
"@rules_java//toolchains:default_java_toolchain.bzl",
"default_java_toolchain", "DEFAULT_TOOLCHAIN_CONFIGURATION", "BASE_JDK9_JVM_OPTS", "DEFAULT_JAVACOPTS"
)
default_java_toolchain(
name = "repository_default_toolchain",
configuration = DEFAULT_TOOLCHAIN_CONFIGURATION, # One of predefined configurations
# Other parameters are from java_toolchain rule:
java_runtime = "@rules_java//toolchains:remote_jdk11", # JDK to use for compilation and toolchain's tools execution
jvm_opts = BASE_JDK9_JVM_OPTS + ["--enable_preview"], # Additional JDK options
javacopts = DEFAULT_JAVACOPTS + ["--enable_preview"], # Additional javac options
source_version = "9",
)
これは、--extra_toolchains=//:repository_default_toolchain_definition を使用するか、ワークスペースに register_toolchains("//:repository_default_toolchain_definition") を追加することで使用できます。
事前定義された構成:
DEFAULT_TOOLCHAIN_CONFIGURATION: すべての機能、JDK バージョン >= 9 をサポートVANILLA_TOOLCHAIN_CONFIGURATION: 追加機能なし。任意のベンダーの JDK をサポートします。PREBUILT_TOOLCHAIN_CONFIGURATION: デフォルトと同じですが、事前構築済みのツール（ijar、singlejar）のみを使用します。NONPREBUILT_TOOLCHAIN_CONFIGURATION: デフォルトと同じですが、すべてのツールがソースからビルドされます（libc が異なるオペレーティング システムで役立つ場合があります）。
JVM と Java コンパイラ フラグを構成する
JVM フラグと javac フラグは、フラグまたは default_java_toolchain 属性で構成できます。
関連するフラグは、--jvmopt、--host_jvmopt、--javacopt、--host_javacopt です。
関連する default_java_toolchain 属性は、javacopts、jvm_opts、javabuilder_jvm_opts、turbine_jvm_opts です。
パッケージ固有の Java コンパイラ フラグ構成
default_java_toolchain の package_configuration 属性を使用して、特定のソースファイルに異なる Java コンパイラ フラグを構成できます。以下の例を参照してください。
load("@rules_java//toolchains:default_java_toolchain.bzl", "default_java_toolchain")
# This is a convenience macro that inherits values from Bazel's default java_toolchain
default_java_toolchain(
name = "toolchain",
package_configuration = [
":error_prone",
],
visibility = ["//visibility:public"],
)
# This associates a set of javac flags with a set of packages
java_package_configuration(
name = "error_prone",
javacopts = [
"-Xep:MissingOverride:ERROR",
],
packages = ["error_prone_packages"],
)
# This is a regular package_group, which is used to specify a set of packages to apply flags to
package_group(
name = "error_prone_packages",
packages = [
"//foo/...",
"-//foo/bar/...", # this is an exclusion
],
)
1 つのリポジトリに複数のバージョンの Java ソースコードがある
Bazel は、ビルドで単一バージョンの Java ソースのコンパイルのみをサポートします。つまり、Java テストまたはアプリケーションをビルドするときに、すべての依存関係が同じ Java バージョンに対してビルドされます。
ただし、別のビルドは異なるフラグを使用して実行される場合があります。
さまざまなフラグを簡単に使用できるように、特定のバージョンのフラグのセットを .bazelrc 構成でグループ化できます。
build:java8 --java_language_version=8
build:java8 --java_runtime_version=local_jdk_8
build:java11 --java_language_version=11
build:java11 --java_runtime_version=remotejdk_11
これらの構成は、--config フラグ（bazel test --config=java11 //:java11_test など）で使用できます。