Regras do Android

Regras

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)

Produz arquivos de pacotes de aplicativos Android (.apk).

Destinos de saída implícitos

  • name.apk: um arquivo de pacote de app Android assinado com chaves de depuração e zipaligned. Ele pode ser usado para desenvolver e depurar seu app. Não é possível lançar seu aplicativo quando assinado com as chaves de depuração.
  • name_unsigned.apk: uma versão não assinada do arquivo acima que pode ser assinada com as chaves de lançamento antes de ser lançada para o público.
  • name_deploy.jar: um arquivo Java que contém o fechamento transitivo desse destino.

    O jar de implantação contém todas as classes que seriam encontradas por um carregador de classe que pesquisou o caminho de classe do ambiente de execução desse destino do início ao fim.

  • name_proguard.jar: um arquivo Java que contém o resultado da execução do ProGuard no name_deploy.jar. Essa saída só será produzida se o atributo proguard_specs for especificado.
  • name_proguard.map: um resultado do arquivo de mapeamento da execução do ProGuard no name_deploy.jar. Essa saída só vai ser produzida se o atributo proguard_specs for especificado e proguard_generate_mapping ou shrink_resources.

Exemplos

Exemplos de regras do Android podem ser encontrados no diretório examples/android da árvore de origem do Bazel.

Argumentos

Atributos
name

Name; required

Um nome exclusivo para o destino.

deps

List of labels; optional

A lista de outras bibliotecas a serem vinculadas ao destino binário. Os tipos de biblioteca permitidos são: android_library, java_library com restrição android e cc_library encapsulando ou produzindo .so bibliotecas nativas para a plataforma de destino do Android.
srcs

List of labels; optional

A lista de arquivos de origem que são processados para criar o destino.

Arquivos srcs do tipo .java são compilados. Para facilitar a leitura, não é recomendável colocar o nome de um arquivo de origem .java gerado em srcs. Em vez disso, coloque o nome da regra dependente no srcs, conforme descrito abaixo.

Arquivos srcs do tipo .srcjar são descompactados e compilados. Isso é útil se você precisar gerar um conjunto de arquivos .java com uma genrule ou extensão de build.

assets

List of labels; optional

A lista de recursos a serem empacotados. Geralmente, é um glob de todos os arquivos no diretório assets. Também é possível referenciar outras regras (qualquer regra que produza arquivos) ou arquivos exportados em outros pacotes, desde que todos esses arquivos estejam no diretório assets_dir no pacote correspondente.
assets_dir

String; optional

A string que fornece o caminho para os arquivos em assets. O par assets e assets_dir descrevem recursos empacotados e ambos os atributos precisam ser fornecidos ou nenhum deles.
crunch_png

Boolean; optional; default is True

Processar PNG (ou não). Isso é independente do processamento de Nine-Patch, que é sempre feito. Essa é uma solução alternativa descontinuada para um bug do aapt (link em inglês), que foi corrigido no aapt2.
custom_package

String; optional

Pacote Java para o qual as origens java serão geradas. Por padrão, o pacote é inferido do diretório em que está o arquivo BUILD que contém a regra. É possível especificar um pacote diferente, mas isso não é recomendado porque ele pode introduzir conflitos de caminho de classe com outras bibliotecas que só serão detectadas no momento da execução.
debug_key

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

Arquivo que contém o keystore de depuração a ser usado para assinar o APK de depuração. Normalmente, não convém usar uma chave diferente da chave padrão, portanto, esse atributo deve ser omitido.

AVISO: não use suas chaves de produção. Elas precisam ser estritamente protegidas e não podem ser mantidas na árvore de origem.

debug_signing_keys

List of labels; optional

Lista de arquivos, keystores de depuração a serem usados para assinar o APK de depuração. Normalmente, não é recomendável usar chaves diferentes da chave padrão, por isso esse atributo precisa ser omitido.

AVISO: não use suas chaves de produção. Elas precisam ser estritamente protegidas e não podem ser mantidas na árvore de origem.

debug_signing_lineage_file

Label; optional

Arquivo que contém a linhagem de assinatura das debug_signing_keys. Normalmente, não é recomendável usar chaves diferentes da chave padrão, por isso esse atributo precisa ser omitido.

AVISO: não use suas chaves de produção. Elas precisam ser estritamente protegidas e não podem ser mantidas na árvore de origem.

densities

List of strings; optional

Densidades a serem filtradas ao criar o APK. Isso removerá os recursos drawable rasterizados que não seriam carregados por um dispositivo com as densidades de tela especificadas para reduzir o tamanho do APK. Uma seção de telas compatíveis correspondente também será adicionada ao manifesto se ele ainda não tiver uma listagem de superconjuntos.
dex_shards

Integer; optional; default is 1

O número de fragmentos em que a dexação precisa ser decomposta. Isso torna a dexação muito mais rápida em detrimento do tempo de instalação e inicialização do app. Quanto maior o binário, mais fragmentos precisam ser usados. 25 é um bom valor para começar a testar.

