Java ルール

問題を報告 ソースを表示 ナイトリー · 8.2 · 8.1 · 8.0 · 7.6 · 7.5

ルール

java_binary

ルールソースを表示 
java_binary(name, deps, srcs, data, resources, add_exports, add_opens, args, bootclasspath, classpath_resources, compatible_with, create_executable, deploy_env, deploy_manifest_lines, deprecation, env, exec_compatible_with, exec_group_compatible_with, exec_properties, features, javacopts, jvm_flags, launcher, licenses, main_class, neverlink, output_licenses, package_metadata, plugins, 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 フラグで指定されたバージョンよりも優先されます。

ラッパー スクリプトは、いくつかの独自のフラグを受け入れます。ラッパーで受け入れられる構成可能なフラグと環境変数のリストについては、java_stub_template.txt をご覧ください。

暗黙的な出力ターゲット

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

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

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

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

  • name_deploy-src.jar: ターゲットの推移閉包から収集されたソースを含むアーカイブ。これらのクラスは、jar に一致するソース jar がない限り、deploy.jar のクラスと一致します。

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

deps 属性は、srcs のない java_binary ルールでは使用できません。このようなルールには、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

名前: 必須

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

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

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

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

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

.java タイプのソースファイルがコンパイルされます。生成された .java ファイルの場合は、通常、ファイル自体の名前ではなく、生成ルールの名前をここに配置することをおすすめします。これにより、読みやすさが向上するだけでなく、将来の変更に対するルールの耐障害性が向上します。生成ルールが将来的に異なるファイルを生成する場合は、生成ルールの outs という 1 か所を修正するだけで済みます。生成ルールは no-op であるため、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_env

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

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

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

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

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

このバイナリ用の追加のコンパイラ オプション。「変数を作成」の置換と Bourne シェルのトークン化の対象となります。

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

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

このバイナリの実行用に生成されたラッパー スクリプトに埋め込むフラグのリスト。$(location) と 「変数を作成」の置換、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 属性です。この場合、リンクエラーは、使用されていないと思われるコードを結果バイナリから削除します。つまり、cc_library ターゲットで alwayslink = True が指定されていない限り、JNI 経由でのみアクセスされる C++ コードはリンクされない可能性があります。

デフォルトの 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

整数。デフォルトは -1 です。

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

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

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

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

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

use_testrunner

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

Java プログラムのメインのエントリ ポイントとしてテストランナー（デフォルトでは com.google.testing.junit.runner.BazelTestRunner）クラスを使用し、テストクラスを bazel.test_suite システム プロパティの値としてテストランナーに提供します。
これを使用して、デフォルトの動作をオーバーライドできます。デフォルトの動作では、java_test ルールにはテストランナーを使用し、java_binary ルールには使用しません。通常は、この方法はおすすめしません。たとえば、テストの実行前にデータベースをセットアップするために、別のルールによって呼び出される AllTest ルールに使用できます。AllTest ルールは java_binary として宣言する必要がありますが、メインのエントリ ポイントとしてテストランナーを使用する必要があります。テストランナー クラスの名前は、main_class 属性でオーバーライドできます。

java_import

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

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

例


    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, exec_compatible_with, exec_group_compatible_with, exec_properties, exported_plugins, exports, features, javabuilder_jvm_flags, javacopts, licenses, neverlink, package_metadata, plugins, proguard_specs, resource_strip_prefix, restricted_to, runtime_deps, tags, target_compatible_with, testonly, toolchains, visibility)

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

暗黙的な出力

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

引数

属性
name

名前: 必須

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

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

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

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

対照的に、data 属性のターゲットは、コンパイル時クラスパスと実行時クラスパスのどちらにも含まれず、ランファイルに含まれます。
srcs

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

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

