このページには、Java プロジェクトで Bazel を使用する際に役立つリソースが記載されています。これは、 チュートリアル、ビルドルール、ビルドに固有のその他の情報へのリンク Bazel を使用した Java プロジェクト。
Bazel の使用
Java プロジェクトで Bazel を使用する際に役立つリソースは次のとおりです。
Bazel への移行
現在 Maven を使用して Java プロジェクトをビルドしている場合は、移行ガイドの手順に沿って、Bazel を使用して Maven プロジェクトのビルドを開始します。
Java のバージョン
構成フラグで設定される、関連する Java のバージョンは 2 つあります。
- リポジトリ内のソースファイルのバージョン
- コードの実行とテストに使用される Java ランタイムのバージョン
リポジトリ内のソースコードのバージョンを構成する
追加構成がない場合、Bazel は
単一の Java バージョンで記述します。使用するコンテナのバージョンを
リポジトリ内のソースが build --java_language_version={ver} を以下に追加する
.bazelrc ファイル（{ver} は 11 など）。Bazel リポジトリのオーナー
Bazel とそのユーザーがソースコードを参照できるよう、このフラグを
Java のバージョン番号。詳細については、Java 言語バージョン フラグをご覧ください。
コードの実行とテストに使用する JVM を構成する
Bazel は、コンパイルに 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 のペアは、ツールのビルドと実行に使用されます。
使用されますが、ビルド結果には反映されません。この 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 の一般的なベスト プラクティスに加えて、以下があります。 ベスト プラクティスを確認する。
ディレクトリ構造
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"に変更。ソースは、次の再帰的でない
globにする必要があります。 ディレクトリ内のすべての Java ファイルを取得します。テストは
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("@bazel_tools//tools/jdk: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("@bazel_tools//tools/jdk: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 = ...
)
追加のコンパイル ツールチェーンの構成
コンパイル ツールチェーンは、JDK と、Bazel が使用する複数のツールで構成されます。 次のような追加機能が提供されます: Error 傾向がある、厳格な Java 依存関係、ヘッダー コンパイル、Android の desugar、 IDE 用の genclass 処理があります
JavaBuilder は、コンパイルを実行する Bazel にバンドルされたツールで、
説明しました実際のコンパイルは、JDK の内部コンパイラを使用して実行されます。コンパイルに使用される JDK は、ツールチェーンの java_runtime 属性で指定します。
Bazel は、一部の JDK 内部をオーバーライドします。JDK バージョンの場合 >9、
java.compiler モジュールと jdk.compiler モジュールには、JDK のフラグを使用してパッチが適用されます。
--patch_module。JDK バージョン 8 の場合、Java コンパイラにパッチを適用するには、
-Xbootclasspath フラグ。
VanillaJavaBuilder は、JavaBuilder の 2 つ目の実装です。 JDK の内部コンパイラを変更せず、 追加機能。VanillaJavaBuilder は、 統合できます。
Bazel は、JavaBuilder 以外にもコンパイル時に複数のツールを使用します。
ijar ツールは jar ファイルを処理して、次の呼び出し以外のすべてを削除します。
できます。生成される JAR はヘッダー JAR と呼ばれます。これらは、関数の本体が変更された場合にのみダウンストリームの依存関係を再コンパイルすることで、コンパイルの増分性を向上させるために使用されます。
singlejar ツールは、複数の jar ファイルを 1 つにまとめます。
genclass ツールは、Java コンパイルの出力を後処理し、アノテーション プロセッサによって生成されたソースのクラスファイルのみを含む jar を生成します。
JacocoRunner ツールは、インストゥルメント化されたファイルに対して Jacoco を実行し、結果を出力
。
TestRunner ツールは、制御された環境で JUnit 4 テストを実行します。
コンパイルを再構成するには、BUILD ファイルに default_java_toolchain マクロを追加し、MODULE.bazel ファイルに register_toolchains ルールを追加するか、--extra_toolchains フラグを使用して登録します。
ツールチェーンは、source_version 属性が --java_language_version フラグで指定された値と一致する場合にのみ使用されます。
ツールチェーン構成の例:
load(
"@bazel_tools//tools/jdk: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 = "@bazel_tools//tools/jdk: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: すべての機能、9 以上の JDK バージョンをサポート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 コンパイラ フラグの構成
特定のソースごとに異なる Java コンパイラ フラグを構成できる
default_java_toolchain の package_configuration 属性を使用しているファイル。
以下の例を参照してください。
load("@bazel_tools//tools/jdk: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 など）で使用できます。