Cada fragmento resultará em pelo menos um dex no app final. Por esse motivo, não é recomendável definir esse valor como mais de 1 para binários de lançamento.

dexopts

List of strings; optional

Sinalizações de linha de comando adicionais para a ferramenta dx ao gerar classes.dex. Sujeito à substituição "Make variables" e tokenização do shell Bourne.
enable_data_binding

Boolean; optional; default is False

Se verdadeira, essa regra processará expressões de vinculação de dados em recursos de layout incluídos pelo atributo resource_files. Sem essa configuração, as expressões de vinculação de dados produzem falhas de build.

Para criar um app Android com vinculação de dados, também é necessário fazer o seguinte:

  1. Defina esse atributo para todas as regras do Android que dependem temporariamente desse atributo. Isso ocorre porque os dependências herdam as expressões de vinculação de dados da regra por meio da mesclagem de recursos. Portanto, elas também precisam criar com vinculação de dados para analisar essas expressões.
  2. Adicione uma entrada deps = para a biblioteca de execução de vinculação de dados a todos os destinos que definem esse atributo. O local dessa biblioteca depende da configuração do depósito.
incremental_dexing

Integer; optional; nonconfigurable; default is -1

Força o destino a ser criado com ou sem dexação incremental, substituindo padrões e a sinalização --incremental_dexing.
instruments

Label; optional

O objetivo android_binary a ser instrumentado.

Se o atributo for definido, o android_binary vai ser tratado como um aplicativo para testes de instrumentação. Um destino android_instrumentation_test pode especificar esse destino no atributo test_app.

javacopts

List of strings; optional

Opções extras do compilador para esse destino. Sujeito à substituição "Make variables" e tokenização do shell Bourne.

Essas opções do compilador são transmitidas para javac depois das opções do compilador global

key_rotation_min_sdk

String; optional

Define a versão mínima da Plataforma Android (nível da API) em que a chave de assinatura alternada de um APK precisa ser usada para produzir a assinatura do APK. A chave de assinatura original do APK será usada em todas as versões anteriores da plataforma.
main_dex_list

Label; optional

Um arquivo de texto contém uma lista de nomes de arquivo de classe. As classes definidas por esses arquivos de classe são colocadas em classes.dex primárias. Por exemplo:
          android/support/multidex/MultiDex$V19.class
          android/support/multidex/MultiDex.class
          android/support/multidex/MultiDexApplication.class
          com/google/common/base/Objects.class
                    
Precisa ser usado com multidex="manual_main_dex".
main_dex_list_opts

List of strings; optional

Opções de linha de comando a serem transmitidas para o criador de lista de dex principal. Use essa opção para afetar as classes incluídas na lista de dex principal.
main_dex_proguard_specs

List of labels; optional

Arquivos a serem usados como especificações do Proguard para determinar as classes que precisam ser mantidas no dex principal. Permitido apenas se o atributo multidex estiver definido como legacy.
manifest

Label; required

É o nome do arquivo de manifesto do Android, normalmente AndroidManifest.xml. Precisa ser definido se resource_files ou recursos estiverem definidos.
manifest_values

Dictionary: String -> String; optional

Um dicionário de valores a serem substituídos no manifesto. Qualquer instância de ${name} no manifesto será substituída pelo valor correspondente ao nome neste dicionário. applicationId, versionCode, versionName, minSdkVersion, targetSdkVersion e maxSdkVersion vão modificar os atributos correspondentes do manifesto e as tags uses-sdk. O packageName será ignorado e será definido no applicationId, se especificado, ou no pacote no manifesto. Quando manifest_merger é definido como legado, apenas applicationId, versionCode e versionName terão efeito.
multidex

String; optional; default is "native"

Define se o código será dividido em vários arquivos dex.
Valores possíveis:
  • native: divide o código em vários arquivos dex quando o limite de índice de dex 64.000 é excedido. Supõe suporte à plataforma nativa para carregar classes multidex no momento da execução. Esse recurso funciona apenas com o Android L e versões mais recentes.
  • legacy: divide o código em vários arquivos dex quando o limite de índice de dex 64.000 é excedido. Pressupõe que classes multidex são carregadas por meio do código do aplicativo (ou seja, sem suporte à plataforma nativa).
  • manual_main_dex: divide o código em vários arquivos dex quando o limite de índice de dex 64.000 é excedido. O conteúdo do arquivo dex principal precisa ser especificado fornecendo uma lista de classes em um arquivo de texto usando o atributo main_dex_list.
  • off: compila todo o código em um único arquivo dex, mesmo que ele exceda o limite do índice.
nocompress_extensions

List of strings; optional

Uma lista de extensões de arquivo para deixar descompactada no APK.
package_id

Integer; optional; default is 0

ID do pacote a ser atribuído aos recursos neste binário.

