Instructivo de Bazel: Compila una app para iOS

Informar un problema Ver código fuente Nightly · 8.0 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

En este instructivo, se explica cómo compilar una app para iOS simple con Bazel.

Qué aprenderás

En este instructivo, aprenderás a realizar lo siguiente:

• Para configurar el entorno, instala Bazel y Xcode, y descarga el proyecto de muestra.
• Configura un lugar de trabajo de Bazel que contenga el código fuente de la app y un archivo WORKSPACE que identifique el nivel superior del directorio del lugar de trabajo.
• Actualiza el archivo WORKSPACE para que contenga referencias a las dependencias externas requeridas.
• Crea un archivo BUILD
• Ejecuta Bazel para compilar la app para el simulador y un dispositivo iOS
• Ejecuta la app en el simulador y en un dispositivo iOS

Configura tu entorno

Para comenzar, instala Bazel y Xcode, y obtén el proyecto de ejemplo.

Instala Bazel

Sigue las instrucciones de instalación para instalar Bazel y sus dependencias.

Instala Xcode

Descarga e instala Xcode. Xcode contiene los compiladores, los SDKs y otras herramientas que requiere Bazel para compilar aplicaciones de Apple.

Obtén el proyecto de ejemplo

También debes obtener el proyecto de ejemplo del instructivo desde GitHub. El repositorio de GitHub tiene dos ramas: source-only y main. La rama source-only solo contiene los archivos fuente del proyecto. En este instructivo, usarás los archivos de esta rama. La rama main contiene los archivos fuente y los archivos WORKSPACE y BUILD de Bazel completados. Puedes usar los archivos de esta rama para revisar tu trabajo cuando hayas completado los pasos del instructivo.

Ingresa lo siguiente en la línea de comandos para obtener los archivos de la rama source-only:

cd $HOME
git clone -b source-only https://github.com/bazelbuild/examples

El comando git clone crea un directorio llamado $HOME/examples/. Este directorio contiene varios proyectos de muestra para Bazel. Los archivos del proyecto de este instructivo están en $HOME/examples/tutorial/ios-app.

Cómo configurar un espacio de trabajo

Un lugar de trabajo es un directorio que contiene los archivos fuente de uno o más proyectos de software, así como un archivo WORKSPACE y archivos BUILD que contienen las instrucciones que Bazel usa para compilar el software. El espacio de trabajo también puede contener vínculos simbólicos a directorios de salida.

Un directorio de espacio de trabajo se puede ubicar en cualquier lugar del sistema de archivos y se indica con la presencia del archivo WORKSPACE en su raíz. En este instructivo, el directorio de tu área de trabajo es $HOME/examples/tutorial/, que contiene los archivos de proyecto de muestra que clonaste del repositorio de GitHub en el paso anterior.

Nota: Bazel no impone ningún requisito para organizar los archivos fuente en tu espacio de trabajo. Los archivos de origen de muestra de este instructivo están organizados según las convenciones de la plataforma de destino.

Para tu comodidad, configura la variable de entorno $WORKSPACE ahora para que haga referencia al directorio de tu espacio de trabajo. En la línea de comandos, ingresa lo siguiente:

export WORKSPACE=$HOME/examples/tutorial

Crea un archivo WORKSPACE

Cada espacio de trabajo debe tener un archivo de texto llamado WORKSPACE ubicado en el directorio de nivel superior del espacio de trabajo. Este archivo puede estar vacío o puede contener referencias a dependencias externas necesarias para compilar el software.

Por ahora, crearás un archivo WORKSPACE vacío, que solo sirve para identificar el directorio del lugar de trabajo. En pasos posteriores, actualizarás el archivo para agregar información de dependencia externa.

Ingresa lo siguiente en la línea de comandos:

touch $WORKSPACE/WORKSPACE
open -a Xcode $WORKSPACE/WORKSPACE

Esto crea y abre el archivo WORKSPACE vacío.

Actualiza el archivo WORKSPACE

Para compilar aplicaciones para dispositivos Apple, Bazel debe extraer las reglas de compilación de Apple más recientes de su repositorio de GitHub. Para habilitar esto, agrega las siguientes reglas git_repository a tu archivo WORKSPACE:

load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")

git_repository(
    name = "build_bazel_rules_apple",
    remote = "https://github.com/bazelbuild/rules_apple.git",
    tag = "0.19.0",
)

git_repository(
    name = "build_bazel_rules_swift",
    remote = "https://github.com/bazelbuild/rules_swift.git",
    tag = "0.13.0",
)

git_repository(
    name = "build_bazel_apple_support",
    remote = "https://github.com/bazelbuild/apple_support.git",
    tag = "0.7.2",
)

git_repository(
    name = "bazel_skylib",
    remote = "https://github.com/bazelbuild/bazel-skylib.git",
    tag = "0.9.0",
)

Nota: "Siempre usa la versión más reciente de las reglas de build_apple en el atributo tag. Asegúrate de verificar las dependencias más recientes requeridas en el proyecto de rules_apple".

Nota: Debes establecer el valor del atributo name en la regla git_repository como build_bazel_rules_apple, o la compilación fallará.

Revisa los archivos fuente

Consulta los archivos de origen de la app que se encuentran en $WORKSPACE/ios-app/UrlGet. Una vez más, solo estás viendo estos archivos ahora para familiarizarte con la estructura de la app. No tienes que editar ninguno de los archivos fuente para completar este instructivo.

Crea un archivo BUILD

En un mensaje de línea de comandos, abre un nuevo archivo BUILD para editarlo:

touch $WORKSPACE/ios-app/BUILD
open -a Xcode $WORKSPACE/ios-app/BUILD

Agrega la sentencia de carga de reglas

Para compilar destinos de iOS, Bazel debe cargar reglas de compilación desde su repositorio de GitHub cada vez que se ejecuta la compilación. Para que estas reglas estén disponibles para tu proyecto, agrega la siguiente carga al comienzo de tu archivo BUILD:

load("@build_bazel_rules_apple//apple:ios.bzl", "ios_application")

Solo debes cargar la regla ios_application porque la regla objc_library está integrada en el paquete Bazel.

Agrega una regla objc_library

Bazel proporciona varias reglas de compilación que puedes usar para compilar una app para la plataforma de iOS. En este instructivo, primero usarás la regla objc_library para indicarle a Bazel cómo compilar una biblioteca estática a partir del código fuente de la app y los archivos Xib. Luego, usarás la regla ios_application para indicarle cómo compilar el binario de la aplicación y el paquete .ipa.

Nota: En este instructivo, se presenta un caso de uso mínimo de las reglas de Objective-C en Bazel. Por ejemplo, debes usar la regla ios_application para compilar apps para iOS de varias arquitecturas.

Agrega lo siguiente a tu archivo BUILD:

objc_library(
    name = "UrlGetClasses",
    srcs = [
         "UrlGet/AppDelegate.m",
         "UrlGet/UrlGetViewController.m",
         "UrlGet/main.m",
    ],
    hdrs = glob(["UrlGet/*.h"]),
    data = ["UrlGet/UrlGetViewController.xib"],
)

Anota el nombre de la regla, UrlGetClasses.

Agrega una regla ios_application

La regla ios_application compila el binario de la aplicación y crea el archivo del paquete .ipa.

Agrega lo siguiente a tu archivo BUILD:

ios_application(
    name = "ios-app",
    bundle_id = "Google.UrlGet",
    families = [
        "iphone",
        "ipad",
    ],
    minimum_os_version = "9.0",
    infoplists = [":UrlGet/UrlGet-Info.plist"],
    visibility = ["//visibility:public"],
    deps = [":UrlGetClasses"],
)

Nota: Actualiza el atributo minimum_os_version a la versión mínima de iOS que planeas admitir.

Observa cómo el atributo deps hace referencia al resultado de la regla UrlGetClasses que agregaste al archivo BUILD anterior.

Ahora, guarda y cierra el archivo. Puedes comparar tu archivo BUILD con el ejemplo completo en la rama main del repositorio de GitHub.

Compila y, luego, implementa la app.

Ya está todo listo para compilar tu app y, luego, implementarla en un simulador y en un dispositivo iOS.

