Reglas de Android

Reglas

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)

Produce archivos de paquetes de aplicaciones para Android (.apk).

Objetivos de salida implícitos

  • name.apk: Es un archivo de paquete de aplicación para Android firmado con claves de depuración y zipalign que podría usarse para desarrollar y depurar tu aplicación. No puedes lanzar tu aplicación cuando está firmada con las claves de depuración.
  • name_unsigned.apk: Es una versión sin firmar del archivo anterior que se podía firmar con las claves de lanzamiento antes del lanzamiento público.
  • name_deploy.jar: Es un archivo Java que contiene el cierre transitivo de este destino.

    El archivo jar de implementación contiene todas las clases que encontraría un cargador de clases que buscó la ruta de clase de tiempo de ejecución de este destino de principio a fin.

  • name_proguard.jar: Es un archivo Java que contiene el resultado de la ejecución de ProGuard en name_deploy.jar. Este resultado solo se produce si se especifica el atributo proguard_specs.
  • name_proguard.map: Es el resultado de un archivo de asignación de la ejecución de ProGuard en name_deploy.jar. Este resultado solo se produce si se especifica el atributo proguard_specs y se configuran proguard_generate_mapping o shrink_resources.

Ejemplos

Puedes encontrar ejemplos de reglas de Android en el directorio examples/android del árbol de fuentes de Bazel.

Argumentos

Atributos
name

Name; required

Un nombre único para este destino.

deps

List of labels; optional

Es la lista de otras bibliotecas que se vincularán al destino binario. Los tipos de bibliotecas permitidos son los siguientes: android_library, java_library con la restricción android y la unión de cc_library o la producción de bibliotecas nativas .so para la plataforma de destino de Android.
srcs

List of labels; optional

La lista de archivos de origen que se procesan para crear el destino.

Se compilan los archivos srcs de tipo .java. Para facilitar la lectura, no es recomendable poner el nombre de un archivo fuente .java generado en srcs. En su lugar, coloca el nombre de la regla dependiente en el srcs, como se describe a continuación.

Se descomprimen y compilan los archivos srcs de tipo .srcjar. (esto es útil si necesitas generar un conjunto de archivos .java con una extensión genrule o de compilación).

assets

List of labels; optional

La lista de elementos que se empaquetarán. Por lo general, es una glob de todos los archivos del directorio assets. También puedes hacer referencia a otras reglas (cualquier regla que genere archivos) o a archivos exportados en los otros paquetes, siempre que todos esos archivos estén en el directorio assets_dir del paquete correspondiente.
assets_dir

String; optional

Es la cadena que proporciona la ruta de acceso a los archivos en assets. El par assets y assets_dir describen los elementos empaquetados. Se deben proporcionar ambos atributos o ninguno.
crunch_png

Boolean; optional; default is True

Comprimir los PNG (o no) Esto es independiente del procesamiento de nine-patch, que siempre se hace. Esta es una solución alternativa obsoleta para un error aapt que se corrigió en aapt2.
custom_package

String; optional

Es el paquete Java para el que se generarán fuentes de Java. De forma predeterminada, el paquete se infiere del directorio en el que se encuentra el archivo BUILD que contiene la regla. Puedes especificar un paquete diferente, pero no es recomendable, ya que puede generar conflictos de ruta de clase con otras bibliotecas que solo se detectarán durante el tiempo de ejecución.
debug_key

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

Es un archivo que contiene el almacén de claves de depuración que se usará para firmar el APK de depuración. Generalmente, no es conveniente usar una clave distinta de la predeterminada, por lo que se debe omitir este atributo.

ADVERTENCIA: No uses tus claves de producción. Debes protegerlas estrictamente y no debes guardarlas en el árbol fuente.

debug_signing_keys

List of labels; optional

Lista de archivos y almacenes de claves de depuración que se usarán para firmar el APK de depuración. Por lo general, no es conveniente usar claves distintas de la predeterminada, por lo que se debe omitir este atributo.

ADVERTENCIA: No uses tus claves de producción. Debes protegerlas estrictamente y no debes guardarlas en el árbol fuente.

debug_signing_lineage_file

Label; optional

Archivo que contiene el linaje de firmas para debug_signing_keys. Por lo general, no es conveniente usar claves distintas de la predeterminada, por lo que se debe omitir este atributo.

ADVERTENCIA: No uses tus claves de producción. Debes protegerlas estrictamente y no debes guardarlas en el árbol fuente.

densities

List of strings; optional

Densidades que se filtrarán al compilar el APK. De esta manera, se quitarán los recursos de elementos de diseño de trama que no cargaría un dispositivo con las densidades de pantalla especificadas para reducir el tamaño del APK. También se agregará una sección compatible de pantallas compatibles al manifiesto si aún no contiene una lista de superconjunto.
dex_shards

Integer; optional; default is 1

Cantidad de fragmentos en los que se debe descomponer. Esto permite que la conversión a DEX sea mucho más rápida, a costa de la instalación de la app y el tiempo de inicio. Cuanto más grande sea el objeto binario, más fragmentos se deben usar. 25 es un buen valor para comenzar a experimentar.

Ten en cuenta que cada fragmento generará al menos un archivo DEX en la app final. Por este motivo, no se recomienda establecerlo en más de 1 para los objetos binarios de lanzamiento.