Consulte o argumento --package-id do AAPT2 para mais informações. Isso pode (e deve) normalmente não ser definido, resultando no valor padrão de 127 (0x7F).

plugins

List of labels; optional

Plug-ins do compilador Java para execução em tempo de compilação. Cada java_plugin especificado no atributo de plug-ins será executado sempre que esse destino for criado. Os recursos gerados pelo plug-in serão incluídos no jar de resultado do destino.
proguard_apply_dictionary

Label; optional

Arquivo a ser usado como mapeamento para o ProGuard. Um arquivo de "palavras" separado por linha para extrair ao renomear classes e membros durante a ofuscação.
proguard_apply_mapping

Label; optional

Arquivo a ser usado como mapeamento para o ProGuard. Um arquivo de mapeamento gerado por proguard_generate_mapping a ser reutilizado para aplicar o mesmo mapeamento a um novo build.
proguard_generate_mapping

Boolean; optional; nonconfigurable; default is False

Define se o arquivo de mapeamento do Proguard será gerado. O arquivo de mapeamento só será gerado se proguard_specs for especificado. Esse arquivo listará o mapeamento entre os nomes original e ofuscado de classes, métodos e campos.

AVISO: se esse atributo for usado, a especificação do Proguard não poderá conter -dontobfuscate nem -printmapping.

proguard_specs

List of labels; optional

Arquivos a serem usados como especificação do Proguard. Esse arquivo descreve o conjunto de especificações a serem usadas pelo Proguard.
resource_configuration_filters

List of strings; optional

Uma lista de filtros de configuração de recursos, como "en", que vai limitar os recursos no apk somente aos da configuração "en". Para ativar a pseudolocalização, inclua as pseudolocalidades en_XA e/ou ar_XB.
resource_files

List of labels; optional

A lista de recursos a serem empacotados. Geralmente, é um glob de todos os arquivos no diretório res.
Os arquivos gerados (de regras gerais) também podem ser referenciados por Rótulo aqui. A única restrição é que as saídas geradas precisam estar no mesmo diretório "res" que todos os outros arquivos de recurso incluídos.
shrink_resources

Integer; optional; default is -1

