Android 规则

规则

• <ph type="x-smartling-placeholder"></ph> android_binary
• <ph type="x-smartling-placeholder"></ph> aar_import
• <ph type="x-smartling-placeholder"></ph> android_library
• <ph type="x-smartling-placeholder"></ph> android_instrumentation_test
• <ph type="x-smartling-placeholder"></ph> android_local_test
• <ph type="x-smartling-placeholder"></ph> android_device
• <ph type="x-smartling-placeholder"></ph> android_ndk_repository
• <ph type="x-smartling-placeholder"></ph> android_sdk_repository

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 应用 使用调试密钥签名的软件包文件 <ph type="x-smartling-placeholder"></ph> zipaligned，就可用于开发和调试应用。 使用调试密钥签名时，您无法发布应用。
• name_unsigned.apk： 上面可以使用发布密钥签名的 。
• name_deploy.jar：包含 传递关闭此目标。

  这个部署 jar 中包含了 搜索此目标的运行时类路径的类加载器 自始至终。

• name_proguard.jar：Java 归档，其中包含 在 name_deploy.jar。 只有在以下情况下才会生成此输出： proguard_specs 属性均为 。
• name_proguard.map：映射文件结果 在 name_deploy.jar 上运行 ProGuard。 只有在以下情况下才会生成此输出： proguard_specs 属性均为 且 proguard_generate_mapping 或者设置了 shrink_resources 时。

示例

Android 规则的示例可在 examples/android 目录 Bazel 源代码树。

参数

属性
name	Name; required 此目标的唯一名称。
deps	List of labels; optional 要链接到二进制文件目标的其他库的列表。 允许的库类型包括：android_library、 具有 android 约束的 java_library 以及 cc_library 会封装或生成 .so 原生库， Android 目标平台。
srcs	List of labels; optional 为创建目标而处理的源文件列表。 系统会编译 .java 类型的 srcs 文件。 为了便于阅读，最好不要输入 将生成的 .java 源文件复制到 srcs 中。 请改为将依赖的规则名称放入 srcs 中，如 如下所述。 系统会将 .srcjar 类型的 srcs 个文件解压缩并 编译完成。（如果您需要生成一组 Genrule 或 build 扩展程序。）
assets	List of labels; optional 要打包的资产的列表。 通常是 glob 下所有文件的 assets 目录中。您也可以引用其他规则（生成 文件）或导出的文件，前提是所有这些文件都位于 assets_dir 目录中。
assets_dir	String; optional 提供 assets 中文件的路径的字符串。 assets 和 assets_dir 对描述的是已打包的内容 资源，并且应同时提供这两个属性，或都不提供。
crunch_png	Boolean; optional; default is True 是否处理 PNG 文件。这与九宫格处理无关，九宫格处理 完成。对于 aapt 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 工具的其他命令行标记。 需遵循 "Make variable" 替换和 Bourne shell 令牌化。
enable_data_binding	Boolean; optional; default is False 如果为 true，此规则将处理 数据 binding 表达式，通过 resource_files 属性。不使用 设置，数据绑定表达式会导致构建失败。 如需构建具有数据绑定的 Android 应用，您还必须执行以下操作： 为传递性依赖于此属性的所有 Android 规则设置此属性。 这是因为依赖者通过资源来继承规则的数据绑定表达式。 合并。因此，它们还需要构建数据绑定来解析这些表达式。 将数据绑定运行时库的 deps = 条目添加到所有目标 属性。此库的位置取决于您的 Depot 设置。
incremental_dexing	Integer; optional; nonconfigurable; default is -1 强制构建目标，无论是否使用增量 dexing，覆盖默认值 和 --incremental_dexing 标志。
instruments	Label; optional 要插桩的 android_binary 目标。 如果设置了此属性，系统会将此 android_binary 视为测试 用于插桩测试的应用android_instrumentation_test 然后，可在其 test_app 属性。
javacopts	List of strings; optional 此目标的额外编译器选项。 需遵循 "Make variable" 替换和 Bourne shell 令牌化。 这些编译器选项会在全局编译器选项之后传递到 javac。
key_rotation_min_sdk	String; optional 设置 APK 轮替签名所适用的最低 Android 平台版本（API 级别） 密钥应该用于生成 APK 的签名。APK 的原始签名密钥 将用于之前的所有平台版本。
main_dex_list	Label; optional 文本文件包含类文件名列表。由这些类文件定义的类 放在主 class.dex 中。e.g.: 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}实例： 将替换为此字典中与 name 对应的值。 applicationId、versionCode、versionName、minSdkVersion、targetSdkVersion 和 maxSdkVersion 还将覆盖清单的相应属性，并且 use-sdk 标记。packageName 将被忽略，并将从 applicationId 设为 指定的软件包或清单中的软件包。当 manifest_merger 设置为“legacy”时， applicationId、versionCode 和 versionName 会生效。
multidex	String; optional; default is "native" 是否将代码拆分为多个 dex 文件。 可能的值： <ph type="x-smartling-placeholder"> </ph> native：当 dex 为 64K 索引限制时，将代码拆分为多个 dex 文件 上限。假设原生平台支持在运行时加载 MultiDex 类。 这仅适用于 Android L 及更高版本。 legacy：当 dex 为 64K 索引限制时，将代码拆分为多个 dex 文件 上限。假设 MultiDex 类通过应用代码加载（即没有 原生平台支持）。 manual_main_dex：当 dex 为 64K 时，将代码拆分为多个 dex 文件 超出了索引限制。主 dex 文件的内容需要由 使用 main_dex_list 属性。 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： 插件属性会在 这个目标就创建好了生成的资源 该插件将会包含在 目标。
proguard_apply_dictionary	Label; optional 用作 ProGuard 映射的文件。 以换行符分隔的“words”文件重命名类和成员时提取的 混淆处理。
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 要打包的资源列表。 通常是 glob 下所有文件的 res 目录中。 生成的文件（来自 genrule）可通过 还要在此处添加标签。唯一的限制是 生成的输出必须在同一“res”下与其他任何 资源文件。
shrink_resources	Integer; optional; default is -1 是否执行资源缩减。二进制文件未使用的资源将 从 APK 中移除。只有使用本地资源（即 manifest 和 resource_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：收缩由 <ph type="x-smartling-placeholder"></ph> --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_library和 android_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 归档的 bundle 此目标的资源和资源。不包含传递性闭包。