dexopts

List of strings; optional

Marcas de línea de comandos adicionales para la herramienta dx cuando se generan classes.dex. Sujeto a la sustitución "Make variable" y la tokenización de shell Bourne.
enable_data_binding

Boolean; optional; default is False

Si es verdadero, esta regla procesa expresiones de vinculación de datos en los recursos de diseño incluidos a través del atributo resource_files. Sin esta configuración, las expresiones de vinculación de datos producen errores de compilación.

Si deseas compilar una app para Android con vinculación de datos, también debes hacer lo siguiente:

  1. Establece este atributo para todas las reglas de Android que dependen de esta de forma transitiva. Esto se debe a que los dependencias heredan las expresiones de vinculación de datos de la regla mediante la combinación de recursos. Por lo tanto, también deben compilar con la vinculación de datos para analizar esas expresiones.
  2. Agrega una entrada deps = para la biblioteca del entorno de ejecución de vinculación de datos a todos los destinos que establecen este atributo. La ubicación de esta biblioteca depende de la configuración de tu depósito.
incremental_dexing

Integer; optional; nonconfigurable; default is -1

Fuerza la compilación del destino con o sin conversión a DEX incremental, lo que anula los valores predeterminados y la marca --incremental_dexing.
instruments

Label; optional

El objetivo android_binary que se instrumentará.

Si se configura este atributo, este android_binary se tratará como una aplicación de prueba para las pruebas de instrumentación. Un destino android_instrumentation_test puede especificar este destino en su atributo test_app.

javacopts

List of strings; optional

Opciones adicionales del compilador para este destino. Sujeto a la sustitución "Make variable" y la tokenización de shell Bourne.

Estas opciones del compilador se pasan a javac después de las opciones globales del compilador.

key_rotation_min_sdk

String; optional

Establece la versión mínima de la plataforma de Android (nivel de API) en la que se debe usar la clave de firma rotada de un APK para producir la firma del APK. La clave de firma original del APK se usará en todas las versiones anteriores de la plataforma.
main_dex_list

Label; optional

Un archivo de texto contiene una lista de nombres de archivos de clases. Las clases definidas por esos archivos de clase se colocan en el elemento classes.dex principal, p. ej.:
          android/support/multidex/MultiDex$V19.class
          android/support/multidex/MultiDex.class
          android/support/multidex/MultiDexApplication.class
          com/google/common/base/Objects.class
                    
Se debe usar con multidex="manual_main_dex".
main_dex_list_opts

List of strings; optional

Opciones de línea de comandos para pasar al compilador principal de listas dex. Usa esta opción para modificar las clases incluidas en la lista principal de DEX.
main_dex_proguard_specs

List of labels; optional

Archivos que se usarán como especificaciones de ProGuard para determinar las clases que deben mantenerse en el DEX principal. Solo se permite si el atributo multidex está configurado como legacy.
manifest

Label; required

Es el nombre del archivo de manifiesto de Android, que suele ser AndroidManifest.xml. Debe definirse si se definen archivos o recursos resource_files o los elementos.
manifest_values

Dictionary: String -> String; optional

Es un diccionario de valores que se anularán en el manifiesto. Cualquier instancia de ${name} en el manifiesto se reemplazará por el valor correspondiente al nombre en este diccionario. applicationId, versionCode, versionName, minSdkVersion, targetSdkVersion y maxSdkVersion también anularán los atributos correspondientes del manifiesto y las etiquetas uses-sdk. Se ignorará el valor packageName y se establecerá a partir de applicationId si se especifica o del paquete en el manifiesto. Cuando manifest_merger se establece como heredado, solo applicationId, versionCode y versionName tendrán efecto.
multidex

String; optional; default is "native"

Indica si se debe dividir el código en varios archivos dex.
Valores posibles:
  • native: Divide el código en varios archivos dex cuando se supera el límite del índice de 64K dex. Se supone que es compatible con la plataforma nativa para cargar clases de multidex durante el tiempo de ejecución. Solo funciona con Android L y versiones posteriores.
  • legacy: Divide el código en varios archivos dex cuando se supera el límite del índice de 64K dex. Supone que las clases multidex se cargan a través del código de la aplicación (es decir, no se admite la plataforma nativa).
  • manual_main_dex: Divide el código en varios archivos dex cuando se supera el límite del índice de 64K. Se debe especificar el contenido del archivo dex principal proporcionando una lista de clases en un archivo de texto mediante el atributo main_dex_list.
  • off: Compila todo el código en un solo archivo dex, incluso si supera el límite de índices.
nocompress_extensions

List of strings; optional

Una lista de extensiones de archivo que no se comprimen en el APK
package_id

Integer; optional; default is 0

Es el ID de paquete que se asignará a los recursos de este objeto binario.

Para obtener más información, consulta el argumento --package-id de AAPT2. Por lo general, esto puede (y se debe) no establecer, lo que da como resultado el valor predeterminado de 127 (0x7F).

plugins

List of labels; optional

Complementos del compilador de Java para ejecutar en el tiempo de compilación. Cada java_plugin especificado en el atributo de complementos se ejecutará cada vez que se compile este destino. Los recursos que genera el complemento se incluirán en el archivo jar de resultados del destino.
proguard_apply_dictionary

