Instructivo de Bazel: Compila un proyecto de Java

7.3 · 7.2 · 7.1 · 7.0 · 6.5

En este instructivo, se abordan los aspectos básicos de la compilación de aplicaciones de Java con Bazel. Configurarás tu espacio de trabajo y compilarás un proyecto de Java simple que ilustre los conceptos clave de Bazel, como los destinos y los archivos BUILD.

Tiempo estimado de finalización: 30 minutos

Qué aprenderás

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

  • Cómo crear un destino
  • Visualiza las dependencias del proyecto
  • Divide el proyecto en varios objetivos y paquetes
  • Cómo controlar la visibilidad del objetivo en los paquetes
  • Cómo hacer referencia a los objetivos a través de etiquetas
  • Cómo implementar un destino

Antes de comenzar

Instala Bazel

Para prepararte para el instructivo, primero instala Bazel si aún no lo hiciste.

Instala el JDK

  1. Instala Java JDK (la versión preferida es la 11, pero se admiten versiones entre 8 y 15).

  2. Configura la variable de entorno JAVA_HOME para que apunte al JDK.

    • En Linux/macOS:

      export JAVA_HOME="$(dirname $(dirname $(realpath $(which javac))))"

    • En Windows:

      1. Abre el Panel de control.
      2. Ve a "Sistema y seguridad" > "Sistema" > "Configuración avanzada del sistema" > pestaña "Configuración avanzada" > "Variables ambientales…" .
      3. En la lista "Variables del usuario" (la que está en la parte superior), haz clic en "Nueva…".
      4. En el campo "Nombre de la variable", ingresa JAVA_HOME.
      5. Haz clic en "Explorar directorio…".
      6. Navega al directorio JDK (por ejemplo, C:\Program Files\Java\jdk1.8.0_152).
      7. Haz clic en “Aceptar” en todas las ventanas de diálogo.

Obtén el proyecto de ejemplo

Recupera el proyecto de ejemplo del repositorio de GitHub de Bazel:

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

El proyecto de ejemplo de este instructivo se encuentra en el directorio examples/java-tutorial y tiene la siguiente estructura:

java-tutorial
├── BUILD
├── src
│   └── main
│       └── java
│           └── com
│               └── example
│                   ├── cmdline
│                   │   ├── BUILD
│                   │   └── Runner.java
│                   ├── Greeting.java
│                   └── ProjectRunner.java
└── WORKSPACE

Compila con Bazel

Configura el lugar de trabajo

Antes de compilar un proyecto, debes configurar su lugar de trabajo. Un lugar de trabajo es un directorio que contiene los archivos fuente de tu proyecto y los resultados de compilación de Bazel. También contiene archivos que Bazel reconoce como especiales:

  • El archivo WORKSPACE, que identifica el directorio y su contenido como un lugar de trabajo de Bazel y se encuentra en la raíz de la estructura de directorios del proyecto

  • Uno o más archivos BUILD, que le indican a Bazel cómo compilar diferentes partes del proyecto (Un directorio dentro del lugar de trabajo que contiene un archivo BUILD es un paquete). Más adelante en este instructivo, aprenderás sobre los paquetes).

Para designar un directorio como lugar de trabajo de Bazel, crea un archivo vacío llamado WORKSPACE en ese directorio.

Cuando Bazel compila el proyecto, todas las entradas y dependencias deben estar en el mismo lugar de trabajo. Los archivos que residen en diferentes lugares de trabajo son independientes entre sí, a menos que estén vinculados, lo que está fuera del alcance de este instructivo.

Comprende el archivo BUILD

Un archivo BUILD contiene varios tipos de instrucciones diferentes para Bazel. El tipo más importante es la regla de compilación, que le indica a Bazel cómo compilar los resultados deseados, como bibliotecas o objetos binarios ejecutables. Cada instancia de una regla de compilación en el archivo BUILD se denomina destino y apunta a un conjunto específico de archivos de origen y dependencias. Un objetivo también puede apuntar a otros objetivos.

