Java ルール

問題を報告 ソースを表示

ルール

java_binary

ルールのソースを表示 
java_binary(name, deps, srcs, data, resources, args, classpath_resources, compatible_with, create_executable, deploy_env, deploy_manifest_lines, deprecation, distribs, env, exec_compatible_with, exec_properties, features, javacopts, jvm_flags, launcher, licenses, main_class, output_licenses, plugins, resource_jars, resource_strip_prefix, restricted_to, runtime_deps, stamp, tags, target_compatible_with, testonly, toolchains, use_launcher, use_testrunner, visibility)

Java アーカイブ（「jar ファイル」）と、ルールと同じ名前のラッパー シェル スクリプトをビルドします。ラッパーシェル スクリプトは、バイナリが依存する各ライブラリの jar ファイルなどを含むクラスパスを使用します。ラッパーシェル スクリプトを実行する場合、空でない JAVABIN 環境変数は、Bazel の --java_runtime_version フラグで指定されたバージョンよりも優先されます。

ラッパー スクリプトは、いくつかの一意のフラグを受け入れます。ラッパーで使用できる構成可能なフラグと環境変数のリストについては、//src/main/java/com/google/devtools/build/lib/bazel/rules/java/java_stub_template.txt をご覧ください。

暗黙的な出力ターゲット

  • name.jar: バイナリの直接依存関係に対応するクラスファイルとその他のリソースを含む Java アーカイブ。
  • name-src.jar: ソースを含むアーカイブ（「source jar」）。
  • name_deploy.jar: デプロイに適した Java アーカイブ（明示的にリクエストされた場合にのみビルドされます）。

    ルールの <name>_deploy.jar ターゲットをビルドすると、java -jar コマンドまたはラッパー スクリプトの --singlejar オプションを使用して実行できるマニフェストを含む自己完結型の jar ファイルが作成されます。JVM フラグとネイティブ ライブラリを読み込むオプションも渡すため、java -jar よりもラッパー スクリプトを使用することをおすすめします。

    deploy jar には、バイナリのラッパー スクリプトのクラスパスを最初から最後まで検索するクラスローダーによって検出されるすべてのクラスが含まれています。また、依存関係に必要なネイティブ ライブラリも含まれています。これらは実行時に JVM に自動的に読み込まれます。

    ターゲットで launcher 属性が指定されている場合、_deploy.jar は通常の JAR ファイルではなくネイティブ バイナリになります。これには、ランチャーとルールのネイティブ（C++）依存関係が含まれ、すべて静的バイナリにリンクされます。実際の jar ファイルのバイトがネイティブ バイナリに追加され、実行可能ファイルと Java コードの両方を含む単一のバイナリ blob が作成されます。結果の jar ファイルは、ネイティブ バイナリを実行する場合と同様に直接実行できます。

  • name_deploy-src.jar: ターゲットの推移的クロージャから収集されたソースを含むアーカイブ。jar に一致するソース jar がない場合を除き、deploy.jar 内のクラスと一致します。

srcs のない java_binary ルールで deps 属性を使用することはできません。このようなルールには、runtime_deps によって提供される main_class が必要です。

よくあるミスを次のコード スニペットに示します。

java_binary(
    name = "DontDoThis",
    srcs = [
        ...,
        "GeneratedJavaFile.java",  # a generated .java file
    ],
    deps = [":generating_rule"],  # rule that generates that file
)

代わりに次のように操作します。

java_binary(
    name = "DoThisInstead",
    srcs = [
        ...,
        ":generating_rule",
    ],
)

引数

属性
name

名前（必須）

このターゲットの一意の名前。


アプリのメインのエントリ ポイントであるソースファイルの名前（拡張子を除く）を使用することをおすすめします。たとえば、エントリ ポイントが Main.java の場合、名前は Main のようになります。
deps

ラベルのリスト。デフォルトは [] です。

ターゲットにリンクする他のライブラリのリスト。deps に関する一般的なコメントについては、ほとんどのビルドルールで定義された一般的な属性をご覧ください。
srcs

ラベルのリスト。デフォルトは [] です。

ターゲットを作成するために処理されるソースファイルのリスト。この属性はほとんどの場合必須です。下記の例外をご覧ください。

.java タイプのソースファイルはコンパイルされます。生成される .java ファイルの場合、ファイル自体の名前ではなく、生成ルールの名前をここに入力することをおすすめします。これにより、読みやすさが向上するだけでなく、将来の変更に対するルールの復元性も向上します。今後、生成ルールで異なるファイルが生成される場合でも、1 つの場所（生成ルールの outs）を修正するだけで済みます。これは NoOps であるため、生成ルールは deps にリストしないでください。

.srcjar タイプのソースファイルは、解凍され、コンパイルされます。（これは、genrule を使用して一連の .java ファイルを生成する必要がある場合に便利です）。

ルール: ルール（通常は genrule または filegroup）が上記のファイルのいずれかを生成した場合、ソースファイルの場合と同じ方法が使用されます。

この引数は、main_class 属性によってランタイム クラスパスのクラスが指定されている場合、または runtime_deps 引数が指定されている場合を除いて、ほぼ必ず必要です。
resources

ラベルのリスト。デフォルトは [] です。

Java jar に含めるデータファイルのリスト。

リソースを指定すると、コンパイルによって生成された通常の .class ファイルとともに jar にバンドルされます。jar ファイル内のリソースの場所は、プロジェクト構造によって決まります。Bazel は、最初に Maven の標準ディレクトリ レイアウトを検索します（「src」ディレクトリの後に「resources」ディレクトリの孫が続きます）。見つからない場合、Bazel は「java」または「javatests」という名前の最上位ディレクトリを探します（たとえば、リソースが <workspace root>/x/java/y/java/z にある場合、リソースのパスは y/java/z になります）。このヒューリスティックはオーバーライドできませんが、resource_strip_prefix 属性を使用すると、リソース ファイル用の特定の代替ディレクトリを指定できます。

リソースは、ソースファイルまたは生成されたファイルです。
classpath_resources

ラベルのリスト。デフォルトは [] です。

他に方法がない場合を除き、このオプションは使用しないでください）

Java ツリーのルートに配置する必要があるリソースのリスト。この属性は、リソースが "myconfig.xml" としてクラスパス上にあることを必要とするサードパーティ ライブラリをサポートすることのみを目的としています。名前空間が競合する恐れがあるため、バイナリでのみ許可され、ライブラリでは許可されません。
create_executable

ブール値、構成不可、デフォルトは True

非推奨。代わりに java_single_jar を使用してください。
deploy_env

ラベルのリスト。デフォルトは [] です。

このバイナリのデプロイ環境を表す他の java_binary ターゲットのリスト。別の java_binary によって読み込まれるプラグインをビルドするときにこの属性を設定します。
この属性を設定すると、このバイナリと deploy_env で指定されたターゲットの間で共有される、このバイナリのランタイム クラスパス（および deploy jar）から、すべての依存関係が除外されます。
deploy_manifest_lines

文字列のリスト。デフォルトは [] です。

*_deploy.jar ターゲット用に生成された META-INF/manifest.mf ファイルに追加する行のリスト。この属性の内容は "Make variable" 置換の対象になりません。
javacopts

文字列のリスト。デフォルトは [] です。

このライブラリの追加のコンパイラ オプション。 "Make variable" 置換と Bourne shell トークン化が適用されます。

これらのコンパイラ オプションは、グローバル コンパイラ オプションの後に javac に渡されます。
jvm_flags

