ルール
android_binary
ルールのソースを表示android_binary(name, deps, srcs, assets, assets_dir, compatible_with, crunch_png, custom_package, debug_key, debug_signing_keys, debug_signing_lineage_file, densities, deprecation, dex_shards, dexopts, distribs, enable_data_binding, exec_compatible_with, exec_properties, features, incremental_dexing, instruments, javacopts, key_rotation_min_sdk, licenses, main_dex_list, main_dex_list_opts, main_dex_proguard_specs, manifest, manifest_values, multidex, nocompress_extensions, package_id, plugins, proguard_apply_dictionary, proguard_apply_mapping, proguard_generate_mapping, proguard_specs, resource_configuration_filters, resource_files, restricted_to, shrink_resources, tags, target_compatible_with, testonly, visibility)
Android アプリ パッケージ ファイル(.apk)を生成します。
暗黙的な出力ターゲット
name.apk
: デバッグキーで署名され、 zipalign された Android アプリ パッケージ ファイル。アプリの開発とデバッグに使用できます。 デバッグキーで署名されたアプリはリリースできません。name_unsigned.apk
: 上記のファイルの署名なしバージョン。一般公開前にリリースキーで署名できます。name_deploy.jar
: このターゲットの推移的クロージャを含む Java アーカイブ。deploy jar には、このターゲットのランタイム クラスパスを最初から最後まで検索するクラスローダーで検出されるすべてのクラスが含まれています。
name_proguard.jar
:name_deploy.jar
で ProGuard を実行した結果を含む Java アーカイブ。この出力は、proguard_specs 属性が指定されている場合にのみ生成されます。name_proguard.map
:name_deploy.jar
で ProGuard を実行した場合のマッピング ファイルの結果。この出力は、proguard_specs 属性が指定され、proguard_generate_mapping または shrink_resources が設定されている場合にのみ生成されます。
例
Android ルールの例は、Bazel ソースツリーの examples/android
ディレクトリにあります。
引数
属性 | |
---|---|
name |
名前(必須) このターゲットの一意の名前。 |
deps
|
ラベルのリスト。デフォルトは android 制約と cc_library ラップのある android_library 、java_library です。または、Android ターゲット プラットフォーム用に .so ネイティブ ライブラリを生成します。
|
srcs
|
ラベルのリスト。デフォルトは
|
assets
|
ラベルのリスト。デフォルトは assets ディレクトリにあるすべてのファイルの glob です。また、すべてのファイルが対応するパッケージの assets_dir ディレクトリの下にある限り、他のルール(ファイルを生成するルール)や、他のパッケージ内のエクスポートされたファイルを参照することもできます。 |
assets_dir
|
文字列。デフォルトは assets 内のファイルのパスを指定する文字列。
assets と assets_dir のペアはパッケージ化されたアセットを表します。両方の属性を指定するか、指定しないかのどちらかです。
|
crunch_png
|
ブール値。デフォルトは |
custom_package
|
文字列。デフォルトは |
debug_key
|
ラベル: デフォルトは 警告: 本番環境のキーは使用しないでください。厳重に保護し、ソースツリーに保持しないでください。 |
debug_signing_keys
|
ラベルのリスト。デフォルトは 警告: 本番環境のキーは使用しないでください。厳重に保護し、ソースツリーに保持しないでください。 |
debug_signing_lineage_file
|
ラベル: デフォルトは 警告: 本番環境のキーは使用しないでください。厳重に保護し、ソースツリーに保持しないでください。 |
densities
|
文字列のリスト。デフォルトは |
dex_shards
|
整数。デフォルトは 最終的なアプリでは、シャードごとに少なくとも 1 つの dex が生成されます。このため、リリース バイナリでは、この値を 1 より大きい値に設定することはおすすめしません。 |
dexopts
|
文字列のリスト。デフォルトは |
enable_data_binding
|
ブール値。デフォルトは データ バインディングを使用して Android アプリを作成するには、次のことも行う必要があります。
|
incremental_dexing
|
整数、構成不可、デフォルトは |
instruments
|
ラベル: デフォルトは 計測する この属性が設定されている場合、この |
javacopts
|
文字列のリスト。デフォルトは これらのコンパイラ オプションは、グローバル コンパイラ オプションの後に javac に渡されます。 |
key_rotation_min_sdk
|
文字列。デフォルトは |
main_dex_list
|
ラベル: デフォルトは android/support/multidex/MultiDex$V19.class android/support/multidex/MultiDex.class android/support/multidex/MultiDexApplication.class com/google/common/base/Objects.class multidex="manual_main_dex" とともに使用する必要があります。 |
main_dex_list_opts
|
文字列のリスト。デフォルトは |
main_dex_proguard_specs
|
ラベルのリスト。デフォルトは multidex 属性が legacy に設定されている場合にのみ許可されます。
|
manifest
|
ラベル(必須) Android マニフェスト ファイルの名前(通常はAndroidManifest.xml )。
resource_files または assets が定義されている場合は定義する必要があります。
|
manifest_values
|
辞書: 文字列 -> 文字列(デフォルトは
マニフェスト内の
|
multidex
|
文字列。デフォルトは 有効な値:
|
nocompress_extensions
|
文字列のリスト。デフォルトは |
package_id
|
整数。デフォルトは 詳しくは、AAPT2 の |
plugins
|
ラベルのリスト。デフォルトは java_plugin は、このターゲットがビルドされるたびに実行されます。プラグインによって生成されたリソースは、ターゲットの結果の jar に含まれます。 |
proguard_apply_dictionary
|
ラベル: デフォルトは |
proguard_apply_mapping
|
ラベル: デフォルトは proguard_generate_mapping によって生成されたマッピング ファイル。同じマッピングを新しいビルドに適用するために再利用されます。
|
proguard_generate_mapping
|
ブール値、設定不可、デフォルトは proguard_specs が指定された場合にのみ生成されます。このファイルには、元のクラス、メソッド、フィールド名と難読化されたクラス、メソッド、フィールド名の間のマッピングがリストされます。
警告: この属性を使用する場合、ProGuard 仕様に |
proguard_specs
|
ラベルのリスト。デフォルトは |
resource_configuration_filters
|
文字列のリスト。デフォルトは en_XA または ar_XB (あるいはその両方)の疑似ロケールを追加します。
|
resource_files
|
ラベルのリスト。デフォルトは res ディレクトリにあるすべてのファイルの glob です。生成されたファイル(genrules から)も、ここでラベルから参照できます。唯一の制限は、生成される出力は、含まれる他のリソース ファイルと同じ「 res 」ディレクトリに配置する必要があることです。 |
shrink_resources
|
整数。デフォルトは manifest 属性と resource_files 属性)を使用するルールでのみサポートされており、ProGuard が必要です。動作は Gradle リソース圧縮ツール(https://developer.android.com/studio/build/shrink-code.html#shrink-resources)とほぼ同じです。
主な違いは次のとおりです。
name_files/resource_shrinker.log も生成され、実行された分析と削除の詳細が示されます。可能な値:
|
android_library
ルールのソースを表示android_library(name, deps, srcs, data, assets, assets_dir, compatible_with, custom_package, deprecation, distribs, enable_data_binding, exec_compatible_with, exec_properties, exported_plugins, exports, exports_manifest, features, idl_import_root, idl_parcelables, idl_preprocessed, idl_srcs, javacopts, licenses, manifest, neverlink, plugins, proguard_specs, resource_files, restricted_to, tags, target_compatible_with, testonly, visibility)
このルールは、ソースを .jar
ファイルにコンパイルしてアーカイブします。Android ランタイム ライブラリ android.jar
は、コンパイル クラスパスに暗黙的に配置されます。
暗黙的な出力ターゲット
libname.jar
: Java アーカイブ。libname-src.jar
: ソース(ソース jar)を含むアーカイブ。name.aar
: このターゲットの Java アーカイブとリソースを含む Android の「aar」バンドル。推移的クロージャは含まれていない。
例
Android ルールの例は、Bazel ソースツリーの examples/android
ディレクトリにあります。
次の例は、idl_import_root
を設定する方法を示しています。//java/bazel/helloandroid/BUILD
に以下を含めます。
android_library( name = "parcelable", srcs = ["MyParcelable.java"], # bazel.helloandroid.MyParcelable # MyParcelable.aidl will be used as import for other .aidl # files that depend on it, but will not be compiled. idl_parcelables = ["MyParcelable.aidl"] # bazel.helloandroid.MyParcelable # We don't need to specify idl_import_root since the aidl file # which declares bazel.helloandroid.MyParcelable # is present at java/bazel/helloandroid/MyParcelable.aidl # underneath a java root (java/). ) android_library( name = "foreign_parcelable", srcs = ["src/android/helloandroid/OtherParcelable.java"], # android.helloandroid.OtherParcelable idl_parcelables = [ "src/android/helloandroid/OtherParcelable.aidl" # android.helloandroid.OtherParcelable ], # We need to specify idl_import_root because the aidl file which # declares android.helloandroid.OtherParcelable is not positioned # at android/helloandroid/OtherParcelable.aidl under a normal java root. # Setting idl_import_root to "src" in //java/bazel/helloandroid # adds java/bazel/helloandroid/src to the list of roots # the aidl compiler will search for imported types. idl_import_root = "src", ) # Here, OtherInterface.aidl has an "import android.helloandroid.CallbackInterface;" statement. android_library( name = "foreign_interface", idl_srcs = [ "src/android/helloandroid/OtherInterface.aidl" # android.helloandroid.OtherInterface "src/android/helloandroid/CallbackInterface.aidl" # android.helloandroid.CallbackInterface ], # As above, idl_srcs which are not correctly positioned under a java root # must have idl_import_root set. Otherwise, OtherInterface (or any other # interface in a library which depends on this one) will not be able # to find CallbackInterface when it is imported. idl_import_root = "src", ) # MyParcelable.aidl is imported by MyInterface.aidl, so the generated # MyInterface.java requires MyParcelable.class at compile time. # Depending on :parcelable ensures that aidl compilation of MyInterface.aidl # specifies the correct import roots and can access MyParcelable.aidl, and # makes MyParcelable.class available to Java compilation of MyInterface.java # as usual. android_library( name = "idl", idl_srcs = ["MyInterface.aidl"], deps = [":parcelable"], ) # Here, ServiceParcelable uses and thus depends on ParcelableService, # when it's compiled, but ParcelableService also uses ServiceParcelable, # which creates a circular dependency. # As a result, these files must be compiled together, in the same android_library. android_library( name = "circular_dependencies", srcs = ["ServiceParcelable.java"], idl_srcs = ["ParcelableService.aidl"], idl_parcelables = ["ServiceParcelable.aidl"], )
引数
属性 | |
---|---|
name |
名前(必須) このターゲットの一意の名前。 |
deps
|
ラベルのリスト。デフォルトは android 制約と cc_library ラップのある android_library 、java_library です。または、Android ターゲット プラットフォーム用に .so ネイティブ ライブラリを生成します。
|
srcs
|
ラベルのリスト。デフォルトは .java ファイルまたは .srcjar ファイルのリスト。
|
assets
|
ラベルのリスト。デフォルトは assets ディレクトリにあるすべてのファイルの glob です。また、すべてのファイルが対応するパッケージの assets_dir ディレクトリの下にある限り、他のルール(ファイルを生成するルール)や、他のパッケージ内のエクスポートされたファイルを参照することもできます。 |
assets_dir
|
文字列。デフォルトは assets 内のファイルのパスを指定する文字列。
assets と assets_dir のペアはパッケージ化されたアセットを表します。両方の属性を指定するか、指定しないかのどちらかです。
|
custom_package
|
文字列。デフォルトは |
enable_data_binding
|
ブール値。デフォルトは データ バインディングを使用して Android アプリを作成するには、次のことも行う必要があります。
|
exported_plugins
|
ラベルのリスト。デフォルトは java_plugin (アノテーション プロセッサなど)のリスト。
指定された |
exports
|
ラベルのリスト。デフォルトは exports 属性で到達するすべてのルールの終了は、exports でターゲットに直接依存するルールの直接的な依存関係とみなされます。
|
exports_manifest
|
整数。デフォルトは android_binary ターゲットにエクスポートするかどうかを指定します。uses-permissions 属性はエクスポートされません。
|
idl_import_root
|
文字列。デフォルトは このパスは、このライブラリに依存する IDL ソースを処理するときにインポート ルートとして使用されます。
例をご覧ください。 |
idl_parcelables
|
ラベルのリスト。デフォルトは android_library ターゲットのインポートとして直接、または推移的クロージャを介して提供されますが、Java への変換やコンパイルは行われません。
このライブラリの これらのファイルは、aidl コンパイラが見つけられるよう適切に配置する必要があります。 この意味については、idl_import_root の説明をご覧ください。 |
idl_preprocessed
|
ラベルのリスト。デフォルトは android_library ターゲットのインポートとして直接、または推移的クロージャを介して提供されますが、Java への変換やコンパイルは行われません。
このライブラリの |
idl_srcs
|
ラベルのリスト。デフォルトは srcs の内容とともにコンパイルされます。これらのファイルは、このライブラリに依存する これらのファイルは、aidl コンパイラが見つけられるよう適切に配置する必要があります。 この意味については、idl_import_root の説明をご覧ください。 |
javacopts
|
文字列のリスト。デフォルトは これらのコンパイラ オプションは、グローバル コンパイラ オプションの後に javac に渡されます。 |
manifest
|
ラベル: デフォルトは AndroidManifest.xml )。
resource_files または assets が定義されている場合は定義する必要があります。
|
neverlink
|
ブール値。デフォルトは neverlink とマークされたルールの出力は、.apk の作成には使用されません。実行時にランタイム環境によってライブラリが提供される場合に便利です。 |
plugins
|
ラベルのリスト。デフォルトは java_plugin は、このターゲットがビルドされるたびに実行されます。プラグインによって生成されたリソースは、ターゲットの結果の jar に含まれます。 |
proguard_specs
|
ラベルのリスト。デフォルトは android_binary ターゲットに追加されます。
ここに含めるファイルには、べき等ルール(-dontnote、-dontwarn、confirmnosideeffects、-keep で始まるルール)のみを含める必要があります。他のオプションは、非自動的マージを保証するために、android_binary の proguard_specs でのみ指定できます。
|
resource_files
|
ラベルのリスト。デフォルトは res ディレクトリにあるすべてのファイルの glob です。生成されたファイル(genrules から)も、ここでラベルから参照できます。唯一の制限は、生成される出力は、含まれる他のリソース ファイルと同じ「 res 」ディレクトリに配置する必要があることです。 |
android_local_test
ルールのソースを表示android_local_test(name, deps, srcs, data, args, compatible_with, custom_package, densities, deprecation, enable_data_binding, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, javacopts, jvm_flags, licenses, local, manifest, manifest_values, nocompress_extensions, plugins, resource_configuration_filters, resource_jars, resource_strip_prefix, restricted_to, runtime_deps, shard_count, size, stamp, tags, target_compatible_with, test_class, testonly, timeout, toolchains, use_launcher, visibility)
このルールは、android_library
ルールを(デバイス上ではなく)ローカルで単体テストするためのものです。Android Robolectric テスト フレームワークと連携して動作します。Robolectric テストの作成について詳しくは、Android Robolectric サイトをご覧ください。
暗黙的な出力ターゲット
name.jar
: テストの Java アーカイブ。name-src.jar
: ソースを含むアーカイブ(「ソース jar」)。name_deploy.jar
: デプロイに適した Java デプロイ アーカイブ(明示的にリクエストされた場合にのみビルドされます)。
例
android_local_test
で Robolectric を使用するには、Robolectric のリポジトリを WORKSPACE
ファイルに追加します。
http_archive( name = "robolectric", urls = ["https://github.com/robolectric/robolectric-bazel/archive/<COMMIT>.tar.gz"], strip_prefix = "robolectric-bazel-<COMMIT>", sha256 = "<HASH>", ) load("@robolectric//bazel:robolectric.bzl", "robolectric_repositories") robolectric_repositories()これにより、Robolectric に必要な
maven_jar
ルールが pull されます。
この場合、各 android_local_test
ルールは @robolectric//bazel:robolectric
に依存する必要があります。下記の例をご覧ください。
android_local_test( name = "SampleTest", srcs = [ "SampleTest.java", ], manifest = "LibManifest.xml", deps = [ ":sample_test_lib", "@robolectric//bazel:android-all", ], ) android_library( name = "sample_test_lib", srcs = [ "Lib.java", ], resource_files = glob(["res/**"]), manifest = "AndroidManifest.xml", )
引数
属性 | |
---|---|
name |
名前(必須) このターゲットの一意の名前。 |
deps
|
ラベルのリスト。デフォルトは
|
srcs
|
ラベルのリスト。デフォルトは
上記のファイル形式のファイルが 1 つ以上ある限り、他のすべてのファイルは無視されます。それ以外の場合は、エラーが発生します。
|
custom_package
|
文字列。デフォルトは test_class も使用する必要があります。 |
densities
|
文字列のリスト。デフォルトは |
enable_data_binding
|
ブール値。デフォルトは |
javacopts
|
文字列のリスト。デフォルトは これらのコンパイラ オプションは、グローバル コンパイラ オプションの後に javac に渡されます。 |
jvm_flags
|
文字列のリスト。デフォルトは Java バイナリのラッパー スクリプトには、CLASSPATH 定義(依存するすべての jar を見つけるため)が含まれており、適切な Java インタープリタを呼び出します。ラッパー スクリプトによって生成されたコマンドラインでは、メインクラスの名前の後に この属性は |
manifest
|
ラベル: デフォルトは AndroidManifest.xml )。
resource_files または assets が定義されている場合、またはテスト対象のライブラリのマニフェストに minSdkVersion タグが含まれている場合は、定義する必要があります。
|
manifest_values
|
辞書: 文字列 -> 文字列(デフォルトは applicationId 、versionCode 、versionName 、minSdkVersion 、targetSdkVersion 、maxSdkVersion は、マニフェスト タグと use-sdk タグの対応する属性もオーバーライドします。packageName は無視され、applicationId (指定されている場合)またはマニフェスト内のパッケージから設定されます。
manifest_values を使用するために、ルールにマニフェストは必要ありません。
|
nocompress_extensions
|
文字列のリスト。デフォルトは |
plugins
|
ラベルのリスト。デフォルトは java_plugin が実行されます。ライブラリは、exported_plugins を使用する依存関係からプラグインを継承することもできます。プラグインによって生成されたリソースは、このルールで生成される jar に含まれます。 |
resource_configuration_filters
|
文字列のリスト。デフォルトは |
resource_jars
|
ラベルのリスト。デフォルトは |
resource_strip_prefix
|
文字列。デフォルトは
指定すると、このパス接頭辞は |
runtime_deps
|
ラベルのリスト。デフォルトは deps と同様に、これらはランタイム クラスパスに表示されますが、コンパイル時のクラスパスとは異なります。実行時にのみ必要な依存関係をここにリストします。依存関係分析ツールは、runtime_deps と deps の両方に存在するターゲットを無視する必要があります。 |
stamp
|
整数。デフォルトは
スタンプされたバイナリは、依存関係が変更されない限り再ビルドされません。 |
test_class
|
文字列。デフォルトは
この属性は、このテストで実行する Java クラスの名前を指定します。この設定が必要になることはほとんどありません。この引数を省略すると、この |
use_launcher
|
ブール値。デフォルトは この属性を false に設定した場合、このターゲットでは launcher 属性と関連する |
android_ndk_repository
ルールのソースを表示android_ndk_repository(name, api_level, path, repo_mapping)
Android NDK を使用してネイティブ コードによる Android ターゲットのビルドをサポートするように Bazel を構成します。
この android_ndk_repository
の実装は、Starlark の実装に置き換えられています。バージョン 25 以降の NDK の今後のバージョンのサポートは、Starlark バージョンの android_ndk_repository
に実装されます。Starlark のバージョンについては、rules_android_ndk をご覧ください。
なお、Android 向けのビルドでは、WORKSPACE
ファイルに android_sdk_repository
ルールも必要です。
詳細については、 Bazel による Android NDK の使用に関するドキュメントをご覧ください。
例
android_ndk_repository( name = "androidndk", )
上記の例では、$ANDROID_NDK_HOME
から Android NDK を探し、サポートする最も高い API レベルを検出します。
android_ndk_repository( name = "androidndk", path = "./android-ndk-r20", api_level = 24, )
上記の例では、./android-ndk-r20
のワークスペース内にある Android NDK を使用します。JNI コードのコンパイル時に、API レベル 24 のライブラリが使用されます。
cpufeatures
Android NDK には、実行時にデバイスの CPU を検出するために使用できる cpufeatures ライブラリが含まれています。次の例は、Bazel で cpufeatures を使用する方法を示しています。
# jni.cc #include "ndk/sources/android/cpufeatures/cpu-features.h" ...
# BUILD cc_library( name = "jni", srcs = ["jni.cc"], deps = ["@androidndk//:cpufeatures"], )
引数
属性 | |
---|---|
name |
名前(必須) このターゲットの一意の名前。 |
api_level
|
整数、構成不可、デフォルトは |
path
|
文字列、設定不可、デフォルトは $ANDROID_NDK_HOME 環境変数を設定する必要があります。Android NDK は Android デベロッパー サイト からダウンロードできます。 |
repo_mapping
|
辞書: 文字列 -> 文字列(デフォルトは たとえば、エントリ |
android_sdk_repository
ルールのソースを表示android_sdk_repository(name, api_level, build_tools_version, path, repo_mapping)
Android ターゲットのビルドをサポートするローカル Android SDK を使用するように Bazel を構成します。
例
Bazel 用の Android SDK を設定するには、最低限、WORKSPACE
ファイルに「androidsdk」という名前の android_sdk_repository
ルールを配置し、$ANDROID_HOME
環境変数を Android SDK のパスに設定します。Bazel は、Android SDK にインストールされている最も高い Android API レベルとビルドツール バージョンをデフォルトで使用します。
android_sdk_repository( name = "androidsdk", )
ビルドを再現できるように、path
、api_level
、build_tools_version
の各属性を特定の値に設定できます。指定された API レベルまたはビルドツールのバージョンが Android SDK にインストールされていない場合、ビルドは失敗します。
android_sdk_repository( name = "androidsdk", path = "./sdk", api_level = 19, build_tools_version = "25.0.0", )
上記の例では、Android SDK へのワークスペース相対パスも使用しています。これは、Android SDK が Bazel ワークスペースの一部である場合(バージョン管理にチェックインしている場合など)に役立ちます。
サポート ライブラリ
サポート ライブラリは、Android SDK Manager で「Android Support Repository」として入手できます。Support ライブラリや AppCompat ライブラリなど、バージョン管理された一般的な Android ライブラリのセットで、ローカルの Maven リポジトリとしてパッケージ化されています。android_sdk_repository
は、これらの各ライブラリに対して、android_binary
ターゲットと android_library
ターゲットの依存関係で使用できる Bazel ターゲットを生成します。
生成されるターゲットの名前は、Android Support Repository 内にあるライブラリの Maven 座標から取得され、@androidsdk//${group}:${artifact}-${version}
という形式になります。次の例は、android_library
が v7 appcompat ライブラリのバージョン 25.0.0 に依存する方法を示しています。
android_library( name = "lib", srcs = glob(["*.java"]), manifest = "AndroidManifest.xml", resource_files = glob(["res/**"]), deps = ["@androidsdk//com.android.support:appcompat-v7-25.0.0"], )
引数
属性 | |
---|---|
name |
名前(必須) このターゲットの一意の名前。 |
api_level
|
整数、構成不可、デフォルトは 特定のビルドに使用される API レベルは、
|
build_tools_version
|
文字列、設定不可、デフォルトは Bazel には、バージョン 30.0.0 以降のビルドツールが必要です。 |
path
|
文字列、設定不可、デフォルトは $ANDROID_HOME 環境変数を設定する必要があります。Android SDK は Android デベロッパー サイトからダウンロードできます。 |
repo_mapping
|
辞書: 文字列 -> 文字列(デフォルトは たとえば、エントリ |