Label; optional

Es un archivo que se usará como asignación para ProGuard. Es un archivo de "palabras" separado por líneas para extraer cuando se cambia el nombre de las clases y los miembros durante la ofuscación.
proguard_apply_mapping

Label; optional

Es un archivo que se usará como asignación para ProGuard. Es un archivo de asignación que genera proguard_generate_mapping para que se vuelva a usar a fin de aplicar la misma asignación a una compilación nueva.
proguard_generate_mapping

Boolean; optional; nonconfigurable; default is False

Establece si se debe generar un archivo de asignación de ProGuard. El archivo de asignación solo se generará si se especifica proguard_specs. En este archivo, se mostrará la asignación entre los nombres de las clases, del método y de los campos originales y ofuscados.

ADVERTENCIA: Si se usa este atributo, la especificación de ProGuard no debería contener -dontobfuscate ni -printmapping.

proguard_specs

List of labels; optional

Archivos que se usarán como especificación de ProGuard. Este archivo describirá el conjunto de especificaciones que usará Proguard.
resource_configuration_filters

List of strings; optional

Una lista de filtros de configuración de recursos, como "en", que limitará los recursos en el APK solo a los que están en la configuración "en". Para habilitar la pseudolocalización, incluye las pseudoconfiguraciones regionales en_XA o ar_XB.
resource_files

List of labels; optional

La lista de recursos que se empaquetarán. Por lo general, es una glob de todos los archivos del directorio res.
Aquí también se puede hacer referencia a los archivos generados (desde genrules) mediante Etiqueta. La única restricción es que los resultados generados deben estar en el mismo directorio "res" que cualquier otro archivo de recursos incluido.
shrink_resources

Integer; optional; default is -1

Indica si se deben reducir los recursos. Se quitarán del APK los recursos que no use el objeto binario. Esto solo se admite para reglas que usan recursos locales (es decir, los atributos manifest y resource_files) y requiere ProGuard. Funciona casi de la misma manera que el reductor de recursos de Gradle (https://developer.android.com/studio/build/shrink-code.html#shrink-resources).

Diferencias destacadas:

  • Se quitarán los recursos en values/, así como los recursos basados en archivos.
  • usa strict mode de forma predeterminada
  • quitar recursos de ID sin usar solo se admite con aapt2
Si la reducción de recursos está habilitada, también se generará name_files/resource_shrinker.log, que detalla el análisis y las eliminaciones realizadas.

Valores posibles:

  • shrink_resources = 1: Activa la reducción de recursos de Android.
  • shrink_resources = 0: Desactiva la reducción de recursos de Android.
  • shrink_resources = -1: La reducción se controla a través de la marca --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)

Esta regla permite el uso de archivos .aar como bibliotecas para las reglas android_library y android_binary.

Ejemplos

    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"],
    )

Argumentos

Atributos
name

Name; required

Un nombre único para este destino.

aar

Label; required

Es el archivo .aar que se proporciona a los destinos de Android que dependen de él.
exports

List of labels; optional

Destinos para exportar a reglas que dependen de esta regla. Consulta java_library.exports.
srcjar

Label; optional

Un archivo JAR que contiene el código fuente para los archivos JAR compilados en el AAR.

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)

Esta regla compila y archiva sus fuentes en un archivo .jar. La biblioteca android.jar del tiempo de ejecución de Android se coloca implícitamente en la ruta de acceso de la clase de compilación.

Objetivos de salida implícitos

  • libname.jar: Es un archivo Java.
  • libname-src.jar: Es un archivo que contiene las fuentes ("jar de origen").
  • name.aar: Es un paquete "aar" de Android que contiene el archivo Java y los recursos de este destino. No contiene el cierre transitivo.

Ejemplos

Puedes encontrar ejemplos de reglas de Android en el directorio examples/android del árbol de fuentes de Bazel.

En el siguiente ejemplo, se muestra cómo configurar idl_import_root. Deja que //java/bazel/helloandroid/BUILD contenga lo siguiente:

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"],
)

Argumentos

Atributos
name

Name; required

Un nombre único para este destino.

deps

List of labels; optional

Es la lista de otras bibliotecas para vincular. Los tipos de bibliotecas permitidos son los siguientes: android_library, java_library con la restricción android y la unión de cc_library o la producción de bibliotecas nativas .so para la plataforma de destino de Android.
srcs

List of labels; optional

La lista de archivos .java o .srcjar que se procesan para crear el destino.

Se compilan los archivos srcs de tipo .java. Para facilitar la lectura, no es recomendable poner el nombre de un archivo fuente .java generado en srcs. En su lugar, coloca el nombre de la regla dependiente en el srcs, como se describe a continuación.

Se descomprimen y compilan los archivos srcs de tipo .srcjar. (esto es útil si necesitas generar un conjunto de archivos .java con una extensión genrule o de compilación).

Si se omite srcs, cualquier dependencia especificada en deps se exporta desde esta regla (consulta las exportaciones de java_library para obtener más información sobre la exportación de dependencias). Sin embargo, este comportamiento dejará de estar disponible pronto; intenta no confiar en él.

assets

List of labels; optional