文字列のリスト。デフォルトは [] です。

このバイナリを実行するために生成されたラッパー スクリプトに埋め込むフラグのリスト。$(location) と "Make variable" の置換、Bourne シェルのトークン化が適用されます。

Java バイナリのラッパー スクリプトには、CLASSPATH 定義（依存する jar をすべて検出）が含まれ、適切な Java インタープリタを呼び出します。ラッパー スクリプトによって生成されたコマンドラインには、メインクラスの名前の後に "$@" が続くため、クラス名の後に他の引数を渡すことができます。ただし、JVM で解析する引数は、コマンドラインでクラス名の前に指定する必要があります。jvm_flags の内容は、クラス名が一覧表示される前にラッパー スクリプトに追加されます。

この属性は *_deploy.jar 出力には作用しません。
launcher

ラベル（デフォルトは None）

JDK に含まれる通常の bin/java プログラムではなく、Java プログラムの実行に使用するバイナリを指定します。ターゲットは cc_binary にする必要があります。 Java Invocation API を実装するすべての cc_binary を、この属性の値として指定できます。

デフォルトでは、Bazel は通常の JDK ランチャー（bin/java または java.exe）を使用します。

関連する --java_launcher Bazel フラグは、launcher 属性が指定されていない java_binary ターゲットと java_test ターゲットにのみ影響します。

ネイティブ（C++、SWIG、JNI）依存関係は、JDK ランチャーと別のランチャーのどちらを使用するかによって、ビルド方法が異なります。

  • 通常の JDK ランチャー（デフォルト）を使用している場合は、ネイティブ依存関係は {name}_nativedeps.so という名前の共有ライブラリとしてビルドされます。ここで、{name} はこの java_binary ルールの name 属性です。この設定では、使用されていないコードがリンカーによって削除されることはありません。
  • 他のランチャーを使用している場合、ネイティブ（C++）依存関係は、{name}_nativedeps という名前のバイナリに静的にリンクされます。ここで、{name} はこの java_binary ルールの name 属性です。この場合、リンカーは、使用されていないと思われるコードを結果のバイナリから削除します。つまり、JNI 経由でのみアクセスされる C++ コードは、cc_library ターゲットが alwayslink = 1 を指定していない限り、リンクできません。

デフォルトの JDK ランチャー以外のランチャーを使用すると、*_deploy.jar 出力の形式が変更されます。詳細については、java_binary のメインのドキュメントをご覧ください。
main_class

文字列。デフォルトは ""

エントリ ポイントとして使用する main() メソッドを持つクラスの名前。ルールでこのオプションを使用する場合、srcs=[...] リストは必要ありません。したがって、この属性を使用することで、すでに 1 つ以上の main() メソッドが含まれている Java ライブラリから実行ファイルを作成できます。

この属性の値は、ソースファイルではなくクラス名です。このクラスは、実行時に使用できる必要があります。このルールによってコンパイルされる場合（srcs から）、または直接的または推移的依存関係によって（runtime_deps または deps を介して）提供される場合があります。クラスを利用できない場合、バイナリは実行時に失敗し、ビルド時のチェックは行われません。

plugins

ラベルのリスト。デフォルトは [] です。

コンパイル時に実行する Java コンパイラ プラグイン。 このルールがビルドされるたびに、この属性で指定されたすべての java_plugin が実行されます。ライブラリは、exported_plugins を使用する依存関係からプラグインを継承することもできます。プラグインによって生成されたリソースは、このルールで生成される jar に含まれます。
resource_jars

ラベルのリスト。デフォルトは [] です。

非推奨: 代わりに java_import と deps または runtime_deps を使用してください。
resource_strip_prefix

文字列。デフォルトは ""

Java リソースから削除するパスの接頭辞。

指定すると、このパス接頭辞は resources 属性内のすべてのファイルから削除されます。リソース ファイルがこのディレクトリにないとエラーになります。指定しない場合（デフォルト）、リソース ファイルのパスは、ソースファイルの Java パッケージと同じロジックに従って決定されます。たとえば、stuff/java/foo/bar/a.txt にあるソースファイルは foo/bar/a.txt にあります。
runtime_deps

ラベルのリスト。デフォルトは [] です。

最終バイナリまたは実行時にのみテストできるようにするライブラリ。これらは通常の deps と同様に、ランタイム クラスパスにありますが、コンパイル時クラスパスにはありません。実行時にのみ必要な依存関係をここにリストします。依存関係分析ツールは、runtime_deps と deps の両方に存在するターゲットを無視する必要があります。
stamp

整数。デフォルトは -1

ビルド情報をバイナリにエンコードするかどうか。有効な値は次のとおりです。
  • stamp = 1: --nostamp ビルドであっても、ビルド情報を常にバイナリにスタンプします。この設定は、バイナリのリモート キャッシュや、それに依存するダウンストリーム アクションを強制終了する可能性があるため、避ける必要があります。
  • stamp = 0: ビルド情報を常に定数値に置き換えます。これにより、ビルド結果のキャッシュ保存が良好になります。
  • stamp = -1: ビルド情報の埋め込みは、--[no]stamp フラグで制御されます。

スタンプされたバイナリは、依存関係が変更されない限り、再ビルドされません。
use_launcher

ブール値。デフォルトは True です。

バイナリでカスタム ランチャーを使用するかどうか。

この属性を false に設定した場合、launcher 属性と関連する --java_launcher フラグはこのターゲットでは無視されます。

use_testrunner

ブール値。デフォルトは False です。

テストランナー（デフォルトでは com.google.testing.junit.runner.BazelTestRunner）クラスを Java プログラムのメイン エントリ ポイントとして使用し、テストクラスを bazel.test_suite システム プロパティの値としてテストランナーに提供します。 これを使用して、java_test ルールにはテストランナーを使用し、java_binary ルールには使用しないというデフォルトの動作をオーバーライドできます。そのようなことは、ほとんど必要ありません。1 つの用途として、別のルールによって呼び出される AllTest ルールがあります（テストを実行する前にデータベースを設定する場合など）。AllTest ルールは java_binary として宣言する必要がありますが、テストランナーをメインのエントリ ポイントとして使用する必要があります。 テストランナー クラスの名前は、main_class 属性でオーバーライドできます。

java_import

ルールのソースを表示 
java_import(name, deps, data, add_exports, add_opens, compatible_with, constraints, deprecation, distribs, exec_compatible_with, exec_properties, exports, features, jars, licenses, neverlink, proguard_specs, restricted_to, runtime_deps, srcjar, tags, target_compatible_with, testonly, toolchains, visibility)

このルールでは、プリコンパイルされた .jar ファイルを java_library ルールと java_binary ルールのライブラリとして使用できます。

例


    java_import(
        name = "maven_model",
        jars = [
            "maven_model/maven-aether-provider-3.2.3.jar",
            "maven_model/maven-model-3.2.3.jar",
            "maven_model/maven-model-builder-3.2.3.jar",
        ],
    )

引数

属性
name

名前（必須）

このターゲットの一意の名前。
deps

ラベルのリスト。デフォルトは [] です。

ターゲットにリンクする他のライブラリのリスト。java_library.deps をご覧ください。
data

ラベルのリスト。デフォルトは [] です。

実行時にこのルールに必要なファイルのリスト。
add_exports

文字列のリスト。デフォルトは [] です。

このライブラリに、指定された module または package へのアクセスを許可します。

これは、javac および JVM の --add-exports= フラグに対応します。
add_opens