Nota: La app se inicia de forma independiente, pero requiere un servidor de backend para producir resultados. Consulta el archivo README en el directorio del proyecto de ejemplo para obtener información sobre cómo compilar el servidor de backend.

La app compilada se encuentra en el directorio $WORKSPACE/bazel-bin.

Los archivos WORKSPACE y BUILD completos de este instructivo se encuentran en la rama principal del repositorio de GitHub. Puedes comparar tu trabajo con los archivos completados para obtener ayuda adicional o solucionar problemas.

Compila la app para el simulador

Asegúrate de que tu directorio de trabajo actual esté dentro de tu espacio de trabajo de Bazel:

cd $WORKSPACE

Ahora, ingresa lo siguiente para compilar la app de ejemplo:

bazel build //ios-app:ios-app

Bazel inicia y compila la app de ejemplo. Durante el proceso de compilación, su resultado será similar al siguiente:

INFO: Found 1 target...
Target //ios-app:ios-app up-to-date:
  bazel-bin/ios-app/ios-app.ipa
INFO: Elapsed time: 0.565s, Critical Path: 0.44s

Cómo encontrar los resultados de la compilación

El archivo .ipa y otras salidas se encuentran en el directorio $WORKSPACE/bazel-bin/ios-app.

Ejecuta y depura la app en el simulador

Ahora puedes ejecutar la app desde Xcode con el simulador de iOS. Primero, genera un proyecto de Xcode con Tulsi.

Luego, abre el proyecto en Xcode, elige un simulador de iOS como el esquema de tiempo de ejecución y haz clic en Run.

Nota: Si modificas algún archivo del proyecto en Xcode (por ejemplo, si agregas o quitas un archivo, o agregas o cambias una dependencia), debes volver a compilar la app con Bazel, volver a generar el proyecto de Xcode en Tulsi y, luego, volver a abrirlo en Xcode.

Compila la app para un dispositivo

Para compilar tu app de modo que se instale y se inicie en un dispositivo iOS, Bazel necesita el perfil de aprovisionamiento adecuado para ese modelo de dispositivo. Puedes hacer lo siguiente:

1. Ve a tu cuenta de desarrollador de Apple y descarga el perfil de aprovisionamiento adecuado para tu dispositivo. Consulta la documentación de Apple para obtener más información.

2. Mueve tu perfil a $WORKSPACE.

3. (Opcional) Agrega tu perfil a tu archivo .gitignore.

4. Agrega la siguiente línea al destino ios_application en tu archivo BUILD:

   provisioning_profile = "<your_profile_name>.mobileprovision",
   

Nota: Asegúrate de que el perfil sea correcto para que la app se pueda instalar en un dispositivo.

Ahora, compila la app para tu dispositivo:

bazel build //ios-app:ios-app --ios_multi_cpus=armv7,arm64

De esta forma, se compila la app como un objeto binario grueso. Para compilar para una arquitectura de dispositivo específica, designala en las opciones de compilación.

Para compilar para una versión específica de Xcode, usa la opción --xcode_version. Para compilar para una versión específica del SDK, usa la opción --ios_sdk_version. La opción --xcode_version es suficiente en la mayoría de los casos.

Para especificar una versión mínima de iOS requerida, agrega el parámetro minimum_os_version a la regla de compilación ios_application en tu archivo BUILD.

También puedes usar Tulsi para compilar tu app con una GUI en lugar de la línea de comandos.

Instala la app en un dispositivo

La forma más fácil de instalar la app en el dispositivo es iniciar Xcode y usar el comando Windows > Devices. Selecciona el dispositivo conectado de la lista de la izquierda y, luego, agrega la app haciendo clic en el botón Agregar (signo más) en "Apps instaladas" y seleccionando el archivo .ipa que compilaste.

Si la app no se instala en el dispositivo, asegúrate de especificar el perfil de aprovisionamiento correcto en el archivo BUILD (paso 4 en la sección anterior).

Si la app no se inicia, asegúrate de que el dispositivo forme parte de tu perfil de aprovisionamiento. Es posible que el botón View Device Logs en la pantalla Devices de Xcode proporcione otra información sobre lo que salió mal.

Lecturas adicionales

Para obtener más detalles, consulta la rama principal del repositorio de GitHub.