La lista de elementos que se empaquetarán. Por lo general, es una glob de todos los archivos del directorio assets. También puedes hacer referencia a otras reglas (cualquier regla que genere archivos) o a archivos exportados en los otros paquetes, siempre que todos esos archivos estén en el directorio assets_dir del paquete correspondiente.
assets_dir

String; optional

Es la cadena que proporciona la ruta de acceso a los archivos en assets. El par assets y assets_dir describen los elementos empaquetados. Se deben proporcionar ambos atributos o ninguno.
custom_package

String; optional

Es el paquete Java para el que se generarán fuentes de Java. De forma predeterminada, el paquete se infiere del directorio en el que se encuentra el archivo BUILD que contiene la regla. Puedes especificar un paquete diferente, pero no es recomendable, ya que puede generar conflictos de ruta de clase con otras bibliotecas que solo se detectarán durante el tiempo de ejecución.
enable_data_binding

Boolean; optional; default is False

Si es verdadero, esta regla procesa expresiones de vinculación de datos en los recursos de diseño incluidos a través del atributo resource_files. Sin esta configuración, las expresiones de vinculación de datos producen errores de compilación.

Si deseas compilar una app para Android con vinculación de datos, también debes hacer lo siguiente:

  1. Establece este atributo para todas las reglas de Android que dependen de esta de forma transitiva. Esto se debe a que los dependencias heredan las expresiones de vinculación de datos de la regla mediante la combinación de recursos. Por lo tanto, también deben compilar con la vinculación de datos para analizar esas expresiones.
  2. Agrega una entrada deps = para la biblioteca del entorno de ejecución de vinculación de datos a todos los destinos que establecen este atributo. La ubicación de esta biblioteca depende de la configuración de tu depósito.
exported_plugins

List of labels; optional

Es la lista de java_plugin (p.ej., procesadores de anotaciones) para exportar a bibliotecas que dependen directamente de esta biblioteca.

La lista especificada de java_plugin se aplicará a cualquier biblioteca que dependa directamente de esta biblioteca, como si la biblioteca hubiera declarado explícitamente estas etiquetas en plugins.

exports

List of labels; optional

El cierre de todas las reglas a las que se llega mediante los atributos exports se considera dependencias directas de cualquier regla que dependa directamente del destino con exports.

Los exports no son dependencias directas de la regla a la que pertenecen.

exports_manifest

Integer; optional; default is 1

Indica si se deben exportar entradas de manifiesto a objetivos android_binary que dependen de este destino. Los atributos uses-permissions nunca se exportan.
idl_import_root

String; optional

Ruta relativa de paquete a la raíz del árbol de paquetes de Java que contiene fuentes inactivas incluidas en esta biblioteca.

Esta ruta se usará como la raíz de importación cuando se procesen fuentes inactivas que dependan de esta biblioteca.

Cuando se especifica idl_import_root, idl_parcelables y idl_srcs deben estar en la ruta especificada por el paquete Java del objeto que representan en idl_import_root. Cuando no se especifica idl_import_root, idl_parcelables y idl_srcs deben encontrarse en la ruta de acceso especificada por su paquete en una raíz de Java.

Consulta los ejemplos.

idl_parcelables

List of labels; optional

Lista de definiciones de IDL de Android para proporcionar como importaciones. Estos archivos estarán disponibles como importaciones para cualquier destino android_library que dependa de esta biblioteca, directamente o a través de su cierre transitivo, pero no se traducirán a Java ni se compilarán.

Solo se deben incluir los archivos .aidl que correspondan directamente a las fuentes .java en esta biblioteca (p.ej., implementaciones personalizadas de Parcelable); de lo contrario, se debe usar idl_srcs.

Estos archivos deben ubicarse de manera correcta para que el compilador Aidl los encuentre. Consulta la descripción de idl_import_root para obtener información sobre lo que esto significa.

idl_preprocessed

List of labels; optional

Lista de definiciones de IDL de Android procesadas previamente para proporcionar como importaciones. Estos archivos estarán disponibles como importaciones para cualquier destino android_library que dependa de esta biblioteca, directamente o a través de su cierre transitivo, pero no se traducirán a Java ni se compilarán.

Solo se deben incluir los archivos .aidl preprocesados que correspondan directamente a fuentes .java en esta biblioteca (p. ej., implementaciones personalizadas de Parcelable). De lo contrario, usa idl_srcs para las definiciones de IDL de Android que deban traducirse a interfaces Java y usa idl_parcelable para los archivos AIDL no procesados.

idl_srcs

List of labels; optional

Lista de definiciones de IDL de Android para traducir a interfaces de Java. Después de que se generen las interfaces de Java, se compilarán junto con el contenido de srcs.

Estos archivos estarán disponibles como importaciones para cualquier destino android_library que dependa de esta biblioteca, directamente o mediante su cierre transitivo.

Estos archivos deben ubicarse de manera correcta para que el compilador Aidl los encuentre. Consulta la descripción de idl_import_root para obtener información sobre lo que esto significa.

javacopts

List of strings; optional

Opciones adicionales del compilador para este destino. Sujeto a la sustitución "Make variable" y la tokenización de shell Bourne.

Estas opciones del compilador se pasan a javac después de las opciones globales del compilador.

manifest

Label; optional