Define se a redução de recursos será feita. Os recursos que não são usados pelo binário serão removidos do APK. Isso só é compatível com regras que usam recursos locais (ou seja, os atributos manifest e resource_files) e exige o ProGuard. Ele opera basicamente da mesma maneira que o redutor de recursos do Gradle (https://developer.android.com/studio/build/Premium-code.html#renew-resources).

Diferenças significativas:

  • recursos em values/ serão removidos, assim como os recursos baseados em arquivos
  • usa strict mode por padrão
  • a remoção de recursos de ID não utilizados só é compatível com o aapt2.
Se a redução estiver ativada, name_files/resource_shrinker.log também será gerado, detalhando a análise e as exclusões realizadas.

Valores possíveis:

  • shrink_resources = 1: ativa a redução de recursos do Android.
  • shrink_resources = 0: desativa a redução de recursos do Android
  • shrink_resources = -1: a redução é controlada pela sinalização --android_resource_interminando.

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 regra permite o uso de arquivos .aar como bibliotecas para regras android_library e android_binary.

Exemplos

    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

Um nome exclusivo para o destino.

aar

Label; required

O arquivo .aar a ser fornecido aos destinos Android que dependem desse destino.
exports

List of labels; optional

Destinos a serem exportados para regras que dependem desta regra. Consulte java_library.exports.
srcjar

Label; optional

Um arquivo JAR que contém o código-fonte dos arquivos JAR compilados no 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 regra compila e arquiva as origens em um arquivo .jar. A biblioteca do Android Runtime android.jar é colocada implicitamente no caminho da classe de compilação.

Destinos de saída implícitos

  • libname.jar: um arquivo Java.
  • libname-src.jar: um arquivo que contém as origens ("jar de origem").
  • name.aar: um pacote "aar" do Android que contém o arquivo Java e os recursos desse destino. Ele não contém a interdição transitiva.

Exemplos

Exemplos de regras do Android podem ser encontrados no diretório examples/android da árvore de origem do Bazel.

O exemplo abaixo mostra como definir idl_import_root. Permitir que //java/bazel/helloandroid/BUILD contenha:

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

Um nome exclusivo para o destino.

deps

List of labels; optional

A lista de outras bibliotecas com as quais vincular. Os tipos de biblioteca permitidos são: android_library, java_library com restrição android e cc_library encapsulando ou produzindo .so bibliotecas nativas para a plataforma de destino Android.
srcs

List of labels; optional

A lista de arquivos .java ou .srcjar processados para criar o destino.

Arquivos srcs do tipo .java são compilados. Para facilitar a leitura, não é recomendável colocar o nome de um arquivo de origem .java gerado em srcs. Em vez disso, coloque o nome da regra dependente no srcs, conforme descrito abaixo.

Arquivos srcs do tipo .srcjar são descompactados e compilados. Isso é útil se você precisar gerar um conjunto de arquivos .java com uma genrule ou extensão de build.

Se srcs for omitido, qualquer dependência especificada em deps será exportada dessa regra. Consulte Exportações de java_library para mais informações sobre como exportar dependências. No entanto, esse comportamento será suspenso em breve. Tente não confiar nele.

assets

List of labels; optional

A lista de recursos a serem empacotados. Geralmente, é um glob de todos os arquivos no diretório assets. Também é possível referenciar outras regras (qualquer regra que produza arquivos) ou arquivos exportados em outros pacotes, desde que todos esses arquivos estejam no diretório assets_dir no pacote correspondente.
assets_dir

String; optional

A string que fornece o caminho para os arquivos em assets. O par assets e assets_dir descrevem recursos empacotados e ambos os atributos precisam ser fornecidos ou nenhum deles.
custom_package

String; optional

Pacote Java para o qual as origens java serão geradas. Por padrão, o pacote é inferido do diretório em que está o arquivo BUILD que contém a regra. É possível especificar um pacote diferente, mas isso não é recomendado porque ele pode introduzir conflitos de caminho de classe com outras bibliotecas que só serão detectadas no momento da execução.
enable_data_binding

Boolean; optional; default is False

Se verdadeira, essa regra processará expressões de vinculação de dados em recursos de layout incluídos pelo atributo resource_files. Sem essa configuração, as expressões de vinculação de dados produzem falhas de build.

Para criar um app Android com vinculação de dados, também é necessário fazer o seguinte:

  1. Defina esse atributo para todas as regras do Android que dependem temporariamente desse atributo. Isso ocorre porque os dependências herdam as expressões de vinculação de dados da regra por meio da mesclagem de recursos. Portanto, elas também precisam criar com vinculação de dados para analisar essas expressões.
  2. Adicione uma entrada deps = para a biblioteca de execução de vinculação de dados a todos os destinos que definem esse atributo. O local dessa biblioteca depende da configuração do depósito.
exported_plugins

List of labels; optional

A lista de java_plugins (por exemplo, processadores de anotações) a serem exportados para bibliotecas que dependem diretamente dessa biblioteca.

A lista especificada de java_plugins será aplicada a qualquer biblioteca que dependa diretamente dessa biblioteca, como se ela tivesse declarado explicitamente esses rótulos em plugins.

exports

List of labels; optional

O encerramento de todas as regras alcançadas por meio de atributos exports é considerado dependências diretas de qualquer regra que dependa diretamente do destino com exports.

As exports não são dependências diretas da regra a que pertencem.

exports_manifest

Integer; optional; default is 1

Define se entradas de manifesto serão exportadas para destinos android_binary que dependem desse destino. Os atributos uses-permissions nunca são exportados.
idl_import_root

String; optional

Caminho relativo ao pacote para a raiz da árvore de pacotes Java que contém origens inativas incluídas nessa biblioteca.

Esse caminho será usado como a raiz de importação ao processar origens inativas que dependem dessa biblioteca.

Quando idl_import_root é especificado, idl_parcelables e idl_srcs precisam estar no caminho especificado pelo pacote Java do objeto que eles representam em idl_import_root. Quando idl_import_root não for especificado, idl_parcelables e idl_srcs precisarão estar no caminho especificado pelo pacote em uma raiz Java.

Confira exemplos.

idl_parcelables

List of labels; optional

Lista de definições de IDL do Android para fornecer como importações. Esses arquivos serão disponibilizados como importações para qualquer destino android_library que dependa dessa biblioteca, diretamente ou por meio do fechamento transitivo dele, mas não serão convertidos para Java nem compilados.

Somente arquivos .aidl que correspondam diretamente a fontes .java nessa biblioteca precisam ser incluídos (por exemplo, implementações personalizadas de Parcelable). Caso contrário, use idl_srcs.

Esses arquivos precisam ser colocados corretamente para que o compilador AIL os encontre. Consulte a descrição de idl_import_root para informações sobre o que isso significa.

idl_preprocessed

List of labels; optional

Lista de definições de IDL do Android pré-processadas para fornecer como importações. Esses arquivos serão disponibilizados como importações para qualquer destino android_library que dependa dessa biblioteca, diretamente ou por meio do fechamento transitivo dele, mas não serão convertidos para Java nem compilados.

Somente arquivos .aidl pré-processados que correspondem diretamente a fontes .java nesta biblioteca precisam ser incluídos (por exemplo, implementações personalizadas de Parcelable). Caso contrário, use idl_srcs para definições de IDL do Android que precisam ser traduzidas para interfaces Java e use idl_parcelable para arquivos AIDL não pré-processados.

idl_srcs

List of labels; optional

Lista de definições de IDL do Android que serão convertidas em interfaces Java. Depois que as interfaces Java forem geradas, elas serão compiladas com o conteúdo de srcs.

Esses arquivos serão disponibilizados como importações para qualquer destino android_library que dependa dessa biblioteca, diretamente ou por meio do fechamento transitivo.

Esses arquivos precisam ser colocados corretamente para que o compilador AIL os encontre. Consulte a descrição de idl_import_root para informações sobre o que isso significa.

javacopts

List of strings; optional

Opções extras do compilador para esse destino. Sujeito à substituição "Make variables" e tokenização do shell Bourne.

Essas opções do compilador são transmitidas para javac depois das opções do compilador global

manifest

Label; optional

É o nome do arquivo de manifesto do Android, normalmente AndroidManifest.xml. Precisa ser definido se resource_files ou recursos estiverem definidos.

Boolean; optional; default is False

Use essa biblioteca apenas para compilação e não durante a execução. Os resultados de uma regra marcada como neverlink não serão usados na criação de .apk. Útil quando a biblioteca for fornecida pelo ambiente de execução durante a execução.
plugins

List of labels; optional

Plug-ins do compilador Java para execução em tempo de compilação. Cada java_plugin especificado no atributo de plug-ins será executado sempre que esse destino for criado. Os recursos gerados pelo plug-in serão incluídos no jar de resultado do destino.
proguard_specs

List of labels; optional

Arquivos a serem usados como especificação do Proguard. Eles descrevem o conjunto de especificações a serem usadas pelo Proguard. Se especificado, eles serão adicionados a qualquer destino android_binary, dependendo dessa biblioteca. Os arquivos incluídos aqui precisam ter apenas regras idempotentes, como -dontnote, -dontwarn, suposições de efeitos colaterais e regras que começam com -keep. Outras opções só podem aparecer nas proguard_specs de android_binary para garantir mesclagens não automáticas.
resource_files

List of labels; optional

A lista de recursos a serem empacotados. Geralmente, é um glob de todos os arquivos no diretório res.
Os arquivos gerados (de regras gerais) também podem ser referenciados por Rótulo aqui. A única restrição é que as saídas geradas precisam estar no mesmo diretório "res" que todos os outros arquivos de recurso incluídos.

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)