Echa un vistazo al archivo java-tutorial/BUILD:

java_binary(
    name = "ProjectRunner",
    srcs = glob(["src/main/java/com/example/*.java"]),
)

En nuestro ejemplo, el objetivo ProjectRunner crea una instancia de la regla java_binary integrada de Bazel. La regla le indica a Bazel que compile un archivo .jar y una secuencia de comandos de shell de wrapper (ambas con el nombre del destino).

Los atributos del objetivo indican explícitamente sus dependencias y opciones. Si bien el atributo name es obligatorio, muchos son opcionales. Por ejemplo, en el objetivo de la regla ProjectRunner, name es el nombre del objetivo, srcs especifica los archivos de origen que Bazel usa para compilar el objetivo y main_class especifica la clase que contiene el método principal. (Es posible que hayas notado que nuestro ejemplo usa glob para pasar un conjunto de archivos fuente a Bazel en lugar de enumerarlos uno por uno).

Compila el proyecto

Para compilar tu proyecto de muestra, navega hasta el directorio java-tutorial y ejecuta lo siguiente:

bazel build //:ProjectRunner

En la etiqueta de destino, la parte // es la ubicación del archivo BUILD en relación con la raíz del lugar de trabajo (en este caso, la raíz en sí) y ProjectRunner es el nombre de destino en el archivo BUILD. (al final de este instructivo, obtendrás información sobre las etiquetas de destino con más detalle).

Bazel produce un resultado similar al siguiente:

   INFO: Found 1 target...
   Target //:ProjectRunner up-to-date:
      bazel-bin/ProjectRunner.jar
      bazel-bin/ProjectRunner
   INFO: Elapsed time: 1.021s, Critical Path: 0.83s

¡Felicitaciones! Acabas de compilar tu primer destino de Bazel. Bazel coloca los resultados de la compilación en el directorio bazel-bin en la raíz del espacio de trabajo. Explora su contenido para obtener una idea de la estructura de salida de Bazel.

Ahora prueba el objeto binario recién compilado:

bazel-bin/ProjectRunner

Revisa el gráfico de dependencias

Bazel requiere que las dependencias de compilación se declaren de forma explícita en los archivos BUILD. Bazel usa esas instrucciones para crear el gráfico de dependencias del proyecto, lo que permite compilaciones incrementales precisas.

Para visualizar las dependencias del proyecto de ejemplo, puedes generar una representación de texto del gráfico de dependencias. Para ello, ejecuta el siguiente comando en la raíz del espacio de trabajo:

bazel query  --notool_deps --noimplicit_deps "deps(//:ProjectRunner)" --output graph

El comando anterior le indica a Bazel que busque todas las dependencias del objetivo //:ProjectRunner (sin incluir las dependencias implícitas y del host) y que formatee el resultado como un gráfico.

Luego, pega el texto en GraphViz.

Como puedes ver, el proyecto tiene un solo objetivo que compila dos archivos fuente sin dependencias adicionales:

Gráfico de dependencia del objetivo "ProjectRunner"

Después de configurar tu espacio de trabajo, compilar tu proyecto y examinar sus dependencias, puedes agregarle complejidad.

Define mejor tu compilación de Bazel

Si bien un solo objetivo es suficiente para proyectos pequeños, es posible que desees dividir proyectos más grandes en varios objetivos y paquetes para permitir compilaciones incrementales rápidas (es decir, solo volver a compilar lo que cambió) y acelerar las compilaciones compilando varias partes de un proyecto a la vez.

Cómo especificar varios destinos de compilación

Puedes dividir la compilación del proyecto de ejemplo en dos destinos. Reemplaza el contenido del archivo java-tutorial/BUILD por lo siguiente:

java_binary(
    name = "ProjectRunner",
    srcs = ["src/main/java/com/example/ProjectRunner.java"],
    main_class = "com.example.ProjectRunner",
    deps = [":greeter"],
)

java_library(
    name = "greeter",
    srcs = ["src/main/java/com/example/Greeting.java"],
)

Con esta configuración, Bazel primero compila la biblioteca greeter y, luego, el objeto binario ProjectRunner. El atributo deps en java_binary le indica a Bazel que se requiere la biblioteca greeter para compilar el objeto binario ProjectRunner.

Para compilar esta nueva versión del proyecto, ejecuta el siguiente comando:

bazel build //:ProjectRunner

Bazel produce un resultado similar al siguiente:

INFO: Found 1 target...
Target //:ProjectRunner up-to-date:
  bazel-bin/ProjectRunner.jar
  bazel-bin/ProjectRunner
INFO: Elapsed time: 2.454s, Critical Path: 1.58s

Ahora prueba el objeto binario recién compilado:

bazel-bin/ProjectRunner

Si ahora modificas ProjectRunner.java y vuelves a compilar el proyecto, Bazel solo volverá a compilar ese archivo.

Si observas el gráfico de dependencias, puedes ver que ProjectRunner depende de las mismas entradas que antes, pero la estructura de la compilación es diferente:

Gráfico de dependencias del "ProjectRunner" objetivo después de agregar una dependencia

Ahora compilaste el proyecto con dos destinos. El destino ProjectRunner compila dos archivos de origen y depende de otro destino (:greeter), que compila un archivo de origen adicional.

Usa varios paquetes

Ahora, dividamos el proyecto en varios paquetes. Si observas el directorio src/main/java/com/example/cmdline, verás que también contiene un archivo BUILD, además de algunos archivos fuente. Por lo tanto, para Bazel, el espacio de trabajo ahora contiene dos paquetes, //src/main/java/com/example/cmdline y // (ya que hay un archivo BUILD en la raíz del espacio de trabajo).

Echa un vistazo al archivo src/main/java/com/example/cmdline/BUILD:

java_binary(
    name = "runner",
    srcs = ["Runner.java"],
    main_class = "com.example.cmdline.Runner",
    deps = ["//:greeter"],
)

El destino runner depende del destino greeter en el paquete // (por lo tanto, la etiqueta de destino //:greeter). Bazel lo sabe a través del atributo deps. Observa el gráfico de dependencias:

Gráfico de dependencias del "ejecutor" de destino

Sin embargo, para que la compilación se realice correctamente, debes otorgar de forma explícita el objetivo runner en //src/main/java/com/example/cmdline/BUILD visibilidad a los objetivos en //BUILD mediante el atributo visibility. Esto se debe a que, de forma predeterminada, los objetivos solo son visibles para otros objetivos en el mismo archivo BUILD. (Bazel usa la visibilidad de objetivos para evitar problemas como las bibliotecas que contienen detalles de implementación que se filtran en las APIs públicas).

Para ello, agrega el atributo visibility al objetivo greeter en java-tutorial/BUILD como se muestra a continuación:

java_library(
    name = "greeter",
    srcs = ["src/main/java/com/example/Greeting.java"],
    visibility = ["//src/main/java/com/example/cmdline:__pkg__"],
)

Ahora puedes compilar el paquete nuevo ejecutando el siguiente comando en la raíz del lugar de trabajo:

bazel build //src/main/java/com/example/cmdline:runner

Bazel produce un resultado similar al siguiente:

INFO: Found 1 target...
Target //src/main/java/com/example/cmdline:runner up-to-date:
  bazel-bin/src/main/java/com/example/cmdline/runner.jar
  bazel-bin/src/main/java/com/example/cmdline/runner
  INFO: Elapsed time: 1.576s, Critical Path: 0.81s

Ahora, prueba tu objeto binario recién compilado:

./bazel-bin/src/main/java/com/example/cmdline/runner