文字列のリスト。デフォルトは [] です。

このライブラリが、指定された module または package をリフレクティブにアクセスできるようにします。

これは、javac および JVM の --add-opens= フラグに対応します。
constraints

文字列のリスト。デフォルトは [] です。

Java ライブラリとしてこのルールに適用される追加の制約。
exports

ラベルのリスト。デフォルトは [] です。

このルールのユーザーが利用できるようにするターゲット。java_library.exports をご覧ください。
jars

ラベルのリスト（必須）

このターゲットに依存する Java ターゲットに提供される JAR ファイルのリスト。

ブール値。デフォルトは False です。

このライブラリはコンパイルにのみ使用し、実行時は使用しないでください。実行時にランタイム環境からライブラリが提供される場合に便利です。このようなライブラリの例としては、IDE プラグイン用の IDE API や、標準 JDK で実行されるものであれば tools.jar などがあります。
proguard_specs

ラベルのリスト。デフォルトは [] です。

Proguard 仕様として使用するファイル。ここには、ProGuard が使用する仕様のセットが記述されます。指定すると、このライブラリに応じて、すべての android_binary ターゲットに追加されます。 ここに含まれるファイルには、べき等のルール（-dontnote、-dontwarn、assumenosideeffects、-keep で始まるルール）のみが必要です。他のオプションは、非相互論理的結合を確実にするために、android_binary の proguard_specs にのみ指定できます。
runtime_deps

ラベルのリスト。デフォルトは [] です。

最終バイナリまたは実行時にのみテストできるようにするライブラリ。java_library.runtime_deps をご覧ください。
srcjar

ラベル（デフォルトは None）

コンパイルされた JAR ファイルのソースコードを含む JAR ファイル。

java_library

ルールのソースを表示 
java_library(name, deps, srcs, data, resources, add_exports, add_opens, bootclasspath, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, exported_plugins, exports, features, javabuilder_jvm_flags, javacopts, licenses, neverlink, plugins, proguard_specs, resource_strip_prefix, restricted_to, runtime_deps, tags, target_compatible_with, testonly, toolchains, visibility)

このルールは、ソースをコンパイルして .jar ファイルにリンクします。

暗黙的な出力

  • libname.jar: クラスファイルを含む Java アーカイブ。
  • libname-src.jar: ソースを含むアーカイブ（「source jar」）。

引数

属性
name

名前（必須）

このターゲットの一意の名前。
deps

ラベルのリスト。デフォルトは [] です。

このライブラリにリンクするライブラリのリスト。deps に関する一般的なコメントについては、ほとんどのビルドルールで定義されている一般的な属性をご覧ください。

deps にリストされている java_library ルールによってビルドされた jar は、このルールのコンパイル時クラスパスにあります。さらに、deps、runtime_deps、exports の推移的クロージャはランタイム クラスパスにあります。

一方、data 属性のターゲットは実行ファイルに含まれますが、コンパイル時クラスパスにもランタイム クラスパスにも含まれません。

srcs

ラベルのリスト。デフォルトは [] です。

ターゲットを作成するために処理されるソースファイルのリスト。この属性はほとんどの場合必須です。下記の例外をご覧ください。

.java タイプのソースファイルはコンパイルされます。生成された .java ファイルの場合、ファイル自体の名前ではなく、生成ルールの名前をここに入力することをおすすめします。これにより、読みやすさが向上するだけでなく、将来の変更に対するルールの耐障害性も向上します。今後、生成ルールで異なるファイルが生成される場合でも、1 つの場所（生成ルールの outs）を修正するだけで済みます。これは NoOps であるため、生成ルールは deps にリストしないでください。

.srcjar タイプのソースファイルは、解凍され、コンパイルされます。（これは、genrule を使用して一連の .java ファイルを生成する必要がある場合に便利です）。

ルール: ルール（通常は genrule または filegroup）によって上記のファイルが生成される場合、これらのファイルはソースファイルの場合と同じように使用されます。

.properties タイプのソースファイルはリソースとして扱われます。

上記で説明したファイル形式のファイルが 1 つ以上ある限り、他のすべてのファイルは無視されます。それ以外の場合は、エラーが発生します。

runtime_deps 引数を指定する場合を除き、この引数はほぼ必ず必要です。
data

ラベルのリスト。デフォルトは [] です。

このライブラリが実行時に必要とするファイルのリスト。 data に関する一般的なコメントについては、ほとんどのビルドルールで定義されている一般的な属性をご覧ください。

java_library をビルドする際、Bazel はこれらのファイルをどこにも配置しません。data ファイルが生成された場合は、Bazel がこれらのファイルを生成します。この java_library に依存するテストをビルドする場合、Bazel は data ファイルを runfiles 領域にコピーまたはリンクします。

resources

ラベルのリスト。デフォルトは [] です。

Java jar に含めるデータファイルのリスト。

リソースは、ソースファイルまたは生成されたファイルです。

リソースを指定すると、コンパイルによって生成された通常の .class ファイルとともに jar にバンドルされます。jar ファイル内のリソースの場所は、プロジェクト構造によって決まります。Bazel は、最初に Maven の標準ディレクトリ レイアウトを検索します（「src」ディレクトリの後に「resources」ディレクトリの孫が続きます）。見つからない場合、Bazel は「java」または「javatests」という名前の最上位ディレクトリを探します（たとえば、リソースが <workspace root>/x/java/y/java/z にある場合、リソースのパスは y/java/z になります）。このヒューリスティックはオーバーライドできませんが、resource_strip_prefix 属性を使用すると、リソース ファイル用の特定の代替ディレクトリを指定できます。
add_exports

文字列のリスト。デフォルトは [] です。

このライブラリに、指定された module または package へのアクセスを許可します。

これは、javac および JVM の --add-exports= フラグに対応します。
add_opens

文字列のリスト。デフォルトは [] です。

このライブラリが、指定された module または package をリフレクティブにアクセスできるようにします。

これは、javac および JVM の --add-opens= フラグに対応します。
bootclasspath

ラベル（デフォルトは None）

制限付き API は使用しないでください。
exported_plugins

ラベルのリスト。デフォルトは [] です。

このライブラリに直接依存するライブラリにエクスポートする java_plugin（アノテーション プロセッサなど）のリスト。

指定された java_plugin のリストは、ライブラリが plugins でこれらのラベルを明示的に宣言しているかのように、このライブラリに直接依存するすべてのライブラリに適用されます。

exports

ラベルのリスト。デフォルトは [] です。

エクスポートされたライブラリ。

ここにルールを一覧表示すると、親がこれらのルールに明示的に依存しているかのように、親ルールから使用できるようになります。これは、通常の（エクスポートされていない）deps には当てはまりません。

概要: ルール X は、deps エッジで始まり、その後に 0 個以上の exports エッジが続く依存関係パスが存在する場合、Y 内のコードにアクセスできます。例をいくつか見てみましょう。

たとえば、A が B に依存し、B が C に依存しているとします。この場合、C は A の推移的な依存関係であるため、C のソースを変更して A を再構築すると、すべてが正しく再構築されます。ただし、A は C のクラスを使用できません。これを可能にするには、A が deps で C を宣言しなければならないか、または B が（B）の exports 属性で C を宣言することで、A（および A に依存するもの）を簡単に行えるようにします。