.java タイプのソースファイルがコンパイルされます。生成された .java ファイルの場合は、通常、ファイル自体の名前ではなく、生成ルールの名前をここに配置することをおすすめします。これにより、読みやすさが向上するだけでなく、将来の変更に対するルールの耐障害性が向上します。生成ルールが将来的に異なるファイルを生成する場合は、生成ルールの outs という 1 か所を修正するだけで済みます。生成ルールは no-op であるため、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 にも C をリストする必要があります。
javabuilder_jvm_flags

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

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

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

このライブラリの追加のコンパイラ オプション。「変数を作成」の置換と Bourne シェルのトークン化の対象となります。

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

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

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

neverlink = True は、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_test

ルールソースを表示 
java_test(name, deps, srcs, data, resources, add_exports, add_opens, args, bootclasspath, classpath_resources, compatible_with, create_executable, deploy_manifest_lines, deprecation, env, env_inherit, exec_compatible_with, exec_group_compatible_with, exec_properties, features, flaky, javacopts, jvm_flags, launcher, licenses, local, main_class, neverlink, package_metadata, 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 ファイルの場合は、通常、ファイル自体の名前ではなく、生成ルールの名前をここに配置することをおすすめします。これにより、読みやすさが向上するだけでなく、将来の変更に対するルールの耐障害性が向上します。生成ルールが将来的に異なるファイルを生成する場合は、生成ルールの outs という 1 か所を修正するだけで済みます。生成ルールは no-op であるため、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 ファイルに追加する行のリスト。この属性の内容は、「変数を作成」置換の対象になりません。
javacopts

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

このバイナリ用の追加のコンパイラ オプション。「変数を作成」の置換と Bourne シェルのトークン化の対象となります。

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

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

このバイナリの実行用に生成されたラッパー スクリプトに埋め込むフラグのリスト。$(location) と 「変数を作成」の置換、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 属性です。この場合、リンクエラーは、使用されていないと思われるコードを結果バイナリから削除します。つまり、cc_library ターゲットで alwayslink = True が指定されていない限り、JNI 経由でのみアクセスされる C++ コードはリンクされない可能性があります。

デフォルトの 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 です。

Java プログラムのメインのエントリ ポイントとしてテストランナー（デフォルトでは com.google.testing.junit.runner.BazelTestRunner）クラスを使用し、テストクラスを bazel.test_suite システム プロパティの値としてテストランナーに提供します。
これを使用して、デフォルトの動作をオーバーライドできます。デフォルトの動作では、java_test ルールにはテストランナーを使用し、java_binary ルールには使用しません。通常は、この方法はおすすめしません。たとえば、テストの実行前にデータベースをセットアップするために、別のルールによって呼び出される AllTest ルールに使用できます。AllTest ルールは java_binary として宣言する必要がありますが、メインのエントリ ポイントとしてテストランナーを使用する必要があります。テストランナー クラスの名前は、main_class 属性でオーバーライドできます。

java_package_configuration

ルールソースを表示 
java_package_configuration(name, data, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, javacopts, output_licenses, package_metadata, packages, restricted_to, system, 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 のセット。
system

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

javac の --system フラグに対応します。

java_plugin

ルールソースを表示 
java_plugin(name, deps, srcs, data, resources, add_exports, add_opens, bootclasspath, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, generates_api, javabuilder_jvm_flags, javacopts, licenses, neverlink, output_licenses, package_metadata, 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 ファイルの場合は、通常、ファイル自体の名前ではなく、生成ルールの名前をここに配置することをおすすめします。これにより、読みやすさが向上するだけでなく、将来の変更に対するルールの耐障害性が向上します。生成ルールが将来的に異なるファイルを生成する場合は、生成ルールの outs という 1 か所を修正するだけで済みます。生成ルールは no-op であるため、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

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

このライブラリの追加のコンパイラ オプション。「変数を作成」の置換と Bourne シェルのトークン化の対象となります。

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

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

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

neverlink = True は、Java 言語仕様で許可されているように、コンパイラがこのライブラリのマテリアルを、それに依存するコンパイル ターゲットにインライン化することを妨げるものではありません（String またはプリミティブ型の static final 定数）。したがって、ランタイム ライブラリがコンパイル ライブラリと同一である場合に、この方法を使用することをおすすめします。

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

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

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

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

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

プロセッサ クラスは、Java コンパイラがアノテーション プロセッサへのエントリ ポイントとして使用するクラスの完全修飾型です。指定しない場合、このルールは Java コンパイラのアノテーション処理にアノテーション プロセッサを追加しませんが、そのランタイム クラスパスはコンパイラのアノテーション プロセッサ パスに引き続き含まれます。（これは主に、 java.util.ServiceLoader を使用してアノテーション プロセッサ パスから読み込まれるエラーが発生しやすいプラグインで使用することを目的としています）。
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, exec_compatible_with, exec_group_compatible_with, exec_properties, features, hermetic_srcs, hermetic_static_libs, java, java_home, lib_ct_sym, lib_modules, output_licenses, package_metadata, 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 ターゲットでハーメティックが有効になっている場合、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 ファイル。指定されていない場合、srcs にパスが /lib/ct.sym で終わるファイルが 1 つだけある場合は、そのファイルが使用されます。
lib_modules

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

完全なデプロイに必要な lib/modules ファイル。
output_licenses

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

整数。デフォルトは 0 です。

Java ランタイムの機能バージョン。つまり、Runtime.version().feature() から返される整数です。

java_single_jar

ルールソースを表示 
java_single_jar(name, deps, compatible_with, compress, deploy_env, deploy_manifest_lines, deprecation, exclude_build_data, exec_compatible_with, exec_group_compatible_with, exec_properties, features, multi_release, package_metadata, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)
 Java の依存関係と JAR ファイルを 1 つの JAR に収集します `java_single_jar` は、Java の依存関係と JAR ファイルを 1 つの JAR に収集します。これは、実行可能ファイルに関連するすべての機能が無効になっている java_binary に似ており、java_binary の「deploy jar hack」の代替手段となります。## 例 ```skylark load("//tools/build_defs/java_single_jar:java_single_jar.bzl", "java_single_jar") java_single_jar( name = "my_single_jar", deps = [ "//java/com/google/foo", "//java/com/google/bar", ], ) ``` 出力: {name}.jar: すべての入力を含む単一の jar。

引数

属性
name

名前: 必須

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

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

参照依存関係を収集する Java ターゲット（java_import や java_library など）。ランタイム依存関係は、deps、exports、runtime_deps を介して収集されます。リソースも収集されます。ネイティブの cc_library または java_wrap_cc の依存関係は含まれません。
compress

文字列。デフォルトは "preserve" です。

常に圧縮する（「yes」）、常に保存する（「no」）、変更せずに渡す（「preserve」）のいずれか。デフォルトは「preserve」で、最も効率的なオプションです。インフレートやデフレートのために余分な処理は行われません。
deploy_env

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

このバイナリのデプロイ環境を表す「java_binary」または「java_single_jar」ターゲットのリスト。別の「java_binary」によって読み込まれるプラグインをビルドする場合は、この属性を設定します。このルールでビルドされた jar から「deploy_env」依存関係が除外されます。
deploy_manifest_lines

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

META-INF/manifest.mf ファイルに追加する行のリスト。
exclude_build_data

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

デフォルトで生成される build-data.properties ファイルを省略するかどうか。
multi_release

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

マルチリリース出力 JAR を有効にするかどうか。

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, exec_compatible_with, exec_group_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, oneversion_allowlist_for_tests, oneversion_whitelist, package_configuration, package_metadata, 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 コンパイラの構成を指定します。使用する toolchain は、--java_toolchain 引数で変更できます。通常、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（デフォルトは {}）

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

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

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

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

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

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

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

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

ヘッダー コンパイラのラベル。--java_header_compilation が有効な場合は必須です。
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 がサンドボックス化されたマルチプレックス永続ワーカーとして実行されることをサポートしている場合は 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

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

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

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

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

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

非推奨: 代わりに oneversion_allowlist を使用してください
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

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

turbine を呼び出すときの JVM の引数のリスト。
xlint

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

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