Android 规则

规则

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:使用调试密钥签名的 Android 应用软件包文件并进行 压缩对齐,可用于开发和调试应用。使用调试密钥进行签名时,您无法发布应用。
  • name_unsigned.apk:上述文件的未签名版本,可以在公开发布之前使用发布密钥进行签名。
  • name_deploy.jar:包含此目标的传递闭包的 Java 归档。

    部署 jar 包含类加载器从头到尾搜索此目标的运行时类路径时能找到的所有类。

  • name_proguard.jar:包含对 name_deploy.jar 运行 ProGuard 的结果的 Java 归档。 只有在指定了 proguard_specs 属性时,系统才会生成此输出。
  • name_proguard.map:在 name_deploy.jar 上运行 ProGuard 的映射文件结果。只有在指定了 proguard_specs 属性且设置了 proguard_generate_mappingshrink_resources 的情况下,系统才会生成此输出。

示例

您可以在 Bazel 源代码树的 examples/android 目录中找到 Android 规则示例。

参数

属性
name

Name; required

此目标的唯一名称。

deps

List of labels; optional

要链接到二进制目标的其他库的列表。允许的库类型包括:android_libraryjava_library(具有 android 约束条件)以及 cc_library(针对 Android 目标平台封装或生成 .so 原生库)。
srcs

List of labels; optional

为创建目标而处理的源文件列表。

系统会编译 .java 类型的 srcs 文件。为了便于阅读,最好将生成的 .java 源文件的名称放入 srcs 中。请将依赖的规则名称放在 srcs 中,如下所述。

系统会解压缩并编译类型为 .srcjarsrcs 文件。(如果您需要生成一组带有 genrule 或 build 扩展名的 .java 文件,则此方法非常有用)。

assets

List of labels; optional

要打包的资源的列表。 这通常是 assets 目录下所有文件的 glob。您还可以引用其他软件包中的其他规则(任何生成文件的规则)或导出文件,只要所有这些文件都在相应软件包的 assets_dir 目录下即可。
assets_dir

String; optional

指定 assets 中文件的路径的字符串。 assetsassets_dir 对描述打包的资产,应同时提供这两个属性,否则一个也不提供。
crunch_png

Boolean; optional; default is True

执行(或不处理)PNG 文件。这独立于 9-patch 处理(始终如此)。这是针对 aapt bug 的已弃用解决方法,该 bug 已在 aapt2 中修复。
custom_package

String; optional

将为其生成 Java 源代码的 Java 软件包。 默认情况下,系统会从包含规则的 BUILD 文件所在的目录推断软件包。您可以指定其他软件包,但强烈建议不要这样做,因为它可能会与其他库产生类路径冲突,而这些库只会在运行时被检测到。
debug_key

Label; optional; default is @bazel_tools//tools/android:debug_keystore

包含用于对调试 APK 进行签名的调试密钥库的文件。通常,您不想使用默认键以外的键,因此应省略该属性。

警告:请勿使用生产密钥,它们应受到严格保护,且不应保留在源代码树中

debug_signing_keys

List of labels; optional

用于对调试 APK 签名的文件列表、调试密钥库。通常,您不想使用默认键以外的键,因此应省略该属性。

警告:请勿使用生产密钥,它们应受到严格保护,且不应保留在源代码树中

debug_signing_lineage_file

Label; optional

包含 debug_signing_keys 的签名谱系的文件。通常,您不想使用默认键以外的键,因此应省略该属性。

警告:请勿使用生产密钥,它们应受到严格保护,且不应保留在源代码树中

densities

List of strings; optional

构建 APK 时要过滤的密度。 这会移除具有指定屏幕密度的设备不会加载的光栅可绘制资源,以缩减 APK 大小。如果相应的兼容性屏幕部分尚未包含超集列表,系统也会将其添加到清单中。
dex_shards

Integer; optional; default is 1

dexing 应分解的分片数。这可以大幅提高 dex 处理速度,但代价是会占用应用安装和启动时间。二进制文件越大,应使用的分片就越多。建议从 25 开始试用。

请注意,每个分片都将在最终应用中生成至少一个 dex。因此,不建议将此值设为大于 1 的值。

dexopts

List of strings; optional

在生成 class.dex 时用于 dx 工具的其他命令行标志。受“创建变量”替换和 Bourne shell 令牌化的约束。
enable_data_binding

Boolean; optional; default is False

如果为 true,此规则会处理通过 resource_files 属性包含的布局资源中的数据绑定表达式。如果没有此设置,数据绑定表达式会导致构建失败。