Es el nombre del archivo de manifiesto de Android, que suele ser AndroidManifest.xml. Debe definirse si se definen archivos o recursos resource_files o los elementos.

Boolean; optional; default is False

Solo usa esta biblioteca para la compilación y no durante el tiempo de ejecución. Los resultados de una regla marcada como neverlink no se usarán en la creación de .apk. Es útil si el entorno de ejecución proporciona la biblioteca durante la ejecución.
plugins

List of labels; optional

Complementos del compilador de Java para ejecutar en el tiempo de compilación. Cada java_plugin especificado en el atributo de complementos se ejecutará cada vez que se compile este destino. Los recursos que genera el complemento se incluirán en el archivo jar de resultados del destino.
proguard_specs

List of labels; optional

Archivos que se usarán como especificación de ProGuard. Estos describirán el conjunto de especificaciones que ProGuard usará. Si se especifican, se agregarán a cualquier destino android_binary según esta biblioteca. Los archivos que se incluyen aquí solo deben tener reglas idempotentes, es decir, -dontnote, -dontwarn, asunción de efectos secundarios y reglas que comienzan con -keep. Otras opciones solo pueden aparecer en proguard_specs de android_binary para garantizar combinaciones no tautológicas.
resource_files

List of labels; optional

La lista de recursos que se empaquetarán. Por lo general, es una glob de todos los archivos del directorio res.
Aquí también se puede hacer referencia a los archivos generados (desde genrules) mediante Etiqueta. La única restricción es que los resultados generados deben estar en el mismo directorio "res" que cualquier otro archivo de recursos incluido.

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)

Una regla android_instrumentation_test ejecuta pruebas de instrumentación de Android. Este iniciará un emulador, instalará la aplicación que se está probando, la aplicación de prueba y cualquier otra aplicación necesaria, y ejecutará las pruebas definidas en el paquete de pruebas.

El atributo test_app especifica el android_binary que contiene la prueba. Este android_binary, a su vez, especifica la aplicación android_binary que se está probando a través del atributo instruments.

Ejemplo

# 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",
)

Argumentos

Atributos
name

Name; required

Un nombre único para este destino.

support_apks

List of labels; optional

Otros APK que se deben instalar en el dispositivo antes de que comience la prueba de instrumentación.
target_device

Label; required

El android_device en el que se debe ejecutar la prueba

Para ejecutar la prueba en un emulador que ya se está ejecutando o en un dispositivo físico, usa estos argumentos: --test_output=streamed --test_arg=--device_broker_type=LOCAL_ADB_SERVER --test_arg=--device_serial_number=$device_identifier

test_app

Label; required

La orientación android_binary que contiene las clases de prueba. El destino android_binary debe especificar qué objetivo se está probando a través del atributo 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)

Esta regla sirve para probar las reglas android_library de forma local (en lugar de hacerlo en un dispositivo). Funciona con el framework de prueba de Android Robolectric. Consulta el sitio de Android Robolectric para obtener detalles sobre cómo escribir pruebas de Robolectric.

Objetivos de salida implícitos

  • name.jar: Es un archivo Java de la prueba.
  • name-src.jar: Es un archivo que contiene las fuentes ("jar fuente").
  • name_deploy.jar: Es un archivo de implementación de Java adecuado para la implementación (solo se compila si se solicita de forma explícita).

Ejemplos

Para usar Robolectric con android_local_test, agrega el repositorio de Robolectric a tu archivo 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()
. De esta manera, se extraen las reglas maven_jar necesarias para Robolectric. Luego, cada regla android_local_test debe depender de @robolectric//bazel:robolectric. Consulta el siguiente ejemplo.

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",
)

Argumentos

Atributos
name

Name; required

Un nombre único para este destino.

deps

List of labels; optional

La lista de bibliotecas que se probarán y las bibliotecas adicionales que se vincularán al destino. Todos los recursos, elementos y archivos de manifiesto declarados en las reglas de Android en el cierre transitivo de este atributo estarán disponibles en la prueba.

La lista de reglas permitidas en deps es android_library, aar_import, java_import, java_library y java_lite_proto_library.

srcs

List of labels; optional

La lista de archivos de origen que se procesan para crear el destino. Obligatorio, excepto en el caso especial descrito a continuación.

Se compilan los archivos srcs de tipo .java. Para facilitar la lectura, no es recomendable poner el nombre de un archivo fuente .java generado en srcs. En su lugar, coloca el nombre de la regla dependiente en el srcs, como se describe a continuación.

Se descomprimen y compilan los archivos srcs de tipo .srcjar. (esto es útil si necesitas generar un conjunto de archivos .java con una extensión genrule o de compilación).

Se ignorarán todos los demás archivos, siempre que haya al menos un archivo de un tipo de archivo descrito anteriormente. De lo contrario, se genera un error.

El atributo srcs es obligatorio y no puede estar vacío, a menos que se especifique runtime_deps.

custom_package

String; optional

Paquete Java en el que se generará la clase R. De forma predeterminada, el paquete se infiere del directorio en el que se encuentra el archivo BUILD que contiene la regla. Si usas este atributo, es probable que también debas usar test_class.
densities

List of strings; optional

Densidades que se filtrarán al compilar el APK. También se agregará al manifiesto una sección compatible de pantallas correspondiente si esta todavía no contiene un StarlarkListing de superconjunto.
enable_data_binding