エクスポートされたライブラリを閉じることは、すべての直接の親ルールで使用できます。少し異なる例を考えてみましょう。A は B に依存し、B は C と D に依存し、C もエクスポートしますが D はエクスポートしません。これで、A は C にアクセスできますが、D にはアクセスできません。C と D がそれぞれいくつかのライブラリ C' と D' をエクスポートすると、A は C' にのみアクセスでき、D' にはアクセスできません。

重要: エクスポートされたルールは通常の依存関係ではありません。前の例で言うと、B が C をエクスポートし、C も使用する場合は、B も自身の deps でリストする必要があります。
javabuilder_jvm_flags

文字列のリスト。デフォルトは [] です。

制限付き API は使用しないでください。
javacopts

文字列のリスト。デフォルトは [] です。

このライブラリの追加のコンパイラ オプション。 "Make variable" 置換と Bourne シェルトークン化が適用されます。

これらのコンパイラ オプションは、グローバル コンパイラ オプションの後に javac に渡されます。

ブール値。デフォルトは False です。

このライブラリを実行時にではなくコンパイルにのみ使用するかどうかを指定します。実行時にランタイム環境からライブラリが提供される場合に便利です。このようなライブラリの例として、IDE プラグイン用の IDE API や、標準 JDK で実行されるものであれば、tools.jar があります。

neverlink = 1 は、このライブラリのマテリアルを、Java 言語仕様（String またはプリミティブ型の static final 定数）。したがって、ランタイム ライブラリがコンパイル ライブラリと同一である場合が推奨されます。

ランタイム ライブラリがコンパイル ライブラリと異なる場合は、JLS でコンパイラのインライン化が禁止されている場所（そして JLS の今後のすべてのバージョンで保持する必要がある）のみが異なることを確認する必要があります。
plugins

ラベルのリスト。デフォルトは [] です。

コンパイル時に実行する Java コンパイラ プラグイン。 このルールがビルドされるたびに、この属性で指定されたすべての java_plugin が実行されます。ライブラリは、exported_plugins を使用する依存関係からプラグインを継承することもできます。プラグインによって生成されたリソースは、このルールで生成される jar に含まれます。
proguard_specs

ラベルのリスト。デフォルトは [] です。

Proguard 仕様として使用するファイル。ここには、ProGuard が使用する仕様のセットが記述されます。指定すると、このライブラリに応じて、すべての android_binary ターゲットに追加されます。 ここに含まれるファイルには、べき等のルール（-dontnote、-dontwarn、assumenosideeffects、-keep で始まるルール）のみが必要です。他のオプションは、非相互論理的結合を確実にするために、android_binary の proguard_specs にのみ指定できます。
resource_strip_prefix

文字列。デフォルトは ""

Java リソースから削除するパスの接頭辞。

指定すると、このパス接頭辞は resources 属性内のすべてのファイルから削除されます。リソース ファイルがこのディレクトリにないとエラーになります。指定しない場合（デフォルト）、リソース ファイルのパスは、ソースファイルの Java パッケージと同じロジックに従って決定されます。たとえば、stuff/java/foo/bar/a.txt にあるソースファイルは foo/bar/a.txt にあります。
runtime_deps

ラベルのリスト。デフォルトは [] です。

最終バイナリまたは実行時にのみテストできるようにするライブラリ。これらは通常の deps と同様に、ランタイム クラスパスにありますが、コンパイル時クラスパスにはありません。実行時にのみ必要な依存関係をここに記載します。依存関係分析ツールは、runtime_deps と deps の両方に存在するターゲットを無視する必要があります。

java_lite_proto_library

ルールのソースを表示 
java_lite_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_lite_proto_library は、.proto ファイルから Java コードを生成します。

deps は proto_library ルールを指す必要があります。

例: 


java_library(
    name = "lib",
    runtime_deps = [":foo"],
)

java_lite_proto_library(
    name = "foo",
    deps = [":bar"],
)

proto_library(
    name = "bar",
)

引数

属性
name

名前（必須）

このターゲットの一意の名前。
deps

ラベルのリスト。デフォルトは [] です。

Java コードを生成する proto_library ルールのリスト。

java_proto_library

ルールのソースを表示 
java_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_proto_library は、.proto ファイルから Java コードを生成します。

deps は proto_library ルールを指す必要があります。

例: 


java_library(
    name = "lib",
    runtime_deps = [":foo_java_proto"],
)

java_proto_library(
    name = "foo_java_proto",
    deps = [":foo_proto"],
)

proto_library(
    name = "foo_proto",
)

引数

属性
name

名前（必須）

このターゲットの一意の名前。
deps

ラベルのリスト。デフォルトは [] です。

Java コードを生成する proto_library ルールのリスト。

java_test

ルールのソースを表示 
java_test(name, deps, srcs, data, resources, add_exports, add_opens, args, bootclasspath, classpath_resources, compatible_with, create_executable, deploy_manifest_lines, deprecation, distribs, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, javacopts, jvm_flags, launcher, licenses, local, main_class, neverlink, plugins, resource_strip_prefix, restricted_to, runtime_deps, shard_count, size, stamp, tags, target_compatible_with, test_class, testonly, timeout, toolchains, use_launcher, use_testrunner, visibility)

java_test() ルールは Java テストをコンパイルします。テストは、テストコードのバイナリ ラッパーです。コンパイルされるメインクラスではなく、テストランナーのメインメソッドが呼び出されます。

暗黙的な出力ターゲット

  • name.jar: Java アーカイブ。
  • name_deploy.jar: デプロイに適した Java アーカイブ。（明示的にリクエストされた場合にのみビルドされます）。詳細については、java_binary の name_deploy.jar 出力の説明をご覧ください。

java_binary() 引数に関するセクションをご覧ください。このルールは、すべてのテストルールに共通する属性（*_test）もすべてサポートします。

例



java_library(
    name = "tests",
    srcs = glob(["*.java"]),
    deps = [
        "//java/com/foo/base:testResources",
        "//java/com/foo/testing/util",
    ],
)

java_test(
    name = "AllTests",
    size = "small",
    runtime_deps = [
        ":tests",
        "//util/mysql",
    ],
)

引数

属性
name

名前（必須）

このターゲットの一意の名前。
deps

ラベルのリスト。デフォルトは [] です。

ターゲットにリンクする他のライブラリのリスト。deps に関する一般的なコメントについては、ほとんどのビルドルールで定義されている一般的な属性をご覧ください。
srcs

ラベルのリスト。デフォルトは [] です。

ターゲットを作成するために処理されるソースファイルのリスト。この属性はほとんどの場合必須です。下記の例外をご覧ください。

.java タイプのソースファイルはコンパイルされます。生成された .java ファイルの場合、ファイル自体の名前ではなく、生成ルールの名前をここに入力することをおすすめします。これにより、読みやすさが向上するだけでなく、将来の変更に対するルールの耐障害性も向上します。今後、生成ルールで異なるファイルが生成される場合でも、1 つの場所（生成ルールの outs）を修正するだけで済みます。これは NoOps であるため、生成ルールは deps にリストしないでください。

.srcjar タイプのソースファイルは、解凍され、コンパイルされます。（これは、genrule を使用して一連の .java ファイルを生成する必要がある場合に便利です）。

ルール: ルール（通常は genrule または filegroup）によって上記のファイルが生成される場合、これらのファイルはソースファイルの場合と同じように使用されます。

この引数は、main_class 属性でランタイム クラスパスのクラスを指定する場合、または runtime_deps 引数を指定する場合を除き、ほぼ必ず必要です。
data

ラベルのリスト。デフォルトは [] です。