如需构建具有数据绑定的 Android 应用,您还必须执行以下操作:

  1. 请为以传递方式依赖于此规则的所有 Android 规则设置此属性。这是因为依赖项会通过资源合并继承规则的数据绑定表达式。因此,它们还需要通过数据绑定进行构建,以解析这些表达式。
  2. 将数据绑定运行时库的 deps = 条目添加到设置此属性的所有目标中。此库的位置取决于您的仓库设置。
incremental_dexing

Integer; optional; nonconfigurable; default is -1

在使用或不使用增量 dex 处理的情况下,强制构建目标,从而覆盖默认值和 --incremental_dexing 标志。
instruments

Label; optional

要插桩的 android_binary 目标。

如果设置了该属性,则此 android_binary 将被视为插桩测试的测试应用。然后,android_instrumentation_test 目标便可在其 test_app 属性中指定此目标。

javacopts

List of strings; optional

此目标的额外编译器选项。 可以使用“Make 变量”替换和 Bourne shell 令牌化

这些编译器选项在全局编译器选项之后传递给 javac。

key_rotation_min_sdk

String; optional

设置应使用 APK 的轮替签名密钥生成 APK 签名的最低 Android 平台版本(API 级别)。该 APK 的原始签名密钥将用于所有先前的平台版本。
main_dex_list

Label; optional

文本文件包含类文件名列表。由这些类文件定义的类会放入主类.dex 中。例如:
          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

List of strings; optional

传递给主 dex 列表构建器的命令行选项。 使用此选项可影响主 dex 列表中包含的类。
main_dex_proguard_specs

List of labels; optional

将用作 Proguard 规范的文件,以确定必须保留在主 dex 中的类。 仅在 multidex 属性设置为 legacy 时允许。
manifest

Label; required

Android 清单文件的名称,通常为 AndroidManifest.xml。如果定义了 resource_files 或 assets,则必须定义它。
manifest_values

Dictionary: String -> String; optional

要在清单中替换的值的字典。清单中的任何 ${name} 实例都将被替换为与此字典中的名称相对应的值。 applicationId、versionCode、versionName、minSdkVersion、targetSdkVersion 和 maxSdkVersion 还会替换清单和 uses-sdk 标记的相应属性。packageName 将被忽略,并通过 applicationId(若已指定)或通过清单中的软件包进行设置。当 manifest_merger 设置为 legacy 时,只有 applicationId、versionCode 和 versionName 会产生影响。
multidex

String; optional; default is "native"

是否将代码拆分为多个 dex 文件。
可能的值:
  • native:当超出 dex 64K 索引限制时,将代码拆分为多个 dex 文件。假设原生平台支持在运行时加载 MultiDex 类。 这仅适用于 Android L 及更高版本。
  • legacy:当超出 dex 64K 索引限制时,将代码拆分为多个 dex 文件。假设通过应用代码加载 MultiDex 类(即,无原生平台支持)。
  • manual_main_dex:当超出 dex 64K 索引限制时,将代码拆分为多个 dex 文件。您需要通过在文本文件中使用 main_dex_list 属性提供类列表来指定主 dex 文件的内容。
  • off:将所有代码编译到单个 dex 文件中,即使该文件超出了索引限制也是如此。
nocompress_extensions

List of strings; optional

在 APK 中保持未压缩状态的文件扩展名列表。
package_id

Integer; optional; default is 0

要分配给此二进制文件中的资源的软件包 ID。

如需了解详情,请参阅 AAPT2 的 --package-id 参数。您通常可以(并且应该)不设置此政策,从而生成默认值 127 (0x7F)。

plugins

List of labels; optional

在编译时运行的 Java 编译器插件。 每当构建此目标时,插件属性中指定的每个 java_plugin 都将运行。插件生成的资源将包含在目标的结果 jar 中。
proguard_apply_dictionary

Label; optional

用作 ProGuard 映射的文件。 在混淆期间重命名类和成员时从中拉取的“字词”的换行符文件。
proguard_apply_mapping

Label; optional

用作 ProGuard 映射的文件。 由 proguard_generate_mapping 生成的映射文件,可重复使用,以将同一映射应用于新 build。
proguard_generate_mapping

Boolean; optional; nonconfigurable; default is False

是否生成 Proguard 映射文件。 仅当指定 proguard_specs 时,系统才会生成映射文件。此文件将列出原始与经过混淆处理的类、方法和字段名称之间的映射。

警告:如果使用此属性,Proguard 规范不应包含 -dontobfuscate-printmapping

proguard_specs

List of labels; optional