Ahora modificaste el proyecto para compilarlo como dos paquetes, cada uno con un objetivo, y comprendes las dependencias entre ellos.

Usa etiquetas para hacer referencia a los objetivos

En los archivos BUILD y en la línea de comandos, Bazel usa etiquetas de destino para hacer referencia a destinos, por ejemplo, //:ProjectRunner o //src/main/java/com/example/cmdline:runner. Su sintaxis es la siguiente:

//path/to/package:target-name

Si el destino es un destino de regla, path/to/package es la ruta al directorio que contiene el archivo BUILD, y target-name es el nombre que le asignaste en el archivo BUILD (el atributo name). Si el destino es un archivo, path/to/package es la ruta de acceso a la raíz del paquete y target-name es el nombre del archivo de destino, incluida su ruta de acceso completa.

Cuando hagas referencia a destinos en la raíz del repositorio, la ruta del paquete estará vacía, así que solo usa //:target-name. Cuando haces referencia a destinos dentro del mismo archivo BUILD, incluso puedes omitir el identificador raíz del espacio de trabajo // y solo usar :target-name.

Por ejemplo, para los destinos del archivo java-tutorial/BUILD, no tenías que especificar una ruta de acceso del paquete, ya que la raíz del lugar de trabajo es un paquete (//) y tus dos etiquetas de destino eran simplemente //:ProjectRunner y //:greeter.

Sin embargo, para los destinos del archivo //src/main/java/com/example/cmdline/BUILD, debías especificar la ruta de acceso completa del paquete de //src/main/java/com/example/cmdline y tu etiqueta de destino era //src/main/java/com/example/cmdline:runner.

Empaqueta un destino de Java para la implementación

Ahora, empaquetemos un destino Java para la implementación compilando el objeto binario con todas sus dependencias de tiempo de ejecución. Esto te permite ejecutar el objeto binario fuera de tu entorno de desarrollo.

Como recordarás, la regla de compilación java_binary produce un .jar y una secuencia de comandos de shell del wrapper. Consulta el contenido de runner.jar con el siguiente comando:

jar tf bazel-bin/src/main/java/com/example/cmdline/runner.jar

El contenido es el siguiente:

META-INF/
META-INF/MANIFEST.MF
com/
com/example/
com/example/cmdline/
com/example/cmdline/Runner.class

Como puedes ver, runner.jar contiene Runner.class, pero no su dependencia, Greeting.class. La secuencia de comandos runner que genera Bazel agrega greeter.jar a la ruta de clase, por lo que, si la dejas así, se ejecutará de manera local, pero no se ejecutará de forma independiente en otra máquina. Por suerte, la regla java_binary te permite compilar un binario independiente y ejecutable. Para compilarlo, agrega _deploy.jar al nombre de destino:

bazel build //src/main/java/com/example/cmdline:runner_deploy.jar

Bazel produce un resultado similar al siguiente:

INFO: Found 1 target...
Target //src/main/java/com/example/cmdline:runner_deploy.jar up-to-date:
  bazel-bin/src/main/java/com/example/cmdline/runner_deploy.jar
INFO: Elapsed time: 1.700s, Critical Path: 0.23s

Acabas de compilar runner_deploy.jar, que puedes ejecutar de forma independiente fuera de tu entorno de desarrollo, ya que contiene las dependencias de tiempo de ejecución requeridas. Observa el contenido de este JAR independiente con el mismo comando que antes:

jar tf bazel-bin/src/main/java/com/example/cmdline/runner_deploy.jar

El contenido incluye todas las clases necesarias para ejecutar:

META-INF/
META-INF/MANIFEST.MF
build-data.properties
com/
com/example/
com/example/cmdline/
com/example/cmdline/Runner.class
com/example/Greeting.class

Lecturas adicionales

Para obtener más información, consulta los siguientes recursos:

¡Feliz compilación!