Uma regra android_instrumentation_test executa testes de instrumentação do Android. Ele vai iniciar um emulador, instalar o aplicativo que está sendo testado, o aplicativo de teste e quaisquer outros aplicativos necessários e executar os testes definidos no pacote de teste.

O atributo test_app especifica o android_binary que contém o teste. Esse android_binary, por sua vez, especifica o aplicativo android_binary em teste por meio do atributo instruments.

Exemplo

# 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

Um nome exclusivo para o destino.

support_apks

List of labels; optional

Outros APKs para instalar no dispositivo antes do início do teste de instrumentação.
target_device

Label; required

O android_device em que o teste será executado.

Para executar o teste em um emulador que já esteja em execução ou em um dispositivo físico, use estes argumentos: --test_output=streamed --test_arg=--device_broker_type=LOCAL_ADB_SERVER --test_arg=--device_serial_number=$device_identifier

test_app

Label; required

O destino android_binary que contém as classes de teste. O destino android_binary precisa especificar qual destino está sendo testado por meio do 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)

Essa regra é para o teste de unidade de regras android_library localmente, e não em um dispositivo. Funciona com o framework de testes do Android Robolectric. Consulte o site do Android Robolectric para ver detalhes sobre como criar testes Robolectric.

Destinos de saída implícitos

  • name.jar: um arquivo Java do teste.
  • name-src.jar: um arquivo que contém as origens ("jar de origem").
  • name_deploy.jar: um arquivo de implantação Java adequado para implantação (criado apenas se solicitado explicitamente).

Exemplos

Para usar o Robolectric com android_local_test, adicione o repositório do Robolectric ao seu arquivo 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()
. Isso extrai as regras maven_jar necessárias para o Robolectric. Então, cada regra android_local_test precisa depender de @robolectric//bazel:robolectric. Veja um exemplo abaixo.

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

Um nome exclusivo para o destino.

deps

List of labels; optional

A lista de bibliotecas a serem testadas, bem como bibliotecas adicionais a serem vinculadas ao destino. Todos os recursos e arquivos de manifesto declarados nas regras do Android no fechamento transitivo desse atributo são disponibilizados no teste.

A lista de regras permitidas em deps é android_library, aar_import, java_import, java_library e java_lite_proto_library.

srcs

List of labels; optional

A lista de arquivos de origem que são processados para criar o destino. Obrigatório, exceto no caso especial descrito abaixo.

Arquivos srcs do tipo .java são compilados. Para facilitar a leitura, não é recomendável colocar o nome de um arquivo de origem .java gerado em srcs. Em vez disso, coloque o nome da regra dependente no srcs, conforme descrito abaixo.

Arquivos srcs do tipo .srcjar são descompactados e compilados. Isso é útil se você precisar gerar um conjunto de arquivos .java com uma genrule ou extensão de build.

Todos os outros arquivos são ignorados, desde que haja pelo menos um arquivo do tipo descrito acima. Caso contrário, será gerado um erro.