Boolean; optional; default is False

Si es verdadero, esta regla procesa las referencias de vinculación de datos que se usan en las dependencias habilitadas para la vinculación de datos que utiliza esta prueba. Sin esta configuración, las dependencias de vinculación de datos no tendrán la generación de código de nivel binario necesaria, y es posible que produzcan fallas de compilación.
javacopts

List of strings; optional

Opciones adicionales del compilador para esta biblioteca. Sujeto a la sustitución "Make variable" y la tokenización de shell Bourne.

Estas opciones del compilador se pasan a javac después de las opciones globales del compilador.

jvm_flags

List of strings; optional

Una lista de marcas para incorporar en la secuencia de comandos del wrapper generada para ejecutar este objeto binario. Sujeto a la sustitución $(location) y "Make variable", y a la tokenización de la shell Bourne.

La secuencia de comandos del wrapper para un objeto binario Java incluye una definición CLASSPATH (para encontrar todos los archivos jar dependientes) y, luego, invoca el intérprete de Java correcto. La línea de comandos que genera la secuencia de comandos del wrapper incluye el nombre de la clase principal seguido de un "$@" para que puedas pasar otros argumentos después del nombre de clase. Sin embargo, los argumentos destinados al análisis mediante JVM deben especificarse antes del nombre de clase en la línea de comandos. El contenido de jvm_flags se agrega a la secuencia de comandos del wrapper antes de que se muestre el nombre de clase.

Ten en cuenta que este atributo no tiene efecto en los resultados de *_deploy.jar.

manifest

Label; optional

Es el nombre del archivo de manifiesto de Android, que suele ser AndroidManifest.xml. Debe definirse si se definen los recursos o archivos_resource, o si alguno de los manifiestos de las bibliotecas evaluadas tiene una etiqueta minSdkVersion.
manifest_values

Dictionary: String -> String; optional

Es un diccionario de valores que se anularán en el manifiesto. Cualquier instancia de ${name} en el manifiesto se reemplazará por el valor correspondiente al nombre en este diccionario. applicationId, versionCode, versionName, minSdkVersion, targetSdkVersion y maxSdkVersion también anularán los atributos correspondientes del manifiesto y las etiquetas uses-sdk. Se ignorará packageName y se establecerá desde applicationId si se especifica o desde el paquete en el manifiesto. No es necesario tener un manifiesto en la regla para usar manifest_values.
nocompress_extensions

List of strings; optional

Una lista de extensiones de archivo que no se deben comprimir en el APK del recurso.
plugins

List of labels; optional

Complementos del compilador de Java para ejecutar en el tiempo de compilación. Cada java_plugin especificado en este atributo se ejecutará cuando se cree esta regla. Una biblioteca también puede heredar complementos de dependencias que usan exported_plugins. Los recursos generados por el complemento se incluirán en el archivo jar resultante de esta regla.
resource_configuration_filters

List of strings; optional

Una lista de filtros de configuración de recursos, como "en", que limitarán los recursos en el APK solo a los de la configuración "en".
resource_jars

List of labels; optional

Obsoleto: En su lugar, usa java_import y deps o runtime_deps.
resource_strip_prefix

String; optional

Prefijo de la ruta de acceso que se quitará de los recursos de Java.

Si se especifica, este prefijo de ruta de acceso se quita de todos los archivos en el atributo resources. Es un error que un archivo de recursos no se encuentre en este directorio. Si no se especifica (opción predeterminada), la ruta de acceso al archivo de recursos se determina de acuerdo con la misma lógica que el paquete Java de los archivos de origen. Por ejemplo, un archivo de origen en stuff/java/foo/bar/a.txt se ubicará en foo/bar/a.txt.

runtime_deps

List of labels; optional

Bibliotecas que estarán disponibles para el objeto binario final o la prueba solo durante el tiempo de ejecución. Al igual que los deps comunes, estos aparecerán en la ruta de clase de tiempo de ejecución, pero, a diferencia de ellos, no en la ruta de clase de tiempo de compilación. Aquí se deben enumerar las dependencias que solo se necesitan en el entorno de ejecución. Las herramientas de análisis de dependencias deben ignorar los objetivos que aparecen en runtime_deps y deps.
stamp

Integer; optional; default is 0

Indica si se debe codificar la información de compilación en el objeto binario. Valores posibles:
  • stamp = 1: Siempre marca la información de compilación en el objeto binario, incluso en compilaciones de --nostamp. Esta configuración debe evitarse, ya que podría finalizar el almacenamiento en caché remoto del objeto binario y todas las acciones descendentes que dependen de él.
  • stamp = 0: Siempre reemplaza la información de compilación por valores constantes. Esto proporciona un buen almacenamiento en caché de resultados de compilación.
  • stamp = -1: La marca --[no]stamp controla la incorporación de la información de compilación.

Los objetos binarios sellados no se vuelven a compilar, a menos que cambien sus dependencias.

test_class

String; optional

Es la clase Java que cargará el ejecutor de pruebas.

Este atributo especifica el nombre de una clase de Java que ejecutará esta prueba. Es raro que se necesite configurar esto. Si se omite este argumento, se usará la clase Java cuyo nombre corresponda al name de esta regla android_local_test. La clase de prueba debe tener anotaciones con org.junit.runner.RunWith.