要用作 Proguard 规范的文件。 此文件将描述 Proguard 将使用的一组规范。
resource_configuration_filters

List of strings; optional

资源配置过滤条件列表,如“en”,用于将 APK 中的资源限制为仅包含“en”配置中的资源。如需启用伪本地化,请添加 en_XA 和/或 ar_XB 伪语言区域。
resource_files

List of labels; optional

要打包的资源列表。 这通常是 res 目录下所有文件的 glob
生成的文件(来自 genrules)也可以由 Label 在此处引用。唯一的限制是,生成的输出必须与包含的其他资源文件位于同一“res”目录下。
shrink_resources

Integer; optional; default is -1

是否执行资源缩减。二进制文件未使用的资源将从 APK 中移除。只有使用本地资源(例如 manifestresource_files 属性)的规则支持此功能,并且需要 ProGuard。其运行方式与 Gradle 资源缩减器 (https://developer.android.com/studio/build/shrink-code.html#shrink-resources) 基本相同。

显著差异:

  • 系统将移除 values/ 中的资源以及基于文件的资源
  • 默认情况下使用strict mode
  • 只有 aapt2 支持移除未使用的 ID 资源
如果启用了资源缩减功能,系统还会生成 name_files/resource_shrinker.log,其中详细说明了执行的分析和删除操作。

可能的值包括:

  • shrink_resources = 1:开启 Android 资源缩减功能
  • shrink_resources = 0:关闭 Android 资源缩减功能
  • shrink_resources = -1:收缩由 --android_resource_shrinking 标志控制。

aar_import

aar_import(name, deps, data, aar, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, exports, features, licenses, restricted_to, srcjar, tags, target_compatible_with, testonly, visibility)

此规则允许使用 .aar 文件作为 android_libraryandroid_binary 规则的库。

示例

    aar_import(
        name = "google-vr-sdk",
        aar = "gvr-android-sdk/libraries/sdk-common-1.10.0.aar",
    )

    android_binary(
        name = "app",
        manifest = "AndroidManifest.xml",
        srcs = glob(["**.java"]),
        deps = [":google-vr-sdk"],
    )

参数

属性
name

Name; required

此目标的唯一名称。

aar

Label; required

要提供给依赖于此目标的 Android 目标的 .aar 文件。
exports

List of labels; optional

要导出到依赖于此规则的规则的目标。 请参阅 java_library.exports.
srcjar

Label; optional

一个 JAR 文件,其中包含 AAR 中已编译的 JAR 文件的源代码。

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:一个 Android“aar”软件包,其中包含此目标的 Java 归档和资源。它不包含传递闭包。

示例

您可以在 Bazel 源代码树的 examples/android 目录中找到 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

Name; required

此目标的唯一名称。

deps

List of labels; optional

要链接的其他库的列表。允许的库类型包括:android_library、带有 android 约束的 java_library,以及针对 Android 目标平台使用 cc_library 封装或生成 .so 原生库。
srcs

List of labels; optional

为创建目标而处理的 .java.srcjar 文件的列表。

系统会编译 .java 类型的 srcs 文件。为了便于阅读,最好将生成的 .java 源文件的名称放入 srcs 中。请将依赖的规则名称放在 srcs 中,如下所述。

系统会解压缩并编译类型为 .srcjarsrcs 文件。(如果您需要生成一组带有 genrule 或 build 扩展名的 .java 文件,则此方法非常有用)。

如果省略 srcs,则系统会从此规则导出 deps 中指定的任何依赖项(如需详细了解如何导出依赖项,请参阅 java_library 的导出内容)。不过,此行为很快就会被弃用;请尽量不要依赖于它。

assets

List of labels; optional

要打包的资源的列表。 这通常是 assets 目录下所有文件的 glob。您还可以引用其他软件包中的其他规则(任何生成文件的规则)或导出文件,只要所有这些文件都在相应软件包的 assets_dir 目录下即可。
assets_dir

String; optional

指定 assets 中文件的路径的字符串。 assetsassets_dir 对描述打包的资产,应同时提供这两个属性,否则一个也不提供。
custom_package

String; optional

将为其生成 Java 源代码的 Java 软件包。 默认情况下,系统会从包含规则的 BUILD 文件所在的目录推断软件包。您可以指定其他软件包,但强烈建议不要这样做,因为它可能会与其他库产生类路径冲突,而这些库只会在运行时被检测到。
enable_data_binding

Boolean; optional; default is False

如果为 true,此规则会处理通过 resource_files 属性包含的布局资源中的数据绑定表达式。如果没有此设置,数据绑定表达式会导致构建失败。

如需构建具有数据绑定的 Android 应用,您还必须执行以下操作:

  1. 请为以传递方式依赖于此规则的所有 Android 规则设置此属性。这是因为依赖项会通过资源合并继承规则的数据绑定表达式。因此,它们还需要通过数据绑定进行构建,以解析这些表达式。
  2. 将数据绑定运行时库的 deps = 条目添加到设置此属性的所有目标中。此库的位置取决于您的仓库设置。
exported_plugins

List of labels; optional

要导出到直接依赖于此库的库的 java_plugin(例如注解处理器)列表。

指定的 java_plugin 列表将应用于任何直接依赖于此库的库,就像该库已在 plugins 中明确声明这些标签一样。

exports

List of labels; optional

通过 exports 属性到达的所有规则的闭包被视为直接依赖于具有 exports 的目标的任何规则的直接依赖项。

exports 不是它们所属规则的直接依赖项。

exports_manifest

Integer; optional; default is 1

是否将清单条目导出到依赖于此目标的 android_binary 目标。uses-permissions 属性绝不会导出。
idl_import_root

String; optional

指向包含此库中的 idl 源代码的 Java 软件包树的根目录的软件包相对路径。

在处理依赖于此库的 idl 源文件时,此路径将用作导入根目录。

指定 idl_import_root 时,idl_parcelablesidl_srcs 都必须位于其在 idl_import_root 下所代表对象的 Java 软件包所指定的路径上。未指定 idl_import_root 时,idl_parcelablesidl_srcs 都必须位于 Java 根目录下由其软件包指定的路径中。

查看 示例

idl_parcelables

List of labels; optional

要作为 import 提供的 Android IDL 定义列表。 这些文件将作为依赖于此库的任何 android_library 目标的导入项提供(直接或通过其传递闭包),但不会转换为 Java 或编译。

应仅包含与此库中的 .java 源代码直接对应的 .aidl 文件(例如,Parcelable 的自定义实现),否则应使用 idl_srcs

这些文件必须放置在适当的位置,以便 AI 编译器找到它们。如需了解其含义,请参阅 idl_import_root 的说明

idl_preprocessed

List of labels; optional

作为导入项提供的预处理 Android IDL 定义的列表。 这些文件将作为依赖于此库的任何 android_library 目标的导入项提供(直接或通过其传递闭包),但不会转换为 Java 或编译。

只能包含与此库中的 .java 源代码直接对应的经过预处理的 .aidl 文件(例如,Parcelable 的自定义实现),否则,对于需要转换为 Java 接口的 Android IDL 定义,请使用 idl_srcs,对于未经预处理的 AIDL 文件,请使用 idl_parcelable

idl_srcs

List of labels; optional

要转换为 Java 接口的 Android IDL 定义列表。 生成 Java 接口后,这些接口将与 srcs 的内容一起编译。

这些文件将作为依赖于此库的任何 android_library 目标的导入项提供,无论是直接依赖此库,还是通过其传递闭包实现。

这些文件必须放置在适当的位置,以便 AI 编译器找到它们。如需了解其含义,请参阅 idl_import_root 的说明

javacopts

List of strings; optional

此目标的额外编译器选项。 可以使用“Make 变量”替换和 Bourne shell 令牌化

这些编译器选项在全局编译器选项之后传递给 javac。

manifest

Label; optional

Android 清单文件的名称,通常为 AndroidManifest.xml。如果定义了 resource_files 或 assets,则必须定义它。

Boolean; optional; default is False

此库只能用于编译,不能在运行时使用。 标记为 neverlink 的规则的输出将不会在创建 .apk 时使用。如果库将在执行期间由运行时环境提供,则此属性非常有用。
plugins

List of labels; optional

在编译时运行的 Java 编译器插件。 每当构建此目标时,插件属性中指定的每个 java_plugin 都将运行。插件生成的资源将包含在目标的结果 jar 中。
proguard_specs

List of labels; optional

要用作 Proguard 规范的文件。 这些内容将描述 Proguard 将使用的一组规范。如果指定,系统会将其添加到任何 android_binary 目标中,具体取决于此库。 此处包含的文件只能包含幂等规则,即 -dontnote、-dontwarn、承担任何副作用,以及以 -keep 开头的规则。其他选项只能出现在 android_binary 的 proguard_specs 中,以确保实现非同义合并。
resource_files

List of labels; optional

要打包的资源列表。 这通常是 res 目录下所有文件的 glob
生成的文件(来自 genrules)也可以由 Label 在此处引用。唯一的限制是,生成的输出必须与包含的其他资源文件位于同一“res”目录下。

android_instrumentation_test

android_instrumentation_test(name, data, args, compatible_with, deprecation, distribs, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, licenses, local, restricted_to, shard_count, size, support_apks, tags, target_compatible_with, target_device, test_app, testonly, timeout, toolchains, visibility)

android_instrumentation_test 规则用于运行 Android 插桩测试。它将启动模拟器,安装被测试的应用、测试应用和任何其他所需的应用,并运行测试软件包中定义的测试。

test_app 属性指定包含测试的 android_binary。该 android_binary 进而通过其 instruments 属性指定被测 android_binary 应用。

示例

# java/com/samples/hello_world/BUILD

android_library(
    name = "hello_world_lib",
    srcs = ["Lib.java"],
    manifest = "LibraryManifest.xml",
    resource_files = glob(["res/**"]),
)

# The app under test
android_binary(
    name = "hello_world_app",
    manifest = "AndroidManifest.xml",
    deps = [":hello_world_lib"],
)
# javatests/com/samples/hello_world/BUILD

android_library(
    name = "hello_world_test_lib",
    srcs = ["Tests.java"],
    deps = [
      "//java/com/samples/hello_world:hello_world_lib",
      ...  # test dependencies such as Espresso and Mockito
    ],
)

# The test app
android_binary(
    name = "hello_world_test_app",
    instruments = "//java/com/samples/hello_world:hello_world_app",
    manifest = "AndroidManifest.xml",
    deps = [":hello_world_test_lib"],
)

android_instrumentation_test(
    name = "hello_world_uiinstrumentation_tests",
    target_device = ":some_target_device",
    test_app = ":hello_world_test_app",
)

参数

属性
name

Name; required

此目标的唯一名称。

support_apks

List of labels; optional

在插桩测试开始之前在设备上安装的其他 APK。
target_device

Label; required

应在其中运行测试的 android_device

如需在已在运行的模拟器上或在实体设备上运行测试,请使用以下参数: --test_output=streamed --test_arg=--device_broker_type=LOCAL_ADB_SERVER --test_arg=--device_serial_number=$device_identifier

test_app

Label; required

包含测试类的 android_binary 目标。 android_binary 目标必须通过其 instruments 属性指定要测试的目标。

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 部署归档(仅在明确请求时构建)。

示例

如需将 Robolectric 与 android_local_test 搭配使用,请将 Robolectric 的代码库添加到 WORKSPACE 文件中:

http_archive(
    name = "robolectric",
    urls = ["https://github.com/robolectric/robolectric/archive/<COMMIT>.tar.gz"],
    strip_prefix = "robolectric-<COMMIT>",
    sha256 = "<HASH>",
)
load("@robolectric//bazel:robolectric.bzl", "robolectric_repositories")
robolectric_repositories()
这会拉取 Robolectric 所需的 maven_jar 规则。那么,每条 android_local_test 规则都应依赖于 @robolectric//bazel:robolectric。请参见下面的示例。

android_local_test(
    name = "SampleTest",
    srcs = [
        "SampleTest.java",
    ],
    manifest = "LibManifest.xml",
    deps = [
        ":sample_test_lib",
        "@robolectric//bazel:robolectric",
    ],
)

android_library(
    name = "sample_test_lib",
    srcs = [
         "Lib.java",
    ],
    resource_files = glob(["res/**"]),
    manifest = "AndroidManifest.xml",
)

参数

属性
name

Name; required

此目标的唯一名称。

deps

List of labels; optional

要测试的库以及要链接到目标的其他库的列表。 测试中提供在该属性的传递闭包中的 Android 规则中声明的所有资源、资产和清单文件。

deps 中允许的规则列表包括 android_libraryaar_importjava_importjava_libraryjava_lite_proto_library

srcs

List of labels; optional

为创建目标而处理的源文件列表。必需(下述特殊情况除外)。

系统会编译 .java 类型的 srcs 文件。为了便于阅读,最好将生成的 .java 源文件的名称放入 srcs 中。请将依赖的规则名称放在 srcs 中,如下所述。

系统会解压缩并编译类型为 .srcjarsrcs 文件。(如果您需要生成一组带有 genrule 或 build 扩展名的 .java 文件,则此方法非常有用)。

只要至少存在一个上述文件类型的文件,所有其他文件都会被忽略。否则会报错。

srcs 属性是必需的,并且不能为空,除非指定了 runtime_deps

custom_package

String; optional

将在其中生成 R 类的 Java 软件包。默认情况下,系统会从包含规则的 BUILD 文件所在的目录推断软件包。如果您使用此属性,可能还需要使用 test_class
densities

List of strings; optional

构建 APK 时要过滤的密度。相应的兼容屏幕部分也将添加到清单中(如果其尚未包含超集 StarlarkListing)。
enable_data_binding

Boolean; optional; default is False

如果为 true,此规则会处理此测试所使用的已启用数据绑定的依赖项中使用的数据绑定引用。如果没有此设置,数据绑定依赖项将无法生成必要的二进制文件级代码,并且可能会导致构建失败。
javacopts

List of strings; optional

此库的额外编译器选项。 可以使用“Make 变量”替换和 Bourne shell 令牌化

这些编译器选项在全局编译器选项之后传递给 javac。

jvm_flags

List of strings; optional

要嵌入为运行此二进制文件而生成的封装容器脚本中的标志列表。支持使用 $(location)“Make 变量”替换,以及 Bourne shell 标记化

Java 二进制文件的封装容器脚本包含 CLASSPATH 定义(以查找所有依赖的 jar),并调用正确的 Java 解释器。封装容器脚本生成的命令行包含主类的名称,后跟 "$@",因此您可以在类名称后面传递其他参数。但是,在命令行中,必须在类名称之前指定用于 JVM 解析的参数。jvm_flags 的内容会先添加到封装容器脚本中,再列出类名称。

请注意,此属性对 *_deploy.jar 输出没有影响

manifest

Label; optional

Android 清单文件的名称,通常为 AndroidManifest.xml。如果定义了 resource_files 或 assets,或者被测库中的任何清单包含 minSdkVersion 标记,则必须定义该属性。
manifest_values

Dictionary: String -> String; optional

要在清单中替换的值的字典。清单中的任何 ${name} 实例都将被替换为与此字典中的名称相对应的值。 applicationIdversionCodeversionNameminSdkVersiontargetSdkVersionmaxSdkVersion 还会替换清单和 uses-sdk 标记的相应属性。packageName 将被忽略,并且将通过 applicationId(如果已指定)或清单中的软件包进行设置。 无需在规则中包含清单即可使用 manifest_values。
nocompress_extensions

List of strings; optional

在资源 APK 中保持未压缩状态的文件扩展名列表。
plugins

List of labels; optional

在编译时运行的 Java 编译器插件。 每当构建此规则时,系统都会运行此属性中指定的每个 java_plugin。库还可以从使用 exported_plugins 的依赖项继承插件。插件生成的资源将包含在此规则生成的 jar 中。
resource_configuration_filters

List of strings; optional

资源配置过滤条件列表(如“en”),用于将 APK 中的资源限制为仅包含“en”配置中的资源。
resource_jars

List of labels; optional

已废弃:请改用 java_import 和 deps 或 Runtime_deps。
resource_strip_prefix

String; optional

要从 Java 资源中删除的路径前缀。

如果指定,则此路径前缀将从 resources 属性中的每个文件中删除。如果资源文件不在此目录下,则会出错。如果未指定(默认值),资源文件的路径将根据与源文件的 Java 软件包相同的逻辑确定。例如,stuff/java/foo/bar/a.txt 中的源文件位于 foo/bar/a.txt

runtime_deps

List of labels; optional

可供最终二进制文件或在运行时进行测试的库。 与普通 deps 一样,这些变量会显示在运行时类路径上,但与它们不同的是,它们不会出现在编译时类路径上。仅在运行时需要的依赖项应在此处列出。依赖项分析工具应忽略 runtime_depsdeps 中都出现的目标。
stamp

Integer; optional; default is 0

是否将 build 信息编码到二进制文件中。可能的值包括:
  • stamp = 1:始终将 build 信息压印到二进制文件中,即使在 --nostamp build 中也是如此。应避免此设置,因为它可能会终止对该二进制文件的远程缓存以及依赖于该二进制文件的任何下游操作。
  • stamp = 0:始终用常量值替换 build 信息。这样可以提供良好的构建结果缓存。
  • stamp = -1:build 信息的嵌入由 --[no]stamp 标志控制。

带时间戳的二进制文件不会重新构建,除非其依赖项发生更改。

test_class

String; optional

将由测试运行程序加载的 Java 类。

此属性用于指定此测试要运行的 Java 类的名称。很少需要设置该属性。如果省略此参数,将使用名称与此 android_local_test 规则的 name 相对应的 Java 类。 测试类需要带有 org.junit.runner.RunWith 注解。

use_launcher

Boolean; optional; default is True

二进制文件是否应使用自定义启动器。

如果将此属性设为 false,则对于此目标,系统将忽略 launcher 属性和相关的 --java_launcher 标志。

android_device

android_device(name, cache, compatible_with, default_properties, deprecation, distribs, exec_compatible_with, exec_properties, features, horizontal_resolution, licenses, platform_apks, ram, restricted_to, screen_density, system_image, tags, target_compatible_with, testonly, vertical_resolution, visibility, vm_heap)

此规则会创建一个使用指定规范配置的 Android 模拟器。此模拟器可以通过 bazel 运行命令或直接执行生成的脚本来启动。建议依赖于现有的 android_device 规则,而不是定义自己的规则。

此规则适合用于 --run_under 标志,以便 bazel 测试和 blaze 运行。它会启动模拟器,将要测试/运行的目标复制到模拟器,然后根据需要进行测试或运行。

如果底层 system_image 是基于 X86 并且针对最多 I686 CPU 架构进行了优化,则 android_device 支持创建 KVM 映像。如需使用 KVM,请将 tags = ['requires-kvm'] 添加到 android_device 规则中。

隐式输出目标

  • name_images/userdata.dat:包含用于启动模拟器的映像文件和快照
  • name_images/emulator-meta-data.pb:包含传递给模拟器以重启模拟器所需的序列化信息。

示例

以下示例展示了如何使用 android_device。 //java/android/helloandroid/BUILD包含

android_device(
    name = "nexus_s",
    cache = 32,
    default_properties = "nexus_s.properties",
    horizontal_resolution = 480,
    ram = 512,
    screen_density = 233,
    system_image = ":emulator_images_android_16_x86",
    vertical_resolution = 800,
    vm_heap = 32,
)

filegroup(
    name = "emulator_images_android_16_x86",
    srcs = glob(["androidsdk/system-images/android-16/**"]),
)

//java/android/helloandroid/nexus_s.properties 包含:

ro.product.brand=google
ro.product.device=crespo
ro.product.manufacturer=samsung
ro.product.model=Nexus S
ro.product.name=soju

此规则将生成映像和启动脚本。您可以通过执行 bazel run :nexus_s -- --action=start 在本地启动模拟器。该脚本会公开以下标记:

  • --adb_port:公开 adb 的端口。如果您希望向模拟器发出 adb 命令,这就是您要发出 adb connect 的端口。
  • --emulator_port:用于公开模拟器的 telnet 管理控制台的端口。
  • --enable_display:如果为 true,则启动模拟器并显示显示屏(默认为 false)。
  • --action:启动或终止。
  • --apks_to_install:要在模拟器上安装的 APK 的列表。

参数

属性
name

Name; required

此目标的唯一名称。

cache

Integer; required

模拟器缓存分区的大小(以兆字节为单位)。 此值的最小值为 16 兆字节。
default_properties

Label; optional

放置在模拟器上的 /default.prop 中的单个属性文件。 这样一来,规则作者可以进一步配置模拟器,使其看起来更像是真实设备(特别是控制其 UserAgent 字符串以及其他可能导致应用或服务器针对特定设备表现出不同行为的行为)。此文件中的属性将替换通常由模拟器设置的只读属性,例如 ro.product.model。
horizontal_resolution

Integer; required

要模拟的水平屏幕分辨率(以像素为单位)。 最小值为 240。
platform_apks

List of labels; optional

启动时要在设备上安装的 APK 的列表。
ram

Integer; required

要为设备模拟的 RAM 大小(以兆字节为单位)。 此数据针对整个设备,而不仅仅是设备上安装的特定应用。最小值为 64 兆字节。
screen_density

Integer; required

模拟屏幕的密度,以每英寸像素数为单位。此值的最小值为 30 ppi。
system_image

Label; required

包含以下文件的文件组:
  • system.img:系统分区
  • core-qemu:模拟器将加载的 Linux 内核
  • ramdisk.img:启动时使用的 initrd 映像
  • userdata.img:初始用户数据分区
  • source.properties:包含图片相关信息的属性文件
这些文件属于 Android SDK 或由第三方提供(例如 Intel 提供 x86 映像)。
vertical_resolution

Integer; required

要模拟的垂直屏幕分辨率(以像素为单位)。 最小值为 240。
vm_heap

Integer; required

Android 将为每个进程使用的虚拟机堆的大小(以 MB 为单位)。 最小值为 16 MB。

android_ndk_repository

android_ndk_repository(name, api_level, path, repo_mapping)

将 Bazel 配置为使用 Android NDK,以支持使用原生代码构建 Android 目标。

请注意,针对 Android 进行构建还需要在 WORKSPACE 文件中添加 android_sdk_repository 规则。

如需了解详情,请参阅 有关将 Android NDK 与 Bazel 搭配使用的完整文档

示例

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 包含 cpufeatures 库,此库可用于在运行时检测设备的 CPU。以下示例演示了如何将 cpufeatures 与 Bazel 搭配使用。

# jni.cc
#include "ndk/sources/android/cpufeatures/cpu-features.h"
...
# BUILD
cc_library(
    name = "jni",
    srcs = ["jni.cc"],
    deps = ["@androidndk//:cpufeatures"],
)

参数

属性
name

Name; required

此目标的唯一名称。

api_level

Integer; optional; nonconfigurable; default is 0

构建所依据的 Android API 级别。如果未指定,将使用安装的最高 API 级别。
path

String; optional; nonconfigurable

Android NDK 的绝对路径或相对路径。必须设置此属性或 $ANDROID_NDK_HOME 环境变量。

您可以从 Android 开发者网站 下载 Android NDK。

repo_mapping

Dictionary: String -> String; optional

从本地代码库名称到全局代码库名称的字典。这样,您就可以控制此代码库依赖项的工作区依赖项解析。

例如,条目 "@foo": "@bar" 声明,每当此代码库依赖于 "@foo"(例如对 "@foo//some:target" 的依赖项)时,它实际上应该在全局声明的 "@bar" ("@bar//some:target") 中解析该依赖项。

android_sdk_repository

android_sdk_repository(name, api_level, build_tools_version, path, repo_mapping)

将 Bazel 配置为使用本地 Android SDK 来支持构建 Android 目标。

示例

为 Bazel 设置 Android SDK 的最低要求是在 WORKSPACE 文件中添加一条名为“androidsdk”的 android_sdk_repository 规则,并将 $ANDROID_HOME 环境变量设置为 Android SDK 的路径。默认情况下,Bazel 会使用 Android SDK 中安装的最高 Android API 级别和构建工具版本。
android_sdk_repository(
    name = "androidsdk",
)

为了确保 build 可重现,您可以将 pathapi_levelbuild_tools_version 属性设为特定值。如果 Android SDK 未安装指定的 API 级别或构建工具版本,构建将会失败。

android_sdk_repository(
    name = "androidsdk",
    path = "./sdk",
    api_level = 19,
    build_tools_version = "25.0.0",
)

以上示例还演示了如何使用指向 Android SDK 的工作区相对路径。如果 Android SDK 是 Bazel 工作区的一部分(例如,如果它签入了版本控制),这会非常有用。

支持库

Android SDK 管理器中以“Android 支持代码库”的形式提供支持库。这是一组带有版本编号的常用 Android 库(例如 Support 库和 AppCompat 库),打包为本地 Maven 制品库。android_sdk_repository 会为每个库生成 Bazel 目标,这些目标可在 android_binaryandroid_library 目标的依赖项中使用。

所生成目标的名称派生自 Android 支持代码库中库的 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

Name; required

此目标的唯一名称。

api_level

Integer; optional; nonconfigurable; default is 0

默认情况下构建所依据的 Android API 级别。如果未指定,将使用安装的最高 API 级别。

可用于给定 build 的 API 级别可被 android_sdk 标志替换。无论是否指定此属性,android_sdk_repository 都会为 SDK 中安装的每个 API 级别创建一个名为 @androidsdk//:sdk-${level}android_sdk 目标。例如,如需针对非默认 API 级别进行构建,请输入 bazel build --android_sdk=@androidsdk//:sdk-19 //java/com/example:app

如需查看 android_sdk_repository 生成的所有 android_sdk 目标,您可以运行 bazel query "kind(android_sdk, @androidsdk//...)"

build_tools_version

String; optional; nonconfigurable

要在 Android SDK 中使用的 Android 构建工具版本。如果未指定,将使用安装的最新构建工具版本。

Bazel 需要使用构建工具 30.0.0 或更高版本。

path

String; optional; nonconfigurable

Android SDK 的绝对路径或相对路径。必须设置此属性或 $ANDROID_HOME 环境变量。

您可以从 Android 开发者网站下载 Android SDK。

repo_mapping

Dictionary: String -> String; optional

从本地代码库名称到全局代码库名称的字典。这样,您就可以控制此代码库依赖项的工作区依赖项解析。

例如,条目 "@foo": "@bar" 声明,每当此代码库依赖于 "@foo"(例如对 "@foo//some:target" 的依赖项)时,它实际上应该在全局声明的 "@bar" ("@bar//some:target") 中解析该依赖项。