このライブラリが実行時に必要とするファイルのリスト。 data に関する一般的なコメントについては、ほとんどのビルドルールで定義されている一般的な属性をご覧ください。
resources

ラベルのリスト。デフォルトは [] です。

Java jar に含めるデータファイルのリスト。

リソースは、ソースファイルまたは生成されたファイルです。

リソースを指定すると、コンパイルによって生成された通常の .class ファイルとともに jar にバンドルされます。jar ファイル内のリソースの場所は、プロジェクト構造によって決まります。Bazel は、最初に Maven の標準ディレクトリ レイアウトを検索します（「src」ディレクトリの後に「resources」ディレクトリの孫が続きます）。見つからない場合、Bazel は「java」または「javatests」という名前の最上位ディレクトリを探します（たとえば、リソースが <workspace root>/x/java/y/java/z にある場合、リソースのパスは y/java/z になります）。このヒューリスティックはオーバーライドできませんが、resource_strip_prefix 属性を使用すると、リソース ファイル用の特定の代替ディレクトリを指定できます。
add_exports

文字列のリスト。デフォルトは [] です。

このライブラリに、指定された module または package へのアクセスを許可します。

これは、javac および JVM の --add-exports= フラグに対応します。
add_opens

文字列のリスト。デフォルトは [] です。

このライブラリが、指定された module または package をリフレクティブにアクセスできるようにします。

これは、javac および JVM の --add-opens= フラグに対応します。
bootclasspath

ラベル（デフォルトは None）

制限付き API は使用しないでください。
classpath_resources

ラベルのリスト。デフォルトは [] です。

他に方法がない場合を除き、このオプションは使用しないでください）

Java ツリーのルートに配置する必要があるリソースのリスト。この属性は、リソースが "myconfig.xml" としてクラスパス上にあることを必要とするサードパーティ ライブラリをサポートすることのみを目的としています。名前空間が競合する恐れがあるため、バイナリに対してのみ許可され、ライブラリに対しては許可されません。
create_executable

ブール値。デフォルトは True です。

非推奨。代わりに java_single_jar を使用してください。
deploy_manifest_lines

文字列のリスト。デフォルトは [] です。

*_deploy.jar ターゲット用に生成された META-INF/manifest.mf ファイルに追加する行のリスト。この属性の内容は「Make variable」置換の対象になりません。
javacopts

文字列のリスト。デフォルトは [] です。

このバイナリの追加のコンパイラ オプション。 "Make variable" 置換と Bourne シェルトークン化が適用されます。

これらのコンパイラ オプションは、グローバル コンパイラ オプションの後に javac に渡されます。
jvm_flags

文字列のリスト。デフォルトは [] です。

このバイナリを実行するために生成されたラッパー スクリプトに埋め込むフラグのリスト。$(location) と "Make variable" の置換、Bourne シェルのトークン化が適用されます。

Java バイナリのラッパー スクリプトには、CLASSPATH 定義（依存する jar をすべて検出）が含まれ、適切な Java インタープリタを呼び出します。ラッパー スクリプトによって生成されたコマンドラインには、メインクラスの名前の後に "$@" が続くため、クラス名の後に他の引数を渡すことができます。ただし、JVM で解析する引数は、コマンドラインでクラス名の前に指定する必要があります。jvm_flags の内容は、クラス名が一覧表示される前にラッパー スクリプトに追加されます。

この属性は *_deploy.jar 出力には影響しません。
launcher

ラベル（デフォルトは None）

JDK に含まれる通常の bin/java プログラムではなく、Java プログラムの実行に使用するバイナリを指定します。ターゲットは cc_binary にする必要があります。 Java Invocation API を実装するすべての cc_binary を、この属性の値として指定できます。

デフォルトでは、Bazel は通常の JDK ランチャー（bin/java または java.exe）を使用します。

関連する --java_launcher Bazel フラグは、launcher 属性が指定されていない java_binary ターゲットと java_test ターゲットにのみ影響します。

ネイティブ（C++、SWIG、JNI）依存関係は、JDK ランチャーと別のランチャーのどちらを使用するかによってビルド方法が異なります。

  • 通常の JDK ランチャー（デフォルト）を使用している場合は、ネイティブ依存関係は {name}_nativedeps.so という名前の共有ライブラリとしてビルドされます。ここで、{name} はこの java_binary ルールの name 属性です。この設定では、使用されていないコードがリンカーによって削除されることはありません。
  • 他のランチャーを使用している場合、ネイティブ（C++）依存関係は {name}_nativedeps という名前のバイナリに静的にリンクされます。ここで、{name} はこの java_binary ルールの name 属性です。この場合、リンカーは、使用されていないと思われるコードを結果のバイナリから削除します。つまり、JNI 経由でのみアクセスされる C++ コードは、cc_library ターゲットが alwayslink = 1 を指定していない限り、リンクできません。

デフォルトの JDK ランチャー以外のランチャーを使用すると、*_deploy.jar 出力の形式が変更されます。詳細については、java_binary のメインのドキュメントをご覧ください。
main_class

文字列。デフォルトは ""

エントリ ポイントとして使用する main() メソッドを持つクラスの名前。ルールでこのオプションを使用する場合、srcs=[...] リストは必要ありません。したがって、この属性を使用することで、すでに 1 つ以上の main() メソッドが含まれている Java ライブラリから実行ファイルを作成できます。

この属性の値は、ソースファイルではなくクラス名です。このクラスはランタイム時に使用できる必要があります。このルールによってコンパイルされる場合（srcs から）、または直接的または推移的依存関係によって（runtime_deps または deps を介して）提供される場合があります。クラスを利用できない場合、バイナリは実行時に失敗します。ビルド時のチェックは行われません。

ブール値。デフォルトは False です。
plugins

ラベルのリスト。デフォルトは [] です。

コンパイル時に実行する Java コンパイラ プラグイン。 このルールがビルドされるたびに、この属性で指定されたすべての java_plugin が実行されます。ライブラリは、exported_plugins を使用する依存関係からプラグインを継承することもできます。プラグインによって生成されたリソースは、このルールで生成される jar に含まれます。
resource_strip_prefix

文字列。デフォルトは ""

Java リソースから削除するパスの接頭辞。

指定すると、このパス接頭辞は resources 属性内のすべてのファイルから削除されます。リソース ファイルがこのディレクトリにないとエラーになります。指定しない場合（デフォルト）、リソース ファイルのパスは、ソースファイルの Java パッケージと同じロジックに従って決定されます。たとえば、stuff/java/foo/bar/a.txt にあるソースファイルは foo/bar/a.txt にあります。
runtime_deps

ラベルのリスト。デフォルトは [] です。

最終バイナリまたは実行時にのみテストできるようにするライブラリ。これらは通常の deps と同様に、ランタイム クラスパスにありますが、コンパイル時クラスパスにはありません。実行時にのみ必要な依存関係をここに記載します。依存関係分析ツールは、runtime_deps と deps の両方に存在するターゲットを無視する必要があります。
stamp

整数。デフォルトは 0

ビルド情報をバイナリにエンコードするかどうか。有効な値は次のとおりです。
  • stamp = 1: --nostamp ビルドであっても、ビルド情報を常にバイナリにスタンプします。この設定は、バイナリのリモート キャッシュや、それに依存するダウンストリーム アクションを強制終了する可能性があるため、避ける必要があります。
  • stamp = 0: ビルド情報を常に定数値に置き換えます。これにより、ビルド結果のキャッシュ保存が良好になります。
  • stamp = -1: ビルド情報の埋め込みは、--[no]stamp フラグで制御されます。

