Java と Bazel

問題を報告するopen_in_new ソースを表示open_in_new

このページには、Java プロジェクトで Bazel を使用する際に役立つリソースが用意されています。Bazel、Java プロジェクトのビルドに固有のチュートリアル、ビルドルール、その他の情報にリンクしています。

Bazel を操作する

Java プロジェクトで Bazel を操作する場合に役立つリソースを以下に示します。

• チュートリアル: Java プロジェクトの構築
• Java のルール

Bazel への移行

現在 Maven を使用して Java プロジェクトをビルドする場合は、移行ガイドの手順に沿って Bazel を使用した Maven プロジェクトのビルドを開始します。

• Maven から Bazel への移行

Java のバージョン

構成フラグが設定された、関連する Java の 2 つのバージョンがあります。

• リポジトリ内のソースファイルのバージョン
• コードの実行とテストに使用される Java ランタイムのバージョン

リポジトリ内のソースコードのバージョンを構成する

追加の構成がない場合、Bazel は、リポジトリ内のすべての Java ソースファイルが単一の Java バージョンで記述されていることを前提としています。リポジトリ内のソースのバージョンを指定するには、build --java_language_version={ver} を .bazelrc ファイルに追加します。ここで、{ver} は 11 です。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 の 2 つ目のペアがあります。これらはビルドプロセスで使用されますが、ビルド結果にはありません。この 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_annotation_processing
  • java_compilation_info
  • java_output
  • java_output_jars
  • JavaRuntimeInfo
  • JavaToolchainInfo

Java ツールチェーンの構成

Bazel は、次の 2 種類の Java ツールチェーンを使用します。- 実行。--java_runtime_version フラグで制御される Java バイナリの実行とテストに使用します。 - コンパイル。Java ソースのコンパイルに使用されます。--java_language_version フラグで制御します。

追加の実行ツールチェーンの構成

実行ツールチェーンは、ローカルまたはリポジトリの JVM で、バージョン、オペレーティング システム、CPU アーキテクチャに関するその他の情報を提供します。

Java 実行ツールチェーンは、WORKSPACE ファイルで 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 = ...
)

追加のコンパイル ツールチェーンの構成

コンパイル ツールチェーンは、Bazel がコンパイル中に使用する JDK と複数のツールで構成されます。これらのツールは、Error Prone、厳格な Java 依存関係、ヘッダー コンパイル、Android 脱糖、カバレッジ計測、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 を実行し、結果を LCOV 形式で出力します。

TestRunner ツールは、制御された環境で JUnit 4 テストを実行します。

default_java_toolchain マクロを BUILD ファイルに追加してコンパイルを登録するには、register_toolchains ルールを WORKSPACE ファイルに追加するか、--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: すべての機能、JDK バージョン 9 以上をサポート
• VANILLA_TOOLCHAIN_CONFIGURATION: 追加機能はありません。任意のベンダーの JDK をサポートします。
• PREBUILT_TOOLCHAIN_CONFIGURATION: デフォルトと同じですが、事前構築済みツール（ijar、singlejar）のみを使用します。
• NONPREBUILT_TOOLCHAIN_CONFIGURATION: デフォルトと同じですが、すべてのツールはソースからビルドされています（これは、別の libc を使用するオペレーティング システムで役立つ場合があります）

JVM と Java のコンパイラ フラグの構成

フラグまたは default_java_toolchain 属性を使用して、JVM と javac のフラグを構成できます。

関連するフラグは --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("@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）で使用できます。