O atributo srcs é obrigatório e não pode ficar vazio, a menos que runtime_deps seja especificado.

custom_package

String; optional

Pacote Java em que a classe R será gerada. Por padrão, o pacote é inferido do diretório em que está o arquivo BUILD que contém a regra. Se você usar esse atributo, provavelmente também precisará usar test_class.
densities

List of strings; optional

Densidades a serem filtradas ao criar o APK. Uma seção de telas compatíveis correspondente também será adicionada ao manifesto se ele ainda não tiver um superconjunto StarlarkListing.
enable_data_binding

Boolean; optional; default is False

Se verdadeiro, essa regra processará referências de vinculação de dados usadas em dependências ativadas para vinculação de dados usadas pelo teste. Sem essa configuração, as dependências de vinculação de dados não terão a geração de código necessária no nível binário e podem produzir falhas de build.
javacopts

List of strings; optional

Outras opções de compilador para esta biblioteca. Sujeito à substituição "Make variables" e tokenização do shell Bourne.

Essas opções do compilador são transmitidas para javac depois das opções do compilador global

jvm_flags

List of strings; optional

Uma lista de sinalizações a serem incorporadas no script de wrapper gerado para executar esse binário. Sujeito à substituição $(location) e "Make a variável" e a tokenização do shell Bourne.

O script de wrapper de um binário Java inclui uma definição CLASSPATH (para encontrar todos os jars dependentes) e invoca o intérprete Java correto. A linha de comando gerada pelo script de wrapper inclui o nome da classe principal seguido por um "$@" para que você possa transmitir outros argumentos após o nome da classe. No entanto, os argumentos destinados à análise pela JVM precisam ser especificados antes do nome da classe na linha de comando. O conteúdo de jvm_flags é adicionado ao script de wrapper antes que o nome da classe seja listado.

Observe que esse atributo não tem efeito nas saídas de *_deploy.jar.

manifest

Label; optional

É o nome do arquivo de manifesto do Android, normalmente AndroidManifest.xml. Precisa ser definido se os resource_files ou os recursos estiverem definidos, ou se algum dos manifestos das bibliotecas em teste tiver uma tag minSdkVersion.
manifest_values

Dictionary: String -> String; optional

Um dicionário de valores a serem substituídos no manifesto. Qualquer instância de ${name} no manifesto será substituída pelo valor correspondente ao nome neste dicionário. applicationId, versionCode, versionName, minSdkVersion, targetSdkVersion e maxSdkVersion também vão substituir os atributos correspondentes das tags de manifesto e usage-sdk. packageName será ignorado e definido em applicationId, se especificado, ou do pacote no manifesto. Não é necessário ter um manifesto na regra para usar manifest_values.
nocompress_extensions

List of strings; optional

Uma lista de extensões de arquivo a serem deixadas descompactadas no apk de recursos.
plugins

List of labels; optional

Plug-ins do compilador Java para execução em tempo de compilação. Cada java_plugin especificado neste atributo será executado sempre que essa regra for criada. Uma biblioteca também pode herdar plug-ins de dependências que usam exported_plugins. Os recursos gerados pelo plug-in serão incluídos no jar resultante dessa regra.
resource_configuration_filters

List of strings; optional

Uma lista de filtros de configuração de recursos, como "en", que vai limitar os recursos no apk somente aos da configuração "en".
resource_jars

List of labels; optional

Obsoleto: use java_import e deps ou Runtime_deps.
resource_strip_prefix

String; optional

O prefixo do caminho a ser removido dos recursos Java.

Se especificado, esse prefixo de caminho é removido de todos os arquivos no atributo resources. É um erro se um arquivo de recurso não estiver nesse diretório. Se não for especificado (o padrão), o caminho do arquivo de recursos será determinado de acordo com a mesma lógica do pacote Java de arquivos de origem. Por exemplo, um arquivo de origem em stuff/java/foo/bar/a.txt será localizado em foo/bar/a.txt.

runtime_deps

List of labels; optional

Bibliotecas a serem disponibilizadas para o binário final ou teste apenas no momento da execução. Assim como um deps comum, eles vão aparecer no caminho de classe da execução, mas, ao contrário deles, não no caminho de classe do tempo de compilação. As dependências necessárias apenas no momento da execução precisam ser listadas aqui. As ferramentas de análise de dependência precisam ignorar os destinos que aparecem em runtime_deps e deps.
stamp

Integer; optional; default is 0

Define se as informações de compilação serão codificadas no binário. Valores possíveis:
  • stamp = 1: sempre inclua as informações do build no binário, mesmo em builds --nostamp. Essa configuração precisa ser evitada, porque ela pode eliminar o armazenamento remoto do armazenamento em cache do binário e de quaisquer ações downstream que dependam dele.
  • stamp = 0: sempre substitua as informações do build por valores constantes. Isso fornece um bom armazenamento em cache de resultados do build.
  • stamp = -1: a incorporação de informações de build é controlada pela flag --[no]stamp.

Os binários carimbos não são recriados, a menos que as dependências deles mudem.

test_class

String; optional

A classe Java a ser carregada pelo executor de teste.

Este atributo especifica o nome de uma classe Java a ser executada por este teste. É raro configurar isso. Se esse argumento for omitido, a classe Java com o nome que corresponde ao name dessa regra android_local_test será usada. A classe de teste precisa ter a anotação org.junit.runner.RunWith.

use_launcher

Boolean; optional; default is True

Define se o binário precisa usar uma tela de início personalizada.

Se ele for definido como falso, o atributo launcher e a sinalização --java_launcher relacionada serão ignorados para esse 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)

Essa regra cria um Android Emulator configurado com as especificações fornecidas. Esse emulador pode ser iniciado por meio de um comando "bazel run" ou da execução direta do script gerado. É recomendável depender das regras de android_device já existentes em vez de definir as próprias regras.

Esse é um destino adequado para a sinalização --run_under de teste do bazel e execução do blaze. Ele inicia um emulador, copia o destino que está sendo testado/executado para o emulador e o testa ou executa, conforme apropriado.

android_device oferece suporte à criação de imagens KVM se a system_image subjacente for baseada em X86 e estiver otimizada, no máximo, para a arquitetura de CPU I686. Para usar a KVM, adicione tags = ['requires-kvm'] à regra android_device.

Destinos de saída implícitos

  • name_images/userdata.dat: contém arquivos de imagem e snapshots para iniciar o emulador.
  • name_images/emulator-meta-data.pb: contém informações serializadas necessárias para transmitir ao emulador para reiniciá-lo.

Exemplos

O exemplo abaixo mostra como usar o android_device. //java/android/helloandroid/BUILD contém

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 contém:

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

Esta regra vai gerar imagens e um script inicial. Para iniciar o emulador localmente, execute bazel run :nexus_s -- --action=start. O script expõe as seguintes sinalizações:

  • --adb_port: a porta em que o adb será exposto. Se você quiser emitir comandos do adb para o emulador, essa é a porta em que você emitirá o adb Connect.
  • --emulator_port: a porta para expor o console de gerenciamento telnet do emulador.
  • --enable_display: inicia o emulador com uma exibição, se verdadeiro (o padrão é falso).
  • --action: iniciar ou encerrar.
  • --apks_to_install: uma lista de apks para instalar no emulador.

Argumentos

Atributos
name

Name; required

Um nome exclusivo para o destino.

cache

Integer; required

O tamanho em megabytes da partição de cache do emulador. O valor mínimo é 16 megabytes.
default_properties

Label; optional

Um único arquivo de propriedades a ser colocado em /default.prop no emulador. Isso permite que o autor da regra configure ainda mais o emulador para que ele se pareça com um dispositivo real. Especificamente, controlar as strings UserAgent e outros comportamentos que podem fazer com que um aplicativo ou servidor se comporte de maneira diferente de um dispositivo específico. As propriedades nesse arquivo vão substituir as propriedades somente leitura normalmente definidas pelo emulador, como ro.product.model.
horizontal_resolution

Integer; required

A resolução horizontal da tela em pixels para emular. O valor mínimo é 240.
platform_apks

List of labels; optional

Uma lista de APKs a serem instalados no dispositivo durante a inicialização.
ram

Integer; required

A quantidade de memória RAM em megabytes a emular para o dispositivo. Isso se aplica a todo o dispositivo, não apenas a um app específico instalado nele. O valor mínimo é 64 megabytes.
screen_density

Integer; required

É a densidade da tela emulada em pixels por polegada. O valor mínimo é de 30 ppi.
system_image

Label; required

Um grupo com os seguintes arquivos:
  • system.img: a partição do sistema
  • kernel-qemu: o kernel do Linux que o emulador carregará
  • ramdisk.img: a imagem initrd a ser usada no momento da inicialização
  • userdata.img: a partição inicial de dados do usuário
  • source.properties: um arquivo de propriedades com informações sobre as imagens
Esses arquivos fazem parte do SDK do Android ou são fornecidos por terceiros (por exemplo, a Intel fornece imagens x86).
vertical_resolution

Integer; required

A resolução vertical da tela em pixels para emular. O valor mínimo é 240.
vm_heap

Integer; required

O tamanho em megabytes do heap de máquina virtual que o Android vai usar para cada processo. O valor mínimo é 16 megabytes.

android_ndk_repository

android_ndk_repository(name, api_level, path, repo_mapping)

Configura o Bazel para usar um Android NDK e oferecer suporte à criação de destinos do Android com código nativo.

A criação para Android também requer uma regra android_sdk_repository no arquivo WORKSPACE.

Para saber mais, leia a documentação completa sobre como usar o Android NDK com o Bazel.

Exemplos

android_ndk_repository(
    name = "androidndk",
)

O exemplo acima localizará seu Android NDK a partir de $ANDROID_NDK_HOME e detectará o nível de API mais alto com suporte.

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

O exemplo acima usará o Android NDK localizado dentro do espaço de trabalho em ./android-ndk-r20. Ele vai usar as bibliotecas de API de nível 24 ao compilar seu código JNI.

cpufeatures

O Android NDK contém a biblioteca cpufeatures, que pode ser usada para detectar a CPU de um dispositivo no momento da execução. O exemplo a seguir demonstra como usar cpufeatures com o 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

Um nome exclusivo para o destino.

api_level

Integer; optional; nonconfigurable; default is 0

O nível da API do Android para a compilação. Se não for especificado, o nível de API mais alto instalado será usado.
path

String; optional; nonconfigurable

Um caminho absoluto ou relativo para um Android NDK. Esse atributo ou a variável de ambiente $ANDROID_NDK_HOME precisa ser definido.

O download do Android NDK pode ser feito no site para desenvolvedores Android .

repo_mapping

Dictionary: String -> String; optional

Dicionário do nome do repositório local para o nome do repositório global. Isso permite controles sobre a resolução de dependências do espaço de trabalho para dependências desse repositório.

Por exemplo, uma entrada "@foo": "@bar" declara que, sempre que esse repositório depender de "@foo" (como uma dependência de "@foo//some:target"), ele precisará resolver essa dependência no "@bar" declarado globalmente ("@bar//some:target").

android_sdk_repository

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

Configura o Bazel para usar um SDK do Android local para oferecer suporte à criação de destinos do Android.

Exemplos

O mínimo para configurar um SDK do Android para o Bazel é colocar uma regra android_sdk_repository chamada "androidsdk" no arquivo WORKSPACE e definir a variável de ambiente $ANDROID_HOME como o caminho do SDK do Android. O Bazel vai usar o nível mais alto da API do Android e a versão das ferramentas de build instalada no SDK do Android por padrão.
android_sdk_repository(
    name = "androidsdk",
)

Para garantir builds reproduzíveis, os atributos path, api_level e build_tools_version podem ser definidos como valores específicos. O build falhará se o SDK do Android não tiver o nível de API especificado ou a versão das ferramentas de build instalada.

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

O exemplo acima também demonstra o uso de um caminho relativo a espaço de trabalho para o SDK do Android. Isso é útil se o SDK do Android faz parte do seu espaço de trabalho do Bazel (por exemplo, se ele é verificado no controle de versões).

Bibliotecas de Suporte

As Bibliotecas de Suporte estão disponíveis no Android SDK Manager como "Repositório de Suporte do Android". Esse é um conjunto com controle de versões de bibliotecas comuns do Android, como as bibliotecas Support e AppCompat, empacotadas como um repositório Maven local. android_sdk_repository gera destinos do Bazel para cada uma dessas bibliotecas que podem ser usadas nas dependências dos destinos android_binary e android_library.

Os nomes dos destinos gerados são derivados das coordenadas Maven das bibliotecas no Android Support Repository, formatados como @androidsdk//${group}:${artifact}-${version}. O exemplo a seguir mostra como uma android_library pode depender da versão 25.0.0 da biblioteca appcompat v7.

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

Um nome exclusivo para o destino.

api_level

Integer; optional; nonconfigurable; default is 0

O nível da API do Android em que a compilação será usada por padrão. Se não for especificado, o nível de API mais alto instalado será usado.

O nível da API usado para um determinado build pode ser substituído pela sinalização android_sdk. android_sdk_repository cria um destino android_sdk para cada nível da API instalado no SDK com o nome @androidsdk//:sdk-${level}, independentemente de esse atributo ser especificado ou não. Por exemplo, para criar com um nível de API não padrão: bazel build --android_sdk=@androidsdk//:sdk-19 //java/com/example:app.

Para acessar todos os android_sdk destinos gerados por android_sdk_repository , execute bazel query "kind(android_sdk, @androidsdk//...)".

build_tools_version

String; optional; nonconfigurable

A versão das ferramentas de compilação do Android que serão usadas no SDK do Android. Se não for especificada, a versão mais recente instalada do Build Tools será usada.

O Bazel exige a versão 30.0.0 ou mais recente das ferramentas de build.

path

String; optional; nonconfigurable

Um caminho absoluto ou relativo para um SDK do Android. Esse atributo ou a variável de ambiente $ANDROID_HOME precisa ser definido.

Faça o download do SDK do Android no site do desenvolvedor Android.

repo_mapping

Dictionary: String -> String; optional

Dicionário do nome do repositório local para o nome do repositório global. Isso permite controles sobre a resolução de dependências do espaço de trabalho para dependências desse repositório.

Por exemplo, uma entrada "@foo": "@bar" declara que, sempre que esse repositório depender de "@foo" (como uma dependência de "@foo//some:target"), ele precisará resolver essa dependência no "@bar" declarado globalmente ("@bar//some:target").