スタンプされたバイナリは、依存関係が変更されない限り、再ビルドされません。
test_class

文字列。デフォルトは ""

テストランナーによって読み込まれる Java クラス。

デフォルトでは、この引数が定義されていない場合は以前のモードが使用され、代わりにテスト引数が使用されます。最初の引数でフォールバックしないように --nolegacy_bazel_java_test フラグを設定します。

この属性では、このテストで実行する Java クラスの名前を指定します。これを設定する必要はほとんどありません。この引数を省略すると、ターゲットの name とそのソースルート相対パスを使用して推測されます。テストが既知のソースルートの外に配置されている場合、test_class が設定されていない場合、Bazel はエラーを報告します。

JUnit3 の場合、テストクラスは junit.framework.TestCase のサブクラスであるか、junit.framework.Test（または Test のサブクラス）を返すパブリック静的 suite() メソッドを持つ必要があります。JUnit4 の場合、クラスに org.junit.runner.RunWith アノテーションを付ける必要があります。

この属性を使用すると、複数の java_test ルールで同じ Test（TestCase、TestSuite など）を共有できます。通常、追加情報が（jvm_flags=['-Dkey=value'] などを介して）渡されるため、テストの異なるサブセットを実行するなど、それぞれの動作が異なるためです。この属性により、javatests ツリーの外部で Java テストを使用することもできます。
use_launcher

ブール値。デフォルトは True です。

バイナリでカスタム ランチャーを使用するかどうか。

この属性を false に設定した場合、launcher 属性と関連する --java_launcher フラグはこのターゲットで無視されます。
use_testrunner

ブール値。デフォルトは True です。

テストランナー（デフォルトでは com.google.testing.junit.runner.BazelTestRunner）クラスを Java プログラムのメイン エントリ ポイントとして使用し、テストクラスを bazel.test_suite システム プロパティの値としてテストランナーに提供します。
これを使用すると、java_test ルールにはテストランナーを使用し、java_binary ルールには使用しないというデフォルトの動作をオーバーライドできます。そのようなことは、ほとんど必要ありません。用途の 1 つとして、別のルールによって呼び出される AllTest ルールがあります（テストを実行する前にデータベースを設定する場合など）。AllTest ルールは java_binary として宣言する必要がありますが、テストランナーをメインのエントリ ポイントとして使用する必要があります。テストランナー クラスの名前は、main_class 属性でオーバーライドできます。

java_package_configuration