use_launcher

Boolean; optional; default is True

Indica si el objeto binario debe usar un selector personalizado.

Si este atributo se establece como falso, se ignorarán el atributo del selector y la marca --java_launcher relacionada para este destino.

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)

Esta regla crea un emulador de Android configurado con las especificaciones determinadas. Este emulador se puede iniciar con un comando de ejecución de Bazel o la ejecución directa de la secuencia de comandos generada. Te recomendamos que dependas de las reglas existentes de android_device en lugar de definir las tuyas.

Esta regla es un objetivo adecuado para la marca --run_under en la prueba de Bazel y la ejecución blaze. Inicia un emulador, copia el destino que se está probando o ejecutando en el emulador, y lo prueba o lo ejecuta según corresponda.

android_device admite la creación de imágenes de KVM si la system_image subyacente se basa en X86 y está optimizada como máximo para la arquitectura de CPU I686. Para usar KVM, agrega tags = ['requires-kvm'] a la regla android_device.

Objetivos de salida implícitos

  • name_images/userdata.dat: Contiene instantáneas y archivos de imagen para iniciar el emulador.
  • name_images/emulator-meta-data.pb: Contiene información serializada necesaria para pasarlo al emulador a fin de reiniciarlo.

Ejemplos

En el siguiente ejemplo, se muestra cómo usar android_device. //java/android/helloandroid/BUILD contiene

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 contiene:

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

Esta regla generará imágenes y una secuencia de comandos de inicio. Puedes iniciar el emulador de forma local si ejecutas bazel run :nexus_s -- --action=start. La secuencia de comandos expone las siguientes marcas:

  • --adb_port: Es el puerto en el que se expondrá adb. Si deseas emitir comandos adb al emulador, este es el puerto al que emitirás la conexión de adb.
  • --emulator_port: es el puerto en el que se expondrá la consola de administración telnet del emulador.
  • --enable_display: Inicia el emulador con una pantalla si es verdadero (el valor predeterminado es falso).
  • --action: iniciar o eliminar.
  • --apks_to_install: lista de APK para instalar en el emulador.

Argumentos

Atributos
name

Name; required

Un nombre único para este destino.

cache

Integer; required

Es el tamaño en megabytes de la partición de caché del emulador. El valor mínimo es de 16 megabytes.
default_properties

Label; optional

Un único archivo de propiedades que se colocará en /default.prop en el emulador. Esto permite que el autor de la regla configure aún más el emulador para que parezca un dispositivo real (en particular, controla sus strings de UserAgent y otros comportamientos que podrían provocar que una aplicación o un servidor se comporten de forma diferente respecto de un dispositivo específico). Las propiedades en este archivo anularán las propiedades de solo lectura que normalmente configura el emulador, como ro.product.model.
horizontal_resolution

Integer; required

Es la resolución horizontal de la pantalla en píxeles que se emulará. El valor mínimo es 240.
platform_apks

List of labels; optional

Es una lista de los APK que se instalarán en el dispositivo al momento del inicio.
ram

Integer; required

Es la cantidad de RAM en megabytes que se emulará para el dispositivo. Esto es para todo el dispositivo, no solo para una app específica instalada en él. El valor mínimo es 64 megabytes.
screen_density

Integer; required

Es la densidad de la pantalla emulada en píxeles por pulgada. El valor mínimo es 30 ppp.
system_image

Label; required

Un grupo de archivos que contiene los siguientes archivos:
  • system.img: La partición del sistema
  • kernel-qemu: Es el kernel de Linux que cargará el emulador.
  • ramdisk.img: La imagen initrd que se usará en el momento del inicio
  • userdata.img: Es la partición inicial de userdata.
  • source.properties: un archivo de propiedades que contiene información sobre las imágenes.
Estos archivos forman parte del SDK de Android o los proporcionan terceros (por ejemplo, Intel proporciona imágenes x86).
vertical_resolution

Integer; required

Es la resolución de pantalla vertical en píxeles que se emulará. El valor mínimo es 240.
vm_heap

Integer; required

Es el tamaño en megabytes del montón de máquinas virtuales que usará Android para cada proceso. El valor mínimo es 16 megabytes.

android_ndk_repository

android_ndk_repository(name, api_level, path, repo_mapping)

Configura Bazel para usar un NDK de Android a fin de admitir la compilación de destinos de Android con código nativo.

Ten en cuenta que compilar para Android también requiere una regla android_sdk_repository en el archivo WORKSPACE.

Para obtener más información, consulta la documentación completa sobre el uso del NDK de Android con Bazel.

Ejemplos

android_ndk_repository(
    name = "androidndk",
)

En el ejemplo anterior, se ubicará tu NDK de Android desde $ANDROID_NDK_HOME y se detectará el nivel de API más alto que admita.

android_ndk_repository(
    name = "androidndk",
    path = "./android-ndk-r20",
    api_level = 24,
)

En el ejemplo anterior, se usará el NDK de Android ubicado dentro de tu lugar de trabajo en ./android-ndk-r20. Utilizará las bibliotecas de nivel de API 24 cuando compile tu código JNI.

cpufeatures