示例

Android 规则的示例可在 examples/android 目录 Bazel 源代码树。

以下示例展示了 如何设置 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 以及 cc_library 封装或生成 .so 原生库 针对 Android 目标平台。
srcs	List of labels; optional .java 或 .srcjar 文件的列表， 以创建目标。 系统会编译 .java 类型的 srcs 文件。 为了便于阅读，最好不要输入 将生成的 .java 源文件复制到 srcs 中。 请改为将依赖的规则名称放入 srcs 中，如 如下所述。 系统会将 .srcjar 类型的 srcs 个文件解压缩并 编译完成。（如果您需要生成一组 Genrule 或 build 扩展程序。） 如果省略 srcs，则将 已从此规则导出 deps（请参阅 如需了解详情，请参阅 java_library 的导出 了解有关导出依赖项的信息）。不过，这种行为 即将弃用；尽量不要依赖于它。
assets	List of labels; optional 要打包的资产的列表。 通常是 glob 下所有文件的 assets 目录中。您也可以引用其他规则（生成 文件）或导出的文件，前提是所有这些文件都位于 assets_dir 目录中。
assets_dir	String; optional 提供 assets 中文件的路径的字符串。 assets 和 assets_dir 对描述的是已打包的内容 资源，并且应同时提供这两个属性，或都不提供。
custom_package	String; optional 将为其生成 Java 源代码的 Java 软件包。 默认情况下，系统会根据 BUILD 文件所在的目录推断软件包 包含该规则的位置您可以指定其他软件包 强烈建议您不要这样做，因为它可能会导致 只在运行时检测到的库。
enable_data_binding	Boolean; optional; default is False 如果为 true，此规则将处理 数据 binding 表达式，通过 resource_files 属性。不使用 设置，数据绑定表达式会导致构建失败。 如需构建具有数据绑定的 Android 应用，您还必须执行以下操作： 为传递性依赖于此属性的所有 Android 规则设置此属性。 这是因为依赖者通过资源来继承规则的数据绑定表达式。 合并。因此，它们还需要构建数据绑定来解析这些表达式。 将数据绑定运行时库的 deps = 条目添加到所有目标 属性。此库的位置取决于您的 Depot 设置。
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_parcelables 且 idl_srcs 必须位于对象的 java 软件包指定的路径下 它们在 idl_import_root 下代表。当idl_import_root： 未指定，则 idl_parcelables 和 idl_srcs 都必须位于 Java 根目录下由其软件包指定的路径。 请参阅 示例。
idl_parcelables	List of labels; optional 要作为导入项提供的 Android IDL 定义列表。 这些文件将作为 依赖于此库的 android_library 目标 或通过其传递闭包，不会将其转换为 Java 或经过编译。 只有 .aidl 文件直接对应于 应包含此库中的 .java 个来源（例如，自定义 Parcelable 的实现代码中），否则 idl_srcs 应为 。 这些文件必须放置在适当的位置，以便 AIDL 编译器找到它们。 请参阅 idl_import_root 的说明 了解其含义。
idl_preprocessed	List of labels; optional 要作为导入的预处理 Android IDL 定义列表。 这些文件将作为 依赖于此库的 android_library 目标 或通过其传递闭包，不会将其转换为 Java 或经过编译。 只有与以下查询直接对应的经过预处理的 .aidl 文件： 应包含此库中的 .java 个来源（例如，自定义 Parcelable 的实现），否则使用 idl_srcs 需要转换为 Java 接口的 Android IDL 定义 使用idl_parcelable 非预处理的 AIDL 文件。
idl_srcs	List of labels; optional 要转换为 Java 接口的 Android IDL 定义列表。 生成 Java 接口后，这些接口将一起编译 包含 srcs 的内容。 这些文件将作为 依赖于此库的 android_library 目标 或传递关闭。 这些文件必须放置在适当的位置，以便 AIDL 编译器找到它们。 请参阅 idl_import_root 的说明 了解其含义。
javacopts	List of strings; optional 此目标的额外编译器选项。 需遵循 "Make variable" 替换和 Bourne shell 令牌化。 这些编译器选项会在全局编译器选项之后传递到 javac。
manifest	Label; optional Android 清单文件的名称，通常为 AndroidManifest.xml。 如果定义了 resource_files 或 assets，则必须定义。
neverlink	Boolean; optional; default is False 请仅将此库用于编译，不要在运行时使用。 标记为 neverlink 的规则的输出不会用于 “.apk”创建。如果库是由 运行时环境。
plugins	List of labels; optional 在编译时运行的 Java 编译器插件。 以下列中指定的每个java_plugin： 插件属性会在 这个目标就创建好了生成的资源 该插件将会包含在 目标。
proguard_specs	List of labels; optional 用作 Proguard 规范的文件。 这些将描述 Proguard 使用的一组规范。如果已指定， 它们会添加到依赖于此库的任何 android_binary 目标中。 此处包含的文件只能具有幂等规则，即 -dontnote、-dontwarn、 以及以 -keep 开头的规则。其他选项只能显示在 android_binary 的 proguard_specs，旨在确保非同义合并。
resource_files	List of labels; optional 要打包的资源列表。 通常是 glob 下所有文件的 res 目录中。 生成的文件（来自 genrule）可通过 还要在此处添加标签。唯一的限制是 生成的输出必须在同一“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 通过其android_binary instruments 属性。

示例

# 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 测试框架配合使用。 请访问 Android Robolectric 网站，详细了解 主要负责编写 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_library aar_import、java_import、java_library、 和 java_lite_proto_library。
srcs	List of labels; optional 为创建目标而处理的源文件列表。 必需（下述特殊情况除外）。 系统会编译 .java 类型的 srcs 文件。 为了便于阅读，最好不要输入 将生成的 .java 源文件复制到 srcs 中。 请改为将依赖的规则名称放入 srcs 中，如 如下所述。 系统会将 .srcjar 类型的 srcs 个文件解压缩并 编译完成。（如果您需要生成一组 Genrule 或 build 扩展程序。） 系统会忽略所有其他文件 至少有一个上述文件类型的文件。否则， 错误。 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，此规则将处理 数据 binding 引用。不包含 此设置，数据绑定依赖项不会生成必要的二进制级代码， 并可能会导致构建失败
javacopts	List of strings; optional 此库的额外编译器选项。 需遵循 "Make variable" 替换和 Bourne shell 令牌化。 这些编译器选项会在全局编译器选项之后传递到 javac。
jvm_flags	List of strings; optional 为了运行此二进制文件而生成的一系列要嵌入的封装容器脚本中的标志。 遵守$(location)和 创建变量" 替换以及 Bourne shell 令牌化。 Java 二进制文件的封装容器脚本包含类路径定义 （查找所有相关的 jar）并调用正确的 Java 解释器。 由封装容器脚本生成的命令行包含 主类，后跟 "$@"，这样您就可以传递其他 参数。不过， 行。jvm_flags 的内容会添加到封装容器中 脚本。 请注意，此属性对 *_deploy.jar 没有影响 输出。
manifest	Label; optional Android 清单文件的名称，通常为 AndroidManifest.xml。 如果定义了 resource_files 或 assets 或者 被测库中包含 minSdkVersion 标记。
manifest_values	Dictionary: String -> String; optional 要在清单中替换的值的字典。以下集群中任何 ${name}实例： 将替换为此字典中与 name 对应的值。 applicationId、versionCode、versionName、 minSdkVersion、targetSdkVersion和 maxSdkVersion 还会覆盖相应的属性 和 use-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_deps和deps。
stamp	Integer; optional; default is 0 是否将 build 信息编码到二进制文件中。可能的值： <ph type="x-smartling-placeholder"> </ph> stamp = 1：始终将 build 信息标记到二进制文件中，即使在 --nostamp build。 应避免使用，因为这可能会终止 二进制文件以及依赖于它的任何下游操作。 stamp = 0：始终用常量值替换 build 信息。本次 提供良好的构建结果缓存。 stamp = -1：build 信息的嵌入由 --[no]stamp 标志。 除非其依赖项发生变化，否则带时间戳的二进制文件不会被重新构建。
test_class	String; optional 测试运行程序要加载的 Java 类。 此属性用于指定要运行的 Java 类的名称 此测试。很少需要设置此属性。如果省略此参数，则 Java 类 其名称对应于该 API 的name 将使用 android_local_test 规则。 测试类需要带有 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 运行。它会启动模拟器，将要测试的目标/运行的目标复制到模拟器； 并根据需要进行测试或运行

android_device 支持创建 KVM 映像，前提是底层 system_image 基于 X86， 针对最多 I686 CPU 架构进行了优化。如需使用 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

此规则将生成图片和启动脚本。您可以启动模拟器了 。该脚本会公开 以下标志：

• --adb_port：用于公开 adb 的端口。如果您想发出 adb 命令发送到模拟器，这就是您将发出 adb connect 的端口 目标。
• --emulator_port：用于公开模拟器的 Telnet 管理的端口 控制台。
• --enable_display：如果为 true，则启动带有显示屏的模拟器（默认值 false）。
• --action：启动或终止。
• --apks_to_install：要在模拟器上安装的 APK 列表。

参数

属性
name	Name; required 此目标的唯一名称。
cache	Integer; required 模拟器的缓存分区的大小（以 MB 为单位）。 最小值为 16 MB。
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 MB。
screen_density	Integer; required 所模拟屏幕的密度（以每英寸像素数为单位）。 最小值为 30 ppi。
system_image	Label; required 包含以下文件的文件组： <ph type="x-smartling-placeholder"> </ph> system.img：系统分区 kernel-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 进行构建还需要在您的android_sdk_repository WORKSPACE 文件。

有关详情，请参阅 将 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。它会在编译 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 NDK： Android 开发者网站 。
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 目标。

示例

若要设置 Android SDK for Bazel，至少要设置一个 android_sdk_repository 规则 名为“androidsdk”位于 WORKSPACE 文件中，并将 $ANDROID_HOME 环境变量添加到 Android SDK 的路径中。Bazel 将使用最高 Android API 级别 Android SDK 中默认安装的 Build Tools 和 Build Tools 版本。

android_sdk_repository(
    name = "androidsdk",
)

为确保 build 的可重现性，path、api_level 和 可以将 build_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 工作区的一部分（例如，如果它已签入到版本）中，则该 SDK 版本会很有用 控制）。

支持库

支持库在 Android SDK 管理器中可作为“Android 支持存储库”提供。 这是一组带版本号的常见 Android 库，例如 Support 库和 AppCompat 库， 打包为本地 Maven 制品库。android_sdk_repository 生成 Bazel 可以用在 API 的依赖项中， 目标为 android_binary 和 android_library。

所生成目标的名称根据 Android 支持代码库，格式为 @androidsdk//${group}:${artifact}-${version}。 以下示例展示了 android_library 如何依赖于 v7 appcompat 库。

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会创建一个android_sdk目标 SDK 中安装的各个名为 @androidsdk//:sdk-${level} 的 API 级别， 。例如，要针对非默认 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 构建工具版本。如果未指定， 将使用安装的最新 Build Tools 版本。 Bazel 需要构建工具版本 30.0.0 或更高版本。
path	String; optional; nonconfigurable Android SDK 的绝对路径或相对路径。该属性或 必须设置 $ANDROID_HOME 环境变量。 您可以从以下位置下载 Android SDK： Android 开发者网站。
repo_mapping	Dictionary: String -> String; optional 从本地代码库名称到全局代码库名称的字典。这样，您就可以控制 此代码库依赖项的工作区依赖项解析。 例如，条目 "@foo": "@bar" 声明，在任何时候， 依赖于 "@foo"（例如 "@foo//some:target"），它应该在 全局声明的 "@bar" ("@bar//some:target")。