ルールのソースを表示 
java_package_configuration(name, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, javacopts, output_licenses, packages, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

パッケージのセットに適用する構成。 構成は java_toolchain.javacopts に追加できます。

例:



java_package_configuration(
    name = "my_configuration",
    packages = [":my_packages"],
    javacopts = ["-Werror"],
)

package_group(
    name = "my_packages",
    packages = [
        "//com/my/project/...",
        "-//com/my/project/testing/...",
    ],
)

java_toolchain(
    ...,
    package_configuration = [
        ":my_configuration",
    ]
)

引数

属性
name

名前（必須）

このターゲットの一意の名前。
data

ラベルのリスト。デフォルトは [] です。

ランタイムにこの構成が必要とするファイルのリスト。
javacopts

文字列のリスト。デフォルトは [] です。

Java コンパイラ フラグ。
output_licenses

文字列のリスト。デフォルトは [] です。
packages

ラベルのリスト。デフォルトは [] です。

構成を適用する package_group のセット。

java_plugin

ルールのソースを表示 
java_plugin(name, deps, srcs, data, resources, add_exports, add_opens, bootclasspath, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, generates_api, javabuilder_jvm_flags, javacopts, licenses, neverlink, output_licenses, plugins, processor_class, proguard_specs, resource_strip_prefix, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_plugin は、Bazel によって実行される Java コンパイラのプラグインを定義します。現時点でサポートされているプラグインの種類は、アノテーション プロセッサのみです。java_library ルールまたは java_binary ルールは、plugins 属性を介してプラグインに依存することで、プラグインを実行できます。java_library では、exported_plugins を使用して、プラグインに直接依存しているライブラリにプラグインを自動的にエクスポートすることもできます。

暗黙的な出力ターゲット

  • libname.jar: Java アーカイブ。

引数は、processor_class 引数を追加することを除き、java_library と同じです。

引数

属性
name

名前（必須）

このターゲットの一意の名前。
deps

ラベルのリスト。デフォルトは [] です。

このライブラリにリンクするライブラリのリスト。deps に関する一般的なコメントについては、ほとんどのビルドルールで定義されている一般的な属性をご覧ください。

deps にリストされている java_library ルールによってビルドされた jar は、このルールのコンパイル時クラスパスにあります。さらに、deps、runtime_deps、exports の推移的クロージャはランタイム クラスパスにあります。

一方、data 属性のターゲットは実行ファイルに含まれますが、コンパイル時クラスパスにもランタイム クラスパスにも含まれません。

srcs

ラベルのリスト。デフォルトは [] です。

ターゲットを作成するために処理されるソースファイルのリスト。この属性はほとんどの場合必須です。下記の例外をご覧ください。

.java タイプのソースファイルはコンパイルされます。生成された .java ファイルの場合、ファイル自体の名前ではなく、生成ルールの名前をここに入力することをおすすめします。これにより、読みやすさが向上するだけでなく、将来の変更に対するルールの耐障害性も向上します。今後、生成ルールで異なるファイルが生成される場合でも、1 つの場所（生成ルールの outs）を修正するだけで済みます。これは NoOps であるため、生成ルールは deps にリストしないでください。

.srcjar タイプのソースファイルは、解凍され、コンパイルされます。（これは、genrule を使用して一連の .java ファイルを生成する必要がある場合に便利です）。

ルール: ルール（通常は genrule または filegroup）によって上記のファイルが生成される場合、これらのファイルはソースファイルの場合と同じように使用されます。

.properties タイプのソースファイルはリソースとして扱われます。

上記で説明したファイル形式のファイルが 1 つ以上ある限り、他のすべてのファイルは無視されます。それ以外の場合は、エラーが発生します。

runtime_deps 引数を指定する場合を除き、この引数はほぼ必ず必要です。
data

ラベルのリスト。デフォルトは [] です。

このライブラリが実行時に必要とするファイルのリスト。 data に関する一般的なコメントについては、ほとんどのビルドルールで定義されている一般的な属性をご覧ください。

java_library をビルドする際、Bazel はこれらのファイルをどこにも配置しません。data ファイルが生成された場合は、Bazel がこれらのファイルを生成します。この java_library に依存するテストをビルドする場合、Bazel は data ファイルを runfiles 領域にコピーまたはリンクします。

resources

ラベルのリスト。デフォルトは [] です。

Java jar に含めるデータファイルのリスト。

リソースは、ソースファイルまたは生成されたファイルです。

リソースを指定すると、コンパイルによって生成された通常の .class ファイルとともに jar にバンドルされます。jar ファイル内のリソースの場所は、プロジェクト構造によって決まります。Bazel は、最初に Maven の標準ディレクトリ レイアウトを検索します（「src」ディレクトリの後に「resources」ディレクトリの孫が続きます）。見つからない場合、Bazel は「java」または「javatests」という名前の最上位ディレクトリを探します（たとえば、リソースが <workspace root>/x/java/y/java/z にある場合、リソースのパスは y/java/z になります）。このヒューリスティックはオーバーライドできませんが、resource_strip_prefix 属性を使用すると、リソース ファイル用の特定の代替ディレクトリを指定できます。
add_exports

文字列のリスト。デフォルトは [] です。

このライブラリに、指定された module または package へのアクセスを許可します。

これは、javac および JVM の --add-exports= フラグに対応します。
add_opens

文字列のリスト。デフォルトは [] です。

このライブラリが、指定された module または package をリフレクティブにアクセスできるようにします。

これは、javac および JVM の --add-opens= フラグに対応します。
bootclasspath

ラベル（デフォルトは None）

制限付き API は使用しないでください。
generates_api

ブール値。デフォルトは False です。

この属性は、API コードを生成するアノテーション プロセッサをマークします。

ルールで API 生成のアノテーション プロセッサを使用する場合、コンパイル アクションが生成ルールの後にスケジュールされている場合にのみ、そのルールに依存する他のルールは生成されたコードを参照できます。この属性は、--java_header_compilation が有効になっている場合に、スケジューリングの制約を導入するように Bazel に指示します。

警告: この属性はビルドのパフォーマンスに影響を与えます。必要な場合にのみ使用してください。
javabuilder_jvm_flags

文字列のリスト。デフォルトは [] です。

制限付き API は使用しないでください。
javacopts

文字列のリスト。デフォルトは [] です。

このライブラリの追加のコンパイラ オプション。 "Make variable" 置換と Bourne シェルトークン化が適用されます。

これらのコンパイラ オプションは、グローバル コンパイラ オプションの後に javac に渡されます。

ブール値。デフォルトは False です。

このライブラリを実行時にではなくコンパイルにのみ使用するかどうかを指定します。実行時にランタイム環境からライブラリが提供される場合に便利です。このようなライブラリの例として、IDE プラグイン用の IDE API や、標準 JDK で実行されるものであれば、tools.jar があります。

neverlink = 1 は、このライブラリのマテリアルを、Java 言語仕様（String またはプリミティブ型の static final 定数）。したがって、ランタイム ライブラリがコンパイル ライブラリと同一である場合が推奨されます。

ランタイム ライブラリがコンパイル ライブラリと異なる場合は、JLS でコンパイラのインライン化が禁止されている場所（そして JLS の今後のすべてのバージョンで保持する必要がある）のみが異なることを確認する必要があります。
output_licenses

文字列のリスト。デフォルトは [] です。
plugins

ラベルのリスト。デフォルトは [] です。

コンパイル時に実行する Java コンパイラ プラグイン。 このルールがビルドされるたびに、この属性で指定されたすべての java_plugin が実行されます。ライブラリは、exported_plugins を使用する依存関係からプラグインを継承することもできます。プラグインによって生成されたリソースは、このルールで生成される jar に含まれます。
processor_class

文字列。デフォルトは ""

プロセッサ クラスは、Java コンパイラがアノテーション プロセッサへのエントリ ポイントとして使用するクラスの完全修飾型です。指定しない場合、このルールは Java コンパイラのアノテーション処理にアノテーション プロセッサを提供しませんが、そのランタイム クラスパスはコンパイラのアノテーション プロセッサのパスに引き続き含まれます。（これは主に、 java.util.ServiceLoader を使用してアノテーション プロセッサのパスから読み込まれる Error Prone プラグインでの使用を目的としています）。
proguard_specs

ラベルのリスト。デフォルトは [] です。

Proguard 仕様として使用するファイル。ここには、ProGuard が使用する仕様のセットが記述されます。指定すると、このライブラリに応じて、すべての android_binary ターゲットに追加されます。 ここに含まれるファイルには、べき等のルール（-dontnote、-dontwarn、assumenosideeffects、-keep で始まるルール）のみが必要です。他のオプションは、非相互論理的結合を確実にするために、android_binary の proguard_specs にのみ指定できます。
resource_strip_prefix

文字列。デフォルトは ""

Java リソースから削除するパスの接頭辞。

指定すると、このパス接頭辞は resources 属性内のすべてのファイルから削除されます。リソース ファイルがこのディレクトリにないとエラーになります。指定しない場合（デフォルト）、リソース ファイルのパスは、ソースファイルの Java パッケージと同じロジックに従って決定されます。たとえば、stuff/java/foo/bar/a.txt にあるソースファイルは foo/bar/a.txt にあります。

java_runtime

ルールのソースを表示 
java_runtime(name, srcs, compatible_with, default_cds, deprecation, distribs, exec_compatible_with, exec_properties, features, hermetic_srcs, hermetic_static_libs, java, java_home, lib_ct_sym, lib_modules, output_licenses, restricted_to, tags, target_compatible_with, testonly, toolchains, version, visibility)

Java ランタイムの構成を指定します。

例:



java_runtime(
    name = "jdk-9-ea+153",
    srcs = glob(["jdk9-ea+153/**"]),
    java_home = "jdk9-ea+153",
)

引数

属性
name

名前（必須）

このターゲットの一意の名前。
srcs

ラベルのリスト。デフォルトは [] です。

ランタイム内のすべてのファイル。
default_cds

ラベル（デフォルトは None）

密閉型の java_runtime のデフォルトの CDS アーカイブ。java_binary ターゲットで密閉型が有効で、ターゲットが classlist 属性を指定して独自の CDS アーカイブを提供していない場合、java_runtime のデフォルト CDS は密閉型のデプロイ JAR にパッケージ化されます。
hermetic_srcs

ラベルのリスト。デフォルトは [] です。

密閉型のデプロイに必要なランタイム内のファイル。
hermetic_static_libs

ラベルのリスト。デフォルトは [] です。

密閉型デプロイ用のランチャーに静的にリンクされているライブラリ
java

ラベル（デフォルトは None）

Java 実行可能ファイルのパス。
java_home

文字列。デフォルトは ""

ランタイムのルートへのパス。「Make」変数を置換できます。このパスが絶対パスの場合、ルールは既知のパスを持つ非密閉型の Java ランタイムを示します。その場合、srcs 属性と java 属性は空にする必要があります。
lib_ct_sym

ラベル（デフォルトは None）

--release を使用したコンパイルに必要な lib/ct.sym ファイル。指定せず、パスが /lib/ct.sym で終わるファイルが srcs に 1 つだけある場合は、そのファイルが使用されます。
lib_modules

ラベル（デフォルトは None）

密閉型のデプロイに必要な lib/modules ファイル。
output_licenses

文字列のリスト。デフォルトは [] です。
version

整数。デフォルトは 0

Java ランタイムの機能バージョン。すなわち、Runtime.version().feature() によって返される整数です。

java_toolchain

ルールのソースを表示 
java_toolchain(name, android_lint_data, android_lint_jvm_opts, android_lint_opts, android_lint_package_configuration, android_lint_runner, bootclasspath, compatible_javacopts, compatible_with, deprecation, deps_checker, distribs, exec_compatible_with, exec_properties, features, forcibly_disable_header_compilation, genclass, header_compiler, header_compiler_builtin_processors, header_compiler_direct, ijar, jacocorunner, java_runtime, javabuilder, javabuilder_data, javabuilder_jvm_opts, javac_supports_multiplex_workers, javac_supports_worker_cancellation, javac_supports_worker_multiplex_sandboxing, javac_supports_workers, javacopts, jspecify_implicit_deps, jspecify_javacopts, jspecify_packages, jspecify_processor, jspecify_processor_class, jspecify_stubs, jvm_opts, licenses, misc, oneversion, oneversion_allowlist_for_tests, oneversion_whitelist, package_configuration, proguard_allowlister, reduced_classpath_incompatible_processors, restricted_to, singlejar, source_version, tags, target_compatible_with, target_version, testonly, timezone_data, toolchains, tools, turbine_data, turbine_jvm_opts, visibility, xlint)

Java コンパイラの構成を指定します。使用するツールチェーンは --java_ツールチェーン 引数で変更できます。通常は、Java コンパイラを調整する場合を除き、この種のルールを作成しないでください。

例

簡単な例を次に示します。 



java_toolchain(
    name = "toolchain",
    source_version = "7",
    target_version = "7",
    bootclasspath = ["//tools/jdk:bootclasspath"],
    xlint = [ "classfile", "divzero", "empty", "options", "path" ],
    javacopts = [ "-g" ],
    javabuilder = ":JavaBuilder_deploy.jar",
)

引数

属性
name

名前（必須）

このターゲットの一意の名前。
android_lint_data

ラベルのリスト。デフォルトは [] です。

android_lint_jvm_opts でラベル拡張に使用できるツールのラベル。
android_lint_jvm_opts

文字列のリスト。デフォルトは [] です。

Android Lint を呼び出すときの JVM の引数のリスト。
android_lint_opts

文字列のリスト。デフォルトは [] です。

Android lint の引数のリスト。
android_lint_package_configuration

ラベルのリスト。デフォルトは [] です。

指定したパッケージ グループに適用する Android lint 設定。
android_lint_runner

ラベル（デフォルトは None）

Android lint ランナーのラベル（存在する場合）。
bootclasspath

ラベルのリスト。デフォルトは [] です。

Java ターゲットの bootclasspath エントリ。javac の -bootclasspath フラグに対応します。
compatible_javacopts

null; default is {}

内部 API。使用しないでください。
deps_checker

ラベル（デフォルトは None）

ImportDepsChecker デプロイ jar のラベル。
forcibly_disable_header_compilation

ブール値。デフォルトは False です。

--java_header_compile をオーバーライドして、サポートしていないプラットフォーム（JDK 7 Bazel など）でのヘッダー コンパイルを無効にします。
genclass

ラベル（デフォルトは None）

GenClass デプロイ jar のラベル。
header_compiler

ラベル（デフォルトは None）

ヘッダー コンパイラのラベル。--java_header_compile が有効な場合は必須。
header_compiler_builtin_processors

文字列のリスト。デフォルトは [] です。

内部 API。使用しないでください。
header_compiler_direct

ラベル（デフォルトは None）

API 生成のアノテーション プロセッサを含まない直接クラスパス アクションに使用するヘッダー コンパイラのオプションのラベル。

このツールはアノテーション処理をサポートしていません。
ijar

ラベル（デフォルトは None）

ijar 実行可能ファイルのラベル。
jacocorunner

ラベル（デフォルトは None）

JacocoCoverageRunner デプロイ jar のラベル。
java_runtime

ラベル（デフォルトは None）

このツールチェーンで使用する java_runtime。実行構成のデフォルト値は java_runtime です。
javabuilder

ラベル（デフォルトは None）

JavaBuilder デプロイ jar のラベル。
javabuilder_data

ラベルのリスト。デフォルトは [] です。

javabuilder_jvm_opts でラベル拡張に使用できるデータのラベル。
javabuilder_jvm_opts

文字列のリスト。デフォルトは [] です。

JavaBuilder を呼び出すときの JVM の引数のリスト。
javac_supports_multiplex_workers

ブール値。デフォルトは True です。

JavaBuilder が多重化永続ワーカーとしての実行をサポートしている場合は true、サポートしていない場合は false です。
javac_supports_worker_cancellation

ブール値。デフォルトは True です。

JavaBuilder が永続ワーカーのキャンセルをサポートしている場合は true、サポートしていない場合は false です。
javac_supports_worker_multiplex_sandboxing

ブール値。デフォルトは False です。

JavaBuilder がサンドボックスによる Multiplex 永続ワーカーとしての実行をサポートしている場合は true、サポートしていない場合は false に設定します。
javac_supports_workers

ブール値。デフォルトは True です。

JavaBuilder が永続ワーカーとしての実行をサポートしている場合は true、サポートしていない場合は false です。
javacopts

文字列のリスト。デフォルトは [] です。

Java コンパイラの追加の引数のリスト。使用可能な Java コンパイラ フラグの詳細なリストについては、Java コンパイラのドキュメントをご覧ください。
jspecify_implicit_deps

ラベル（デフォルトは None）

試験運用版のため、使用しないでください。
jspecify_javacopts

文字列のリスト。デフォルトは [] です。

試験運用版のため、使用しないでください。
jspecify_packages

ラベルのリスト。デフォルトは [] です。

試験運用版のため、使用しないでください。
jspecify_processor

ラベル（デフォルトは None）

試験運用版のため、使用しないでください。
jspecify_processor_class

文字列。デフォルトは ""

試験運用版のため、使用しないでください。
jspecify_stubs

ラベルのリスト。デフォルトは [] です。

試験運用版のため、使用しないでください。
jvm_opts

文字列のリスト。デフォルトは [] です。

Java コンパイラを呼び出すときの JVM の引数のリスト。このオプションで使用できるフラグの詳細なリストについては、Java 仮想マシンのドキュメントをご覧ください。
misc

文字列のリスト。デフォルトは [] です。

非推奨: 代わりに javacopts を使用してください
oneversion

ラベル（デフォルトは None）

1 つのバージョン適用バイナリのラベル。
oneversion_allowlist_for_tests

ラベル（デフォルトは None）

テスト用に 1 つのバージョンの許可リストのラベル。
oneversion_whitelist

ラベル（デフォルトは None）

1 バージョンの許可リストのラベル。
package_configuration

ラベルのリスト。デフォルトは [] です。

指定したパッケージ グループに適用する構成。
proguard_allowlister

ラベル（デフォルトは "@bazel_tools//tools/jdk:proguard_whitelister"）

Proguard 許可リストに登録されているユーザーのラベル。
reduced_classpath_incompatible_processors

文字列のリスト。デフォルトは [] です。

内部 API。使用しないでください。
singlejar

ラベル（デフォルトは None）

SingleJar デプロイ jar のラベル。
source_version

文字列。デフォルトは ""

Java ソース バージョン（「6」、「7」）。Java ソースコードで許可される コード構造のセットを指定します
target_version

文字列。デフォルトは ""

Java ターゲット バージョン（「6」、「7」）。クラスをビルドする Java ランタイムを指定します。
timezone_data

ラベル（デフォルトは None）

タイムゾーン データを含むリソース JAR のラベル。設定すると、タイムゾーン データが、すべての java_binary ルールの暗黙的なランタイム依存関係として追加されます。
tools

ラベルのリスト。デフォルトは [] です。

jvm_opts でラベル拡張に使用できるツールのラベル。
turbine_data

ラベルのリスト。デフォルトは [] です。

turbine_jvm_opts でラベル拡張に使用できるデータのラベル。
turbine_jvm_opts

文字列のリスト。デフォルトは [] です。

タービン呼び出し時の JVM の引数のリスト。
xlint

文字列のリスト。デフォルトは [] です。

デフォルト リストに対して追加または削除する警告のリスト。先頭にダッシュを付けて削除します。詳細については、-Xlint オプションに関する Javac のドキュメントをご覧ください。