El NDK de Android contiene la biblioteca de cpufeatures que se puede usar para detectar la CPU de un dispositivo en el tiempo de ejecución. En el siguiente ejemplo, se muestra cómo usar cpufeatures con Bazel.

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

Argumentos

Atributos
name

Name; required

Un nombre único para este destino.

api_level

Integer; optional; nonconfigurable; default is 0

El nivel de API de Android con el que se compilará. Si no se especifica, se usará el nivel de API más alto instalado.
path

String; optional; nonconfigurable

Es una ruta de acceso absoluta o relativa a un NDK de Android. Se debe configurar este atributo o la variable de entorno $ANDROID_NDK_HOME.

Puedes descargar el NDK de Android desde el sitio para desarrolladores de Android .

repo_mapping

Dictionary: String -> String; optional

Un diccionario que va desde el nombre del repositorio local hasta el nombre del repositorio global. Esto permite controles sobre la resolución de dependencias del lugar de trabajo para las dependencias de este repositorio.

Por ejemplo, una entrada "@foo": "@bar" declara que, para cada momento, este repositorio depende de "@foo" (como una dependencia de "@foo//some:target"), en realidad, debe resolver esa dependencia dentro de "@bar" declarado globalmente ("@bar//some:target").

android_sdk_repository

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

Configura Bazel para usar un SDK de Android local y admitir la compilación de destinos de Android.

Ejemplos

El mínimo para configurar un SDK de Android para Bazel es incluir una regla android_sdk_repository llamada "androidsdk" en el archivo WORKSPACE y establecer la variable de entorno $ANDROID_HOME en la ruta del SDK de Android. De forma predeterminada, Bazel usará el nivel de API de Android más alto y la versión de herramientas de compilación instaladas en el SDK de Android de forma predeterminada.
android_sdk_repository(
    name = "androidsdk",
)

Para garantizar compilaciones reproducibles, los atributos path, api_level y build_tools_version se pueden establecer en valores específicos. La compilación fallará si el SDK de Android no tiene instalada el nivel de API especificado o la versión de herramientas de compilación.

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

En el ejemplo anterior, también se muestra el uso de una ruta relativa al lugar de trabajo al SDK de Android. Esto es útil si el SDK de Android forma parte de tu lugar de trabajo de Bazel (p.ej., si se registra en el control de versión).

Bibliotecas de compatibilidad

Las bibliotecas de compatibilidad están disponibles en Android SDK Manager como "Repositorio de compatibilidad de Android". Este es un conjunto con versión de bibliotecas comunes de Android, como las bibliotecas de compatibilidad y AppCompat, que se empaqueta como un repositorio Maven local. android_sdk_repository genera destinos de Bazel para cada una de estas bibliotecas que se pueden usar en las dependencias de los destinos android_binary y android_library.

Los nombres de los destinos generados derivan de las coordenadas de Maven de las bibliotecas del Repositorio de compatibilidad de Android, con el formato @androidsdk//${group}:${artifact}-${version}. En el siguiente ejemplo, se muestra cómo un android_library puede depender de la versión 25.0.0 de la biblioteca appcompat versión 7.

android_library(
    name = "lib",
    srcs = glob(["*.java"]),
    manifest = "AndroidManifest.xml",
    resource_files = glob(["res/**"]),
    deps = ["@androidsdk//com.android.support:appcompat-v7-25.0.0"],
)

Argumentos

Atributos
name

Name; required

Un nombre único para este destino.

api_level

Integer; optional; nonconfigurable; default is 0

Nivel de API de Android con el que se compilará de forma predeterminada. Si no se especifica, se usará el nivel de API más alto instalado.

La marca android_sdk puede anular el nivel de API que se usa para una compilación determinada. android_sdk_repository crea un destino android_sdk para cada nivel de API instalado en el SDK con el nombre @androidsdk//:sdk-${level}, sin importar si se especifica o no este atributo. Por ejemplo, para compilar en un nivel de API no predeterminado: bazel build --android_sdk=@androidsdk//:sdk-19 //java/com/example:app.

Para ver todos los destinos android_sdk generados por android_sdk_repository , puedes ejecutar bazel query "kind(android_sdk, @androidsdk//...)".

build_tools_version

String; optional; nonconfigurable

Es la versión de las herramientas de compilación de Android que se usará desde el SDK de Android. Si no se especifica, se usará la última versión instalada de las herramientas de compilación.

Bazel requiere la versión 30.0.0 o una posterior de las herramientas de compilación.

path

String; optional; nonconfigurable

Una ruta de acceso absoluta o relativa a un SDK de Android. Se debe configurar este atributo o la variable de entorno $ANDROID_HOME.

Puedes descargar el SDK de Android desde el sitio para desarrolladores de Android.

repo_mapping

Dictionary: String -> String; optional

Un diccionario que va desde el nombre del repositorio local hasta el nombre del repositorio global. Esto permite controles sobre la resolución de dependencias del lugar de trabajo para las dependencias de este repositorio.

Por ejemplo, una entrada "@foo": "@bar" declara que, para cada momento, este repositorio depende de "@foo" (como una dependencia de "@foo//some:target"), en realidad, debe resolver esa dependencia dentro de "@bar" declarado globalmente ("@bar//some:target").