Tutorial do Bazel: criar um app Android

Observação:há limitações conhecidas no uso do Bazel para criar apps Android. Acesse a lista de problemas conhecidos do team-Android no GitHub para conferir a lista de problemas conhecidos. Enquanto a equipe do Bazel e os colaboradores do software de código aberto (OSS, na sigla em inglês) trabalham ativamente para resolver problemas conhecidos, os usuários precisam saber que o Android Studio não oferece suporte oficial a projetos do Bazel.

Neste tutorial, mostramos como criar um app Android simples usando o Bazel.

O Bazel oferece suporte à criação de apps Android usando as regras do Android.

Este tutorial é destinado a usuários do Windows, macOS e Linux e não exige experiência com o Bazel ou o desenvolvimento de apps Android. Não é necessário programar nenhum código do Android neste tutorial.

O que você vai aprender

Neste tutorial, você vai aprender a:

• Configure seu ambiente instalando o Bazel e o Android Studio e fazendo o download do projeto de exemplo.
• Configure um espaço de trabalho do Bazel que contenha o código-fonte do app e um arquivo MODULE.bazel que identifique o nível superior do diretório do espaço de trabalho.
• Atualize o arquivo MODULE.bazel para conter referências às dependências externas necessárias, como o SDK do Android.
• Crie um arquivo BUILD.
• Crie o app com o Bazel.
• Implante e execute o app em um emulador ou dispositivo físico do Android.

Antes de começar

Instalar o Bazel

Antes de começar o tutorial, instale o seguinte software:

• Bazel. Para instalar, siga as instruções de instalação.
• Android Studio. Para instalar, siga as etapas para fazer o download do Android Studio. Execute o assistente de configuração para fazer o download do SDK e configurar seu ambiente.
• (Opcional) Git. Use git para fazer o download do projeto do app Android.

Fazer o download do projeto de exemplo

Para o projeto de exemplo, use um projeto de app Android básico no repositório de exemplos do Bazel.

Esse app tem um único botão que mostra uma saudação quando clicado:

Figura 1. Botão de saudação do app Android.

Clone o repositório com git (ou faça o download do arquivo ZIP diretamente):

git clone https://github.com/bazelbuild/examples

O projeto de exemplo deste tutorial está em examples/android/tutorial. No resto do tutorial, você vai executar comandos neste diretório.

Analisar os arquivos de origem

Confira os arquivos de origem do app.

.
├── README.md
└── src
    └── main
        ├── AndroidManifest.xml
        └── java
            └── com
                └── example
                    └── bazel
                        ├── AndroidManifest.xml
                        ├── Greeter.java
                        ├── MainActivity.java
                        └── res
                            ├── layout
                            │   └── activity_main.xml
                            └── values
                                ├── colors.xml
                                └── strings.xml

Os arquivos e diretórios principais são:

Criação com o Bazel

Configurar o espaço de trabalho

Um espaço de trabalho é um diretório que contém os arquivos de origem de um ou mais projetos de software e tem um arquivo MODULE.bazel na raiz.

O arquivo MODULE.bazel pode estar vazio ou conter referências a dependências externas necessárias para criar o projeto.

Primeiro, execute o comando a seguir para criar um arquivo MODULE.bazel vazio:

Como executar o Bazel

Agora você pode verificar se o Bazel está sendo executado corretamente com o comando:

bazel info workspace

Se o Bazel mostrar o caminho do diretório atual, você está pronto. Se o arquivo MODULE.bazel não existir, uma mensagem de erro como esta será exibida:

ERROR: The 'info' command is only supported from within a workspace.

Integrar com o SDK do Android

O Bazel precisa executar as ferramentas de build do SDK do Android para criar o app. Isso significa que você precisa adicionar algumas informações ao arquivo MODULE.bazel para que o Bazel saiba onde encontrá-las.

Adicione a linha a seguir ao arquivo MODULE.bazel:

bazel_dep(name = "rules_android", version = "0.5.1")

Isso vai usar o SDK do Android no caminho referenciado pela variável de ambiente ANDROID_HOME e detectar automaticamente o nível de API mais alto e a versão mais recente das ferramentas de build instaladas nesse local.

É possível definir a variável ANDROID_HOME como o local do SDK do Android. Encontre o caminho para o SDK instalado usando o SDK Manager do Android Studio. Supondo que o SDK esteja instalado nos locais padrão, use os seguintes comandos para definir a variável ANDROID_HOME:

Os comandos acima definem a variável apenas para a sessão de shell atual. Para torná-los permanentes, execute os seguintes comandos:

Opcional:se você quiser compilar um código nativo no seu app Android, também será necessário fazer o download do NDK do Android e usar rules_android_ndk adicionando a seguinte linha ao arquivo MODULE.bazel:

bazel_dep(name = "rules_android_ndk", version = "0.1.2")

Para mais informações, leia Como usar o Kit de desenvolvimento nativo do Android com o Bazel.

Não é necessário definir os níveis da API com o mesmo valor para o SDK e o NDK. Esta página contém um mapa das versões do Android para os níveis da API suportados pelo NDK.

Criar um arquivo BUILD

Um arquivo BUILD descreve a relação entre um conjunto de saídas de build, como recursos Android compilados de aapt ou arquivos de classe de javac, e as dependências deles. Essas dependências podem ser arquivos de origem (Java, C++) no seu espaço de trabalho ou em outras saídas de build. Os arquivos BUILD são escritos em uma linguagem chamada Starlark.

Os arquivos BUILD fazem parte de um conceito no Bazel conhecido como hierarquia de pacotes. A hierarquia de pacotes é uma estrutura lógica que sobrepõe a estrutura de diretórios no seu espaço de trabalho. Cada pacote é um diretório (e seus subdiretórios) que contém um conjunto relacionado de arquivos de origem e um arquivo BUILD. O pacote também inclui todos os subdiretórios, excluindo aqueles que contêm o próprio arquivo BUILD. O nome do pacote é o caminho para o arquivo BUILD em relação ao arquivo MODULE.bazel.

A hierarquia de pacotes do Bazel é conceitualmente diferente da hierarquia de pacotes Java do diretório do app Android em que o arquivo BUILD está localizado, embora os diretórios possam ser organizados de maneira idêntica.

Para o app Android simples neste tutorial, os arquivos de origem em src/main/ formam um único pacote do Bazel. Um projeto mais complexo pode ter muitos pacotes aninhados.

Adicionar uma regra android_library

Um arquivo BUILD contém vários tipos diferentes de declarações para o Bazel. O tipo mais importante é a regra de build, que informa ao Bazel como criar uma saída de software intermediária ou final a partir de um conjunto de arquivos de origem ou outras dependências. O Bazel fornece duas regras de build, android_library e android_binary, que podem ser usadas para criar um app Android.

Neste tutorial, você vai usar a regra android_library para informar ao Bazel que ele precisa criar um módulo de biblioteca do Android a partir do código-fonte e dos arquivos de recursos do app. Em seguida, você vai usar a regra android_binary para informar ao Bazel como criar o pacote de aplicativo Android.

Crie um arquivo BUILD no diretório src/main/java/com/example/bazel e declare um novo destino android_library:

src/main/java/com/example/bazel/BUILD:

package(
    default_visibility = ["//src:__subpackages__"],
)

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

A regra de build android_library contém um conjunto de atributos que especificam as informações que o Bazel precisa para criar um módulo de biblioteca com base nos arquivos de origem. O nome da regra é greeter_activity. Você vai fazer referência à regra usando esse nome como uma dependência na regra android_binary.

Adicionar uma regra android_binary

A regra android_binary cria o pacote de aplicativo Android (arquivo .apk) para seu app.

Crie um arquivo BUILD no diretório src/main/ e declare um novo destino android_binary:

src/main/BUILD:

android_binary(
    name = "app",
    manifest = "AndroidManifest.xml",
    deps = ["//src/main/java/com/example/bazel:greeter_activity"],
)

Aqui, o atributo deps faz referência à saída da regra greeter_activity que você adicionou ao arquivo BUILD acima. Isso significa que, quando o Bazel gera a saída dessa regra, ele verifica primeiro se a saída da regra da biblioteca greeter_activity foi criada e está atualizada. Caso contrário, o Bazel o cria e usa essa saída para criar o arquivo de pacote do aplicativo.

Agora, salve e feche o arquivo.

Criar o app

Tente criar o app. Execute o comando a seguir para criar o destino android_binary:

bazel build //src/main:app

O subcomando build instrui o Bazel a criar o destino que segue. O destino é especificado como o nome de uma regra de build em um arquivo BUILD, com o caminho do pacote relativo ao diretório do espaço de trabalho. Neste exemplo, o destino é app e o caminho do pacote é //src/main/.

Às vezes, é possível omitir o caminho do pacote ou o nome de destino, dependendo do diretório de trabalho atual na linha de comando e do nome do destino. Para mais detalhes sobre rótulos e caminhos de destino, consulte Rótulos.

O Bazel vai começar a criar o app de exemplo. Durante o processo de build, a saída vai aparecer de forma semelhante a esta:

INFO: Analysed target //src/main:app (0 packages loaded, 0 targets configured).
INFO: Found 1 target...
Target //src/main:app up-to-date:
  bazel-bin/src/main/app_deploy.jar
  bazel-bin/src/main/app_unsigned.apk
  bazel-bin/src/main/app.apk

Localizar as saídas de build

O Bazel coloca as saídas das operações de build intermediárias e finais em um conjunto de diretórios de saída por usuário e por espaço de trabalho. Esses diretórios são vinculados pelos seguintes locais no nível superior do diretório do projeto, em que o arquivo MODULE.bazel está:

• bazel-bin armazena executáveis binários e outras saídas de build executáveis
• bazel-genfiles armazena arquivos de origem intermediários gerados pelas regras do Bazel.
• bazel-out armazena outros tipos de saídas de build

O Bazel armazena o arquivo .apk do Android gerado usando a regra android_binary no diretório bazel-bin/src/main, em que o nome do subdiretório src/main é derivado do nome do pacote do Bazel.

Em um prompt de comando, liste o conteúdo desse diretório e encontre o arquivo app.apk:

Executar o app

Agora é possível implantar o app em um dispositivo Android ou emulador conectado na linha de comando usando o comando bazel mobile-install. Esse comando usa o Android Debug Bridge (adb) para se comunicar com o dispositivo. É necessário configurar o dispositivo para usar adb seguindo as instruções no Android Debug Bridge antes da implantação. Também é possível instalar o app no emulador do Android incluído no Android Studio. Verifique se o emulador está em execução antes de executar o comando abaixo.

Digite o seguinte:

bazel mobile-install //src/main:app

Em seguida, encontre e inicie o "Bazel Tutorial App":

Figura 2. App de tutorial do Bazel.

Parabéns! Você acabou de instalar seu primeiro app Android criado com o Bazel.

O subcomando mobile-install também oferece suporte à flag --incremental, que pode ser usada para implantar apenas as partes do app que mudaram desde a última implantação.

Ele também oferece suporte à flag --start_app para iniciar o app imediatamente após a instalação.

Leitura adicional

Para mais detalhes, consulte estas páginas:

• Problemas abertos no GitHub
• Mais informações sobre mobile-install
• Integração de dependências externas, como AppCompat, Guava e JUnit, de repositórios Maven usando rules_jvm_external
• Execute testes Robolectric com a integração robolectric-bazel.
• Como testar seu app com testes de instrumentação do Android
• Integrar código C e C++ ao app Android com o NDK
• Confira mais projetos de exemplo do Bazel:
  • um app Kotlin
  • Testes Robolectric
  • Testes Espresso

Boa criação!