Reglas de Java

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

Reglas

java_binary

Ver la fuente de la regla
java_binary(name, deps, srcs, data, resources, add_exports, add_opens, args, bootclasspath, classpath_resources, compatible_with, create_executable, deploy_env, deploy_manifest_lines, deprecation, distribs, env, exec_compatible_with, exec_properties, features, javacopts, jvm_flags, launcher, licenses, main_class, neverlink, output_licenses, plugins, resource_strip_prefix, restricted_to, runtime_deps, stamp, tags, target_compatible_with, testonly, toolchains, use_launcher, use_testrunner, visibility)

Compila un archivo Java ("archivo jar"), además de una secuencia de comandos de shell del wrapper con el mismo nombre que la regla. La secuencia de comandos de shell del wrapper usa una ruta de clase que incluye, entre otras cosas, un archivo JAR para cada biblioteca de la que depende el objeto binario. Cuando se ejecuta la secuencia de comandos de shell del wrapper, cualquier variable de entorno JAVABIN que no esté vacía tendrá prioridad sobre la versión especificada a través de la marca --java_runtime_version de Bazel.

La secuencia de comandos del wrapper acepta varias marcas únicas. Consulta //src/main/java/com/google/devtools/build/lib/bazel/rules/java/java_stub_template.txt para obtener una lista de marcas configurables y variables de entorno que acepta el wrapper.

Objetivos de salida implícitos

  • name.jar: Es un archivo Java que contiene los archivos de clase y otros recursos correspondientes a las dependencias directas del binario.
  • name-src.jar: Es un archivo que contiene las fuentes ("jar de fuente").
  • name_deploy.jar: Es un archivo Java adecuado para la implementación (solo se compila si se solicita de forma explícita).

    La compilación del destino <name>_deploy.jar para tu regla crea un archivo jar independiente con un manifiesto que le permite ejecutarse con el comando java -jar o con la opción --singlejar de la secuencia de comandos del wrapper. Se prefiere usar la secuencia de comandos del wrapper en lugar de java -jar porque también pasa las marcas de JVM y las opciones para cargar bibliotecas nativas.

    El archivo JAR de implementación contiene todas las clases que encontraría un cargador de clases que buscara la ruta de clase desde la secuencia de comandos del wrapper del binario de principio a fin. También contiene las bibliotecas nativas necesarias para las dependencias. Se cargan automáticamente en la JVM durante el tiempo de ejecución.

    Si tu destino especifica un atributo launcher, en lugar de ser un archivo JAR normal, _deploy.jar será un binario nativo. Contendrá el selector, además de cualquier dependencia nativa (C++) de tu regla, todo vinculado en un objeto binario estático. Los bytes del archivo JAR real se agregarán a ese binario nativo, lo que creará un solo blob binario que contiene el ejecutable y el código Java. Puedes ejecutar el archivo jar resultante directamente como lo harías con cualquier objeto binario nativo.

  • name_deploy-src.jar: Es un archivo que contiene las fuentes recopiladas del cierre transitivo del destino. Estos coincidirán con las clases en el deploy.jar, excepto cuando los archivos JAR no tengan un archivo fuente coincidente.

Se recomienda usar el nombre del archivo de origen que es el punto de entrada principal de la aplicación (menos la extensión). Por ejemplo, si tu punto de entrada se llama Main.java, tu nombre podría ser Main.

No se permite un atributo deps en una regla java_binary sin srcs. Esa regla requiere un main_class proporcionado por runtime_deps.

En el siguiente fragmento de código, se ilustra un error común:


java_binary(
    name = "DontDoThis",
    srcs = [
        ...,
        "GeneratedJavaFile.java",  # a generated .java file
    ],
    deps = [":generating_rule",],  # rule that generates that file
)

En su lugar, haz lo siguiente:


java_binary(
    name = "DoThisInstead",
    srcs = [
        ...,
        ":generating_rule",
    ],
)

Argumentos

Atributos
name

Nombre: Obligatorio

Un nombre único para este objetivo.

deps

Es una lista de etiquetas. El valor predeterminado es [].

Es la lista de otras bibliotecas que se vincularán al destino. Consulta los comentarios generales sobre deps en Atributos típicos definidos por la mayoría de las reglas de compilación.
srcs

Es una lista de etiquetas. El valor predeterminado es [].

Es la lista de archivos de origen que se procesan para crear el destino. Este atributo casi siempre es obligatorio. Consulta las excepciones a continuación.

Se compilan los archivos de origen de tipo .java. En el caso de los archivos .java generados, por lo general, se recomienda colocar el nombre de la regla de generación aquí en lugar del nombre del archivo. Esto no solo mejora la legibilidad, sino que hace que la regla sea más resistente a los cambios futuros: si la regla de generación genera diferentes archivos en el futuro, solo debes corregir un lugar: el outs de la regla de generación. No debes enumerar la regla de generación en deps porque no realiza ninguna acción.

Los archivos de origen de tipo .srcjar se descomprimen y compilan. (Esto es útil si necesitas generar un conjunto de archivos .java con una genrule).

Reglas: Si la regla (por lo general, genrule o filegroup) genera alguno de los archivos mencionados anteriormente, se usarán de la misma manera que se describe para los archivos fuente.

Este argumento casi siempre es obligatorio, a menos que un atributo main_class especifique una clase en la ruta de acceso de tiempo de ejecución o especifiques el argumento runtime_deps.

data

Es una lista de etiquetas. El valor predeterminado es [].

Es la lista de archivos que necesita esta biblioteca durante el tiempo de ejecución. Consulta los comentarios generales sobre data en Atributos típicos definidos por la mayoría de las reglas de compilación.
resources

Es una lista de etiquetas. El valor predeterminado es [].

Es una lista de archivos de datos que se incluyen en un archivo JAR de Java.

Los recursos pueden ser archivos fuente o generados.

Si se especifican recursos, se agruparán en el jar junto con los archivos .class habituales que produce la compilación. La estructura del proyecto determina la ubicación de los recursos dentro del archivo JAR. Primero, Bazel busca el diseño de directorio estándar de Maven (un directorio "src" seguido de un directorio secundario "resources"). Si no se encuentra, Bazel busca el directorio superior llamado “java” o “javatests” (por ejemplo, si un recurso está en <workspace root>/x/java/y/java/z, la ruta de acceso del recurso será y/java/z. Esta heurística no se puede anular. Sin embargo, el atributo resource_strip_prefix se puede usar para especificar un directorio alternativo específico para los archivos de recursos.

add_exports

Es una lista de cadenas. El valor predeterminado es [].

Permite que esta biblioteca acceda al module o package determinado.

Esto corresponde a las marcas javac y JVM --add-exports=.

add_opens

Es una lista de cadenas. El valor predeterminado es [].

Permite que esta biblioteca acceda de forma reflexiva al module o package determinado.

Esto corresponde a las marcas javac y JVM --add-opens=.

bootclasspath

Etiqueta (Label); el valor predeterminado es None

API restringida, no usar.
classpath_resources

Es una lista de etiquetas. El valor predeterminado es [].

NO USE ESTA OPCIÓN A MENOS QUE NO HAYA OTRA FORMA).

Es una lista de recursos que se deben ubicar en la raíz del árbol de Java. El único propósito de este atributo es admitir bibliotecas de terceros que requieren que sus recursos se encuentren en la ruta de acceso de clases como "myconfig.xml" exactamente. Solo se permite en objetos binarios y no en bibliotecas, debido al peligro de conflictos de espacio de nombres.

create_executable

Es un valor booleano; el valor predeterminado es True.

obsoleta: Usa java_single_jar en su lugar.
deploy_env

Es una lista de etiquetas. El valor predeterminado es [].

Es una lista de otros destinos java_binary que representan el entorno de implementación para este objeto binario. Establece este atributo cuando compiles un complemento que cargará otro java_binary.
Si configuras este atributo, se excluyen todas las dependencias de la ruta de acceso de tiempo de ejecución (y el archivo JAR de implementación) de este objeto binario que se comparten entre este objeto binario y los destinos especificados en deploy_env.
deploy_manifest_lines

Es una lista de cadenas. El valor predeterminado es [].

Es una lista de líneas que se agregarán al archivo META-INF/manifest.mf generado para el objetivo *_deploy.jar. El contenido de este atributo no está sujeto a la sustitución de "Make variable".
javacopts

Es una lista de cadenas. El valor predeterminado es [].

Son opciones adicionales del compilador para este objeto binario. Sujeto a la sustitución de "Make variable" y la tokenización de Bourne shell.

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

jvm_flags

Es una lista de cadenas. El valor predeterminado es [].

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

La secuencia de comandos del wrapper para un objeto binario de Java incluye una definición de CLASSPATH (para encontrar todos los archivos JAR dependientes) y llama al 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 la clase. Sin embargo, los argumentos que la JVM pretende analizar deben especificarse antes del nombre de la 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 la clase.

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

launcher

Etiqueta (Label); el valor predeterminado es None

Especifica un objeto binario que se usará para ejecutar tu programa Java en lugar del programa bin/java normal incluido con el JDK. El objetivo debe ser un cc_binary. Se puede especificar cualquier cc_binary que implemente la API de Java Invocation como valor de este atributo.

De forma predeterminada, Bazel usará el selector de JDK normal (bin/java o java.exe).

La marca --java_launcher de Bazel relacionada solo afecta a los objetivos java_binary y java_test que no especificaron un atributo launcher.

Ten en cuenta que tus dependencias nativas (C++, SWIG, JNI) se compilarán de manera diferente según si usas el selector de JDK o algún otro:

  • Si usas el selector de JDK normal (el predeterminado), las dependencias nativas se compilan como una biblioteca compartida llamada {name}_nativedeps.so, donde {name} es el atributo name de esta regla java_binary. El vinculador no quita el código no utilizado en esta configuración.
  • Si usas cualquier otro selector, las dependencias nativas (C++) se vinculan de forma estática a un objeto binario llamado {name}_nativedeps, en el que {name} es el atributo name de esta regla java_binary. En este caso, el vinculador quitará cualquier código que considere que no se usa del objeto binario resultante, lo que significa que es posible que no se vincule ningún código C++ al que se acceda solo a través de JNI, a menos que el destino cc_library especifique alwayslink = True.

Cuando se usa cualquier selector que no sea el selector predeterminado de JDK, cambia el formato de la salida de *_deploy.jar. Consulta la documentación principal de java_binary para obtener más detalles.

main_class

Cadena; el valor predeterminado es ""

Es el nombre de la clase con el método main() que se usará como punto de entrada. Si una regla usa esta opción, no necesita una lista srcs=[...]. Por lo tanto, con este atributo, se puede crear un ejecutable a partir de una biblioteca de Java que ya contiene uno o más métodos main().

El valor de este atributo es un nombre de clase, no un archivo fuente. La clase debe estar disponible en el tiempo de ejecución: esta regla puede compilarla (desde srcs) o proporcionarla a través de dependencias directas o transitivas (a través de runtime_deps o deps). Si la clase no está disponible, el objeto binario fallará en el tiempo de ejecución; no hay verificación en el tiempo de compilación.

Es un valor booleano; el valor predeterminado es False.

plugins

Es una lista de etiquetas. El valor predeterminado es [].

Complementos del compilador de Java para ejecutarse en el tiempo de compilación. Cada java_plugin especificado en este atributo se ejecutará cada vez que se compile esta regla. Una biblioteca también puede heredar complementos de dependencias que usan exported_plugins. Los recursos que genera el complemento se incluirán en el archivo JAR resultante de esta regla.
resource_strip_prefix

Cadena; el valor predeterminado es ""

Es el prefijo de ruta que se quitará de los recursos de Java.

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

runtime_deps

Es una lista de etiquetas. El valor predeterminado es [].

Son bibliotecas que se ponen a disposición del objeto binario final o solo para pruebas en el tiempo de ejecución. Al igual que los deps normales, 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. Las dependencias que solo se necesitan en el tiempo de ejecución deben enumerarse aquí. Las herramientas de análisis de dependencias deben ignorar los destinos que aparecen en runtime_deps y deps.
stamp

Número entero (el valor predeterminado es -1)

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 binario, incluso en las compilaciones de --nostamp. Se debe evitar esta configuración, ya que puede finalizar la caché remota del objeto binario y cualquier acción descendente que dependa de ella.
  • stamp = 0: Siempre reemplaza la información de compilación por valores constantes. Esto proporciona una buena almacenamiento en caché de los resultados de la compilación.
  • stamp = -1: La incorporación de información de compilación está controlada por la marca --[no]stamp.

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

use_launcher

Es un valor booleano; el valor predeterminado es True.

Indica si el objeto binario debe usar un selector personalizado.

Si este atributo se establece como "false", se ignorarán el atributo launcher y la marca --java_launcher relacionada para este destino.

use_testrunner

Es un valor booleano; el valor predeterminado es False.

Usa la clase del ejecutor de pruebas (com.google.testing.junit.runner.BazelTestRunner de forma predeterminada) como el punto de entrada principal de un programa Java y proporciona la clase de prueba al ejecutor de pruebas como un valor de la propiedad del sistema bazel.test_suite.
Puedes usar esto para anular el comportamiento predeterminado, que es usar el ejecutor de pruebas para las reglas java_test y no usarlo para las reglas java_binary. Es poco probable que quieras hacerlo. Un uso es para las reglas AllTest que invoca otra regla (para configurar una base de datos antes de ejecutar las pruebas, por ejemplo). La regla AllTest se debe declarar como java_binary, pero aún debe usar el ejecutor de pruebas como su punto de entrada principal. El nombre de una clase de ejecutor de pruebas se puede anular con el atributo main_class.

java_import

Ver la fuente de la regla
java_import(name, deps, data, add_exports, add_opens, compatible_with, constraints, deprecation, distribs, exec_compatible_with, exec_properties, exports, features, jars, licenses, neverlink, proguard_specs, restricted_to, runtime_deps, srcjar, tags, target_compatible_with, testonly, toolchains, visibility)

Esta regla permite el uso de archivos .jar previamente compilados como bibliotecas para reglas java_library y java_binary.

Ejemplos


    java_import(
        name = "maven_model",
        jars = [
            "maven_model/maven-aether-provider-3.2.3.jar",
            "maven_model/maven-model-3.2.3.jar",
            "maven_model/maven-model-builder-3.2.3.jar",
        ],
    )

Argumentos

Atributos
name

Nombre: Obligatorio

Un nombre único para este objetivo.

deps

Es una lista de etiquetas. El valor predeterminado es [].

Es la lista de otras bibliotecas que se vincularán al destino. Consulta java_library.deps.
data

Es una lista de etiquetas. El valor predeterminado es [].

Es la lista de archivos que necesita esta regla durante el tiempo de ejecución.
add_exports

Es una lista de cadenas. El valor predeterminado es [].

Permite que esta biblioteca acceda al module o package determinado.

Esto corresponde a las marcas javac y JVM --add-exports=.

add_opens

Es una lista de cadenas. El valor predeterminado es [].

Permite que esta biblioteca acceda de forma reflexiva al module o package determinado.

Esto corresponde a las marcas javac y JVM --add-opens=.

constraints

Es una lista de cadenas. El valor predeterminado es [].

Restricciones adicionales impuestas a esta regla como una biblioteca de Java.
exports

Es una lista de etiquetas. El valor predeterminado es [].

Son los objetivos que se pondrán a disposición de los usuarios de esta regla. Consulta java_library.exports.
jars

Es una lista de etiquetas obligatoria.

Es la lista de archivos JAR proporcionados a los destinos de Java que dependen de este destino.

Es un valor booleano; el valor predeterminado es False.

Usa esta biblioteca solo para la compilación y no en el tiempo de ejecución. Resulta útil si el entorno de ejecución proporcionará la biblioteca durante la ejecución. Algunos ejemplos de bibliotecas como esta son las APIs de IDE para complementos de IDE o tools.jar para todo lo que se ejecuta en un JDK estándar.
proguard_specs

Es una lista de etiquetas. El valor predeterminado es [].

Archivos que se usarán como especificación de Proguard. Estos describirán el conjunto de especificaciones que usará Proguard. Si se especifican, se agregarán a cualquier destino android_binary que dependa de esta biblioteca. Los archivos incluidos aquí solo deben tener reglas idempotentes, como -dontnote, -dontwarn, assumenosideeffects y reglas que comienzan con -keep. Otras opciones solo pueden aparecer en proguard_specs de android_binary para garantizar que las combinaciones no sean tautológicas.
runtime_deps

Es una lista de etiquetas. El valor predeterminado es [].

Son bibliotecas que se ponen a disposición del objeto binario final o solo para pruebas en el tiempo de ejecución. Consulta java_library.runtime_deps.
srcjar

Etiqueta (Label); el valor predeterminado es None

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

java_library

Ver la fuente de la regla
java_library(name, deps, srcs, data, resources, add_exports, add_opens, bootclasspath, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, exported_plugins, exports, features, javabuilder_jvm_flags, javacopts, licenses, neverlink, plugins, proguard_specs, resource_strip_prefix, restricted_to, runtime_deps, tags, target_compatible_with, testonly, toolchains, visibility)

Esta regla compila y vincula las fuentes en un archivo .jar.

Resultados implícitos

  • libname.jar: Es un archivo Java que contiene los archivos de clase.
  • libname-src.jar: Es un archivo que contiene las fuentes ("jar de fuente").

Argumentos

Atributos
name

Nombre: Obligatorio

Un nombre único para este objetivo.

deps

Es una lista de etiquetas. El valor predeterminado es [].

Es la lista de bibliotecas que se vincularán a esta biblioteca. Consulta los comentarios generales sobre deps en Atributos típicos definidos por la mayoría de las reglas de compilación.

Los archivos JAR compilados por las reglas java_library que se enumeran en deps estarán en la ruta de acceso de compilación de esta regla. Además, el cierre transitivo de sus deps, runtime_deps y exports estará en la ruta de acceso de clases del entorno de ejecución.

Por el contrario, los destinos del atributo data se incluyen en los archivos de ejecución, pero no en la ruta de acceso de compilación ni en el tiempo de ejecución.

srcs

Es una lista de etiquetas. El valor predeterminado es [].

Es la lista de archivos de origen que se procesan para crear el destino. Este atributo casi siempre es obligatorio. Consulta las excepciones a continuación.

Se compilan los archivos de origen de tipo .java. En el caso de los archivos .java generados, por lo general, se recomienda colocar el nombre de la regla de generación aquí en lugar del nombre del archivo. Esto no solo mejora la legibilidad, sino que hace que la regla sea más resistente a los cambios futuros: si la regla de generación genera diferentes archivos en el futuro, solo debes corregir un lugar: el outs de la regla de generación. No debes enumerar la regla de generación en deps porque no realiza ninguna acción.

Los archivos de origen de tipo .srcjar se descomprimen y compilan. (Esto es útil si necesitas generar un conjunto de archivos .java con una genrule).

Reglas: Si la regla (por lo general, genrule o filegroup) genera alguno de los archivos mencionados anteriormente, se usarán de la misma manera que se describe para los archivos fuente.

Los archivos de origen de tipo .properties se consideran recursos.

Se ignoran todos los demás archivos, siempre y cuando haya al menos un archivo del tipo de archivo descrito anteriormente. De lo contrario, se genera un error.

Este argumento casi siempre es obligatorio, excepto si especificas el argumento runtime_deps.

data

Es una lista de etiquetas. El valor predeterminado es [].

Es la lista de archivos que necesita esta biblioteca durante el tiempo de ejecución. Consulta los comentarios generales sobre data en Atributos típicos definidos por la mayoría de las reglas de compilación.

Cuando se compila un java_library, Bazel no coloca estos archivos en ningún lugar. Si los archivos data son archivos generados, Bazel los genera. Cuando se compila una prueba que depende de este java_library, Bazel copia o vincula los archivos data en el área de runfiles.

resources

Es una lista de etiquetas. El valor predeterminado es [].

Es una lista de archivos de datos que se incluyen en un archivo JAR de Java.

Los recursos pueden ser archivos fuente o generados.

Si se especifican recursos, se agruparán en el jar junto con los archivos .class habituales que produce la compilación. La estructura del proyecto determina la ubicación de los recursos dentro del archivo JAR. Primero, Bazel busca el diseño de directorio estándar de Maven (un directorio "src" seguido de un directorio secundario "resources"). Si no se encuentra, Bazel busca el directorio superior llamado “java” o “javatests” (por ejemplo, si un recurso está en <workspace root>/x/java/y/java/z, la ruta de acceso del recurso será y/java/z. Esta heurística no se puede anular. Sin embargo, el atributo resource_strip_prefix se puede usar para especificar un directorio alternativo específico para los archivos de recursos.

add_exports

Es una lista de cadenas. El valor predeterminado es [].

Permite que esta biblioteca acceda al module o package determinado.

Esto corresponde a las marcas javac y JVM --add-exports=.

add_opens

Es una lista de cadenas. El valor predeterminado es [].

Permite que esta biblioteca acceda de forma reflexiva al module o package determinado.

Esto corresponde a las marcas javac y JVM --add-opens=.

bootclasspath

Etiqueta (Label); el valor predeterminado es None

API restringida, no usar.
exported_plugins

Es una lista de etiquetas. El valor predeterminado es [].

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, del mismo modo que si esa biblioteca hubiera declarado explícitamente estas etiquetas en plugins.

exports

Es una lista de etiquetas. El valor predeterminado es [].

Bibliotecas exportadas

Si enumeras reglas aquí, estas estarán disponibles para las reglas superiores, como si las reglas superiores dependieran de estas de forma explícita. Esto no es cierto para deps normal (no exportado).

Resumen: Una regla X puede acceder al código en Y si existe una ruta de dependencia entre ellos que comienza con un borde deps seguido de cero o más bordes exports. Veamos algunos ejemplos para ilustrar esto.

Supongamos que A depende de B y B depende de C. En este caso, C es una dependencia transitiva de A, por lo que cambiar las fuentes de C y volver a compilar A volverá a compilar todo correctamente. Sin embargo, A no podrá usar clases en C. Para permitirlo, A debe declarar C en su deps, o bien B puede facilitarle el proceso a A (y a todo lo que pueda depender de A) declarando C en su atributo exports (de B).

El cierre de las bibliotecas exportadas está disponible para todas las reglas superiores directas. Tomemos un ejemplo ligeramente diferente: A depende de B, B depende de C y D, y también exporta C, pero no D. Ahora A tiene acceso a C, pero no a D. Ahora, si C y D exportaron algunas bibliotecas, C' y D', respectivamente, A solo podría acceder a C', pero no a D'.

Importante: Una regla exportada no es una dependencia normal. Siguiendo con el ejemplo anterior, si B exporta C y también quiere usar C, también debe incluirlo en su propio deps.

javabuilder_jvm_flags

Es una lista de cadenas. El valor predeterminado es [].

API restringida, no usar.
javacopts

Es una lista de cadenas. El valor predeterminado es [].

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

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

Es un valor booleano; el valor predeterminado es False.

Indica si esta biblioteca solo debe usarse para la compilación y no en el tiempo de ejecución. Resulta útil si el entorno de ejecución proporciona la biblioteca durante la ejecución. Algunos ejemplos de estas bibliotecas son las APIs de IDE para complementos de IDE o tools.jar para todo lo que se ejecuta en un JDK estándar.

Ten en cuenta que neverlink = True no impide que el compilador incorpore material de esta biblioteca en los destinos de compilación que dependen de ella, como lo permite la Especificación del lenguaje Java (p.ej., Constantes static final de String o de tipos primitivos). Por lo tanto, el caso de uso preferido es cuando la biblioteca del entorno de ejecución es idéntica a la biblioteca de compilación.

Si la biblioteca del entorno de ejecución difiere de la biblioteca de compilación, debes asegurarte de que difieran solo en los lugares en los que el JLS prohíbe que los compiladores inserten (y eso debe aplicarse a todas las versiones futuras del JLS).

plugins

Es una lista de etiquetas. El valor predeterminado es [].

Complementos del compilador de Java para ejecutarse en el tiempo de compilación. Cada java_plugin especificado en este atributo se ejecutará cada vez que se compile esta regla. Una biblioteca también puede heredar complementos de dependencias que usan exported_plugins. Los recursos que genera el complemento se incluirán en el archivo JAR resultante de esta regla.
proguard_specs

Es una lista de etiquetas. El valor predeterminado es [].

Archivos que se usarán como especificación de Proguard. Estos describirán el conjunto de especificaciones que usará Proguard. Si se especifican, se agregarán a cualquier destino android_binary que dependa de esta biblioteca. Los archivos incluidos aquí solo deben tener reglas idempotentes, como -dontnote, -dontwarn, assumenosideeffects y reglas que comienzan con -keep. Otras opciones solo pueden aparecer en proguard_specs de android_binary para garantizar que las combinaciones no sean tautológicas.
resource_strip_prefix

Cadena; el valor predeterminado es ""

Es el prefijo de ruta que se quitará de los recursos de Java.

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

runtime_deps

Es una lista de etiquetas. El valor predeterminado es [].

Son bibliotecas que se ponen a disposición del objeto binario final o solo para pruebas en el tiempo de ejecución. Al igual que los deps normales, 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. Las dependencias que solo se necesitan en el tiempo de ejecución deben enumerarse aquí. Las herramientas de análisis de dependencias deben ignorar los destinos que aparecen en runtime_deps y deps.

java_test

Ver la fuente de la regla
java_test(name, deps, srcs, data, resources, add_exports, add_opens, args, bootclasspath, classpath_resources, compatible_with, create_executable, deploy_manifest_lines, deprecation, distribs, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, javacopts, jvm_flags, launcher, licenses, local, main_class, neverlink, plugins, resource_strip_prefix, restricted_to, runtime_deps, shard_count, size, stamp, tags, target_compatible_with, test_class, testonly, timeout, toolchains, use_launcher, use_testrunner, visibility)

Una regla java_test() compila una prueba de Java. Una prueba es un wrapper binario alrededor de tu código de prueba. Se invoca el método principal del ejecutor de pruebas en lugar de la clase principal que se compila.

Objetivos de salida implícitos

  • name.jar: Un archivo Java.
  • name_deploy.jar: Es un archivo Java adecuado para la implementación. (Solo se compila si se solicita de forma explícita). Consulta la descripción del resultado name_deploy.jar de java_binary para obtener más detalles.

Consulta la sección sobre los argumentos java_binary(). Esta regla también admite todos los atributos comunes a todas las reglas de prueba (*_test).

Ejemplos



java_library(
    name = "tests",
    srcs = glob(["*.java"]),
    deps = [
        "//java/com/foo/base:testResources",
        "//java/com/foo/testing/util",
    ],
)

java_test(
    name = "AllTests",
    size = "small",
    runtime_deps = [
        ":tests",
        "//util/mysql",
    ],
)

Argumentos

Atributos
name

Nombre: Obligatorio

Un nombre único para este objetivo.

deps

Es una lista de etiquetas. El valor predeterminado es [].

Es la lista de otras bibliotecas que se vincularán al destino. Consulta los comentarios generales sobre deps en Atributos típicos definidos por la mayoría de las reglas de compilación.
srcs

Es una lista de etiquetas. El valor predeterminado es [].

Es la lista de archivos de origen que se procesan para crear el destino. Este atributo casi siempre es obligatorio. Consulta las excepciones a continuación.

Se compilan los archivos de origen de tipo .java. En el caso de los archivos .java generados, por lo general, se recomienda colocar el nombre de la regla de generación aquí en lugar del nombre del archivo. Esto no solo mejora la legibilidad, sino que hace que la regla sea más resistente a los cambios futuros: si la regla de generación genera diferentes archivos en el futuro, solo debes corregir un lugar: el outs de la regla de generación. No debes enumerar la regla de generación en deps porque no realiza ninguna acción.

Los archivos de origen de tipo .srcjar se descomprimen y compilan. (Esto es útil si necesitas generar un conjunto de archivos .java con una genrule).

Reglas: Si la regla (por lo general, genrule o filegroup) genera alguno de los archivos mencionados anteriormente, se usarán de la misma manera que se describe para los archivos fuente.

Este argumento casi siempre es obligatorio, a menos que un atributo main_class especifique una clase en la ruta de acceso de tiempo de ejecución o especifiques el argumento runtime_deps.

data

Es una lista de etiquetas. El valor predeterminado es [].

Es la lista de archivos que necesita esta biblioteca durante el tiempo de ejecución. Consulta los comentarios generales sobre data en Atributos típicos definidos por la mayoría de las reglas de compilación.
resources

Es una lista de etiquetas. El valor predeterminado es [].

Es una lista de archivos de datos que se incluyen en un archivo JAR de Java.

Los recursos pueden ser archivos fuente o generados.

Si se especifican recursos, se agruparán en el jar junto con los archivos .class habituales que produce la compilación. La estructura del proyecto determina la ubicación de los recursos dentro del archivo JAR. Primero, Bazel busca el diseño de directorio estándar de Maven (un directorio "src" seguido de un directorio secundario "resources"). Si no se encuentra, Bazel busca el directorio superior llamado “java” o “javatests” (por ejemplo, si un recurso está en <workspace root>/x/java/y/java/z, la ruta de acceso del recurso será y/java/z. Esta heurística no se puede anular. Sin embargo, el atributo resource_strip_prefix se puede usar para especificar un directorio alternativo específico para los archivos de recursos.

add_exports

Es una lista de cadenas. El valor predeterminado es [].

Permite que esta biblioteca acceda al module o package determinado.

Esto corresponde a las marcas javac y JVM --add-exports=.

add_opens

Es una lista de cadenas. El valor predeterminado es [].

Permite que esta biblioteca acceda de forma reflexiva al module o package determinado.

Esto corresponde a las marcas javac y JVM --add-opens=.

bootclasspath

Etiqueta (Label); el valor predeterminado es None

API restringida, no usar.
classpath_resources

Es una lista de etiquetas. El valor predeterminado es [].

NO USE ESTA OPCIÓN A MENOS QUE NO HAYA OTRA FORMA).

Es una lista de recursos que se deben ubicar en la raíz del árbol de Java. El único propósito de este atributo es admitir bibliotecas de terceros que requieren que sus recursos se encuentren en la ruta de acceso de clases como "myconfig.xml" exactamente. Solo se permite en objetos binarios y no en bibliotecas, debido al peligro de conflictos de espacio de nombres.

create_executable

Es un valor booleano; el valor predeterminado es True.

obsoleta: Usa java_single_jar en su lugar.
deploy_manifest_lines

Es una lista de cadenas. El valor predeterminado es [].

Es una lista de líneas que se agregarán al archivo META-INF/manifest.mf generado para el objetivo *_deploy.jar. El contenido de este atributo no está sujeto a la sustitución de "Make variable".
javacopts

Es una lista de cadenas. El valor predeterminado es [].

Son opciones adicionales del compilador para este objeto binario. Sujeto a la sustitución de "Make variable" y la tokenización de Bourne shell.

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

jvm_flags

Es una lista de cadenas. El valor predeterminado es [].

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

La secuencia de comandos del wrapper para un objeto binario de Java incluye una definición de CLASSPATH (para encontrar todos los archivos JAR dependientes) y llama al 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 la clase. Sin embargo, los argumentos que la JVM pretende analizar deben especificarse antes del nombre de la 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 la clase.

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

launcher

Etiqueta (Label); el valor predeterminado es None

Especifica un objeto binario que se usará para ejecutar tu programa Java en lugar del programa bin/java normal incluido con el JDK. El objetivo debe ser un cc_binary. Se puede especificar cualquier cc_binary que implemente la API de Java Invocation como valor de este atributo.

De forma predeterminada, Bazel usará el selector de JDK normal (bin/java o java.exe).

La marca --java_launcher de Bazel relacionada solo afecta a los objetivos java_binary y java_test que no especificaron un atributo launcher.

Ten en cuenta que tus dependencias nativas (C++, SWIG, JNI) se compilarán de manera diferente según si usas el selector de JDK o algún otro:

  • Si usas el selector de JDK normal (el predeterminado), las dependencias nativas se compilan como una biblioteca compartida llamada {name}_nativedeps.so, donde {name} es el atributo name de esta regla java_binary. El vinculador no quita el código no utilizado en esta configuración.
  • Si usas cualquier otro selector, las dependencias nativas (C++) se vinculan de forma estática a un objeto binario llamado {name}_nativedeps, en el que {name} es el atributo name de esta regla java_binary. En este caso, el vinculador quitará cualquier código que considere que no se usa del objeto binario resultante, lo que significa que es posible que no se vincule ningún código C++ al que se acceda solo a través de JNI, a menos que el destino cc_library especifique alwayslink = True.

Cuando se usa cualquier selector que no sea el selector predeterminado de JDK, cambia el formato de la salida de *_deploy.jar. Consulta la documentación principal de java_binary para obtener más detalles.

main_class

Cadena; el valor predeterminado es ""

Es el nombre de la clase con el método main() que se usará como punto de entrada. Si una regla usa esta opción, no necesita una lista srcs=[...]. Por lo tanto, con este atributo, se puede crear un ejecutable a partir de una biblioteca de Java que ya contiene uno o más métodos main().

El valor de este atributo es un nombre de clase, no un archivo fuente. La clase debe estar disponible en el tiempo de ejecución: esta regla puede compilarla (desde srcs) o proporcionarla a través de dependencias directas o transitivas (a través de runtime_deps o deps). Si la clase no está disponible, el objeto binario fallará en el tiempo de ejecución; no hay verificación en el tiempo de compilación.

Es un valor booleano; el valor predeterminado es False.

plugins

Es una lista de etiquetas. El valor predeterminado es [].

Complementos del compilador de Java para ejecutarse en el tiempo de compilación. Cada java_plugin especificado en este atributo se ejecutará cada vez que se compile esta regla. Una biblioteca también puede heredar complementos de dependencias que usan exported_plugins. Los recursos que genera el complemento se incluirán en el archivo JAR resultante de esta regla.
resource_strip_prefix

Cadena; el valor predeterminado es ""

Es el prefijo de ruta que se quitará de los recursos de Java.

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

runtime_deps

Es una lista de etiquetas. El valor predeterminado es [].

Son bibliotecas que se ponen a disposición del objeto binario final o solo para pruebas en el tiempo de ejecución. Al igual que los deps normales, 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. Las dependencias que solo se necesitan en el tiempo de ejecución deben enumerarse aquí. Las herramientas de análisis de dependencias deben ignorar los destinos que aparecen en runtime_deps y deps.
stamp

Número entero (el valor predeterminado es 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 binario, incluso en las compilaciones de --nostamp. Se debe evitar esta configuración, ya que puede finalizar la caché remota del objeto binario y cualquier acción descendente que dependa de ella.
  • stamp = 0: Siempre reemplaza la información de compilación por valores constantes. Esto proporciona una buena almacenamiento en caché de los resultados de la compilación.
  • stamp = -1: La incorporación de información de compilación está controlada por la marca --[no]stamp.

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

test_class

Cadena; el valor predeterminado es ""

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

De forma predeterminada, si no se define este argumento, se usa el modo heredado y, en su lugar, se usan los argumentos de prueba. Establece la marca --nolegacy_bazel_java_test para no recurrir al primer argumento.

Este atributo especifica el nombre de una clase Java que ejecutará esta prueba. Es raro que debas configurarlo. Si se omite este argumento, se inferirá con el name del destino y su ruta de acceso relativa a la raíz de origen. Si la prueba se encuentra fuera de una raíz de fuente conocida, Bazel informará un error si no se establece test_class.

Para JUnit3, la clase de prueba debe ser una subclase de junit.framework.TestCase o debe tener un método suite() estático público que devuelva una junit.framework.Test (o una subclase de Test). Para JUnit4, la clase debe anotarse con org.junit.runner.RunWith.

Este atributo permite que varias reglas java_test compartan el mismo Test (TestCase, TestSuite, …). Por lo general, se le pasa información adicional (p. ej., a través de jvm_flags=['-Dkey=value']) para que su comportamiento difiera en cada caso, como ejecutar un subconjunto diferente de las pruebas. Este atributo también habilita el uso de pruebas de Java fuera del árbol javatests.

use_launcher

Es un valor booleano; el valor predeterminado es True.

Indica si el objeto binario debe usar un selector personalizado.

Si este atributo se establece como "false", se ignorarán el atributo launcher y la marca --java_launcher relacionada para este destino.

use_testrunner

Es un valor booleano; el valor predeterminado es True.

Usa la clase del ejecutor de pruebas (com.google.testing.junit.runner.BazelTestRunner de forma predeterminada) como el punto de entrada principal de un programa Java y proporciona la clase de prueba al ejecutor de pruebas como un valor de la propiedad del sistema bazel.test_suite.
Puedes usar esto para anular el comportamiento predeterminado, que es usar el ejecutor de pruebas para las reglas java_test y no usarlo para las reglas java_binary. Es poco probable que quieras hacerlo. Un uso es para las reglas AllTest que invoca otra regla (para configurar una base de datos antes de ejecutar las pruebas, por ejemplo). La regla AllTest se debe declarar como java_binary, pero aún debe usar el ejecutor de pruebas como su punto de entrada principal. El nombre de una clase de ejecutor de pruebas se puede anular con el atributo main_class.

java_package_configuration

Ver la fuente de la regla
java_package_configuration(name, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, javacopts, output_licenses, packages, restricted_to, system, tags, target_compatible_with, testonly, toolchains, visibility)

Es la configuración que se aplica a un conjunto de paquetes. Las configuraciones se pueden agregar a java_toolchain.javacopts.

Ejemplo:



java_package_configuration(
    name = "my_configuration",
    packages = [":my_packages"],
    javacopts = ["-Werror"],
)

package_group(
    name = "my_packages",
    packages = [
        "//com/my/project/...",
        "-//com/my/project/testing/...",
    ],
)

java_toolchain(
    ...,
    package_configuration = [
        ":my_configuration",
    ]
)


Argumentos

Atributos
name

Nombre: Obligatorio

Un nombre único para este objetivo.

data

Es una lista de etiquetas. El valor predeterminado es [].

Es la lista de archivos que necesita esta configuración en el tiempo de ejecución.
javacopts

Es una lista de cadenas. El valor predeterminado es [].

Marcas del compilador de Java
output_licenses

Es una lista de cadenas. El valor predeterminado es [].

packages

Es una lista de etiquetas. El valor predeterminado es [].

Es el conjunto de package_group a los que se debe aplicar la configuración.
system

Etiqueta (Label); el valor predeterminado es None

Corresponde a la marca --system de javac.

java_plugin

Ver la fuente de la regla
java_plugin(name, deps, srcs, data, resources, add_exports, add_opens, bootclasspath, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, generates_api, javabuilder_jvm_flags, javacopts, licenses, neverlink, output_licenses, plugins, processor_class, proguard_specs, resource_strip_prefix, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_plugin define complementos para el compilador de Java que ejecuta Bazel. El único tipo de complementos admitido son los procesadores de anotaciones. Una regla java_library o java_binary puede ejecutar complementos dependiendo de ellos a través del atributo plugins. Un java_library también puede exportar automáticamente complementos a bibliotecas que dependen directamente de él con exported_plugins.

Objetivos de salida implícitos

  • libname.jar: Un archivo Java.

Los argumentos son idénticos a java_library, excepto por la adición del argumento processor_class.

Argumentos

Atributos
name

Nombre: Obligatorio

Un nombre único para este objetivo.

deps

Es una lista de etiquetas. El valor predeterminado es [].

Es la lista de bibliotecas que se vincularán a esta biblioteca. Consulta los comentarios generales sobre deps en Atributos típicos definidos por la mayoría de las reglas de compilación.

Los archivos JAR compilados por las reglas java_library que se enumeran en deps estarán en la ruta de acceso de compilación de esta regla. Además, el cierre transitivo de sus deps, runtime_deps y exports estará en la ruta de acceso de clases del entorno de ejecución.

Por el contrario, los destinos del atributo data se incluyen en los archivos de ejecución, pero no en la ruta de acceso de compilación ni en el tiempo de ejecución.

srcs

Es una lista de etiquetas. El valor predeterminado es [].

Es la lista de archivos de origen que se procesan para crear el destino. Este atributo casi siempre es obligatorio. Consulta las excepciones a continuación.

Se compilan los archivos de origen de tipo .java. En el caso de los archivos .java generados, por lo general, se recomienda colocar el nombre de la regla de generación aquí en lugar del nombre del archivo. Esto no solo mejora la legibilidad, sino que hace que la regla sea más resistente a los cambios futuros: si la regla de generación genera diferentes archivos en el futuro, solo debes corregir un lugar: el outs de la regla de generación. No debes enumerar la regla de generación en deps porque no realiza ninguna acción.

Los archivos de origen de tipo .srcjar se descomprimen y compilan. (Esto es útil si necesitas generar un conjunto de archivos .java con una genrule).

Reglas: Si la regla (por lo general, genrule o filegroup) genera alguno de los archivos mencionados anteriormente, se usarán de la misma manera que se describe para los archivos fuente.

Los archivos de origen de tipo .properties se consideran recursos.

Se ignoran todos los demás archivos, siempre y cuando haya al menos un archivo del tipo de archivo descrito anteriormente. De lo contrario, se genera un error.

Este argumento casi siempre es obligatorio, excepto si especificas el argumento runtime_deps.

data

Es una lista de etiquetas. El valor predeterminado es [].

Es la lista de archivos que necesita esta biblioteca durante el tiempo de ejecución. Consulta los comentarios generales sobre data en Atributos típicos definidos por la mayoría de las reglas de compilación.

Cuando se compila un java_library, Bazel no coloca estos archivos en ningún lugar. Si los archivos data son archivos generados, Bazel los genera. Cuando se compila una prueba que depende de este java_library, Bazel copia o vincula los archivos data en el área de runfiles.

resources

Es una lista de etiquetas. El valor predeterminado es [].

Es una lista de archivos de datos que se incluyen en un archivo JAR de Java.

Los recursos pueden ser archivos fuente o generados.

Si se especifican recursos, se agruparán en el jar junto con los archivos .class habituales que produce la compilación. La estructura del proyecto determina la ubicación de los recursos dentro del archivo JAR. Primero, Bazel busca el diseño de directorio estándar de Maven (un directorio "src" seguido de un directorio secundario "resources"). Si no se encuentra, Bazel busca el directorio superior llamado “java” o “javatests” (por ejemplo, si un recurso está en <workspace root>/x/java/y/java/z, la ruta de acceso del recurso será y/java/z. Esta heurística no se puede anular. Sin embargo, el atributo resource_strip_prefix se puede usar para especificar un directorio alternativo específico para los archivos de recursos.

add_exports

Es una lista de cadenas. El valor predeterminado es [].

Permite que esta biblioteca acceda al module o package determinado.

Esto corresponde a las marcas javac y JVM --add-exports=.

add_opens

Es una lista de cadenas. El valor predeterminado es [].

Permite que esta biblioteca acceda de forma reflexiva al module o package determinado.

Esto corresponde a las marcas javac y JVM --add-opens=.

bootclasspath

Etiqueta (Label); el valor predeterminado es None

API restringida, no usar.
generates_api

Es un valor booleano; el valor predeterminado es False.

Este atributo marca los procesadores de anotaciones que generan código de API.

Si una regla usa un procesador de anotaciones que genera una API, otras reglas que dependen de ella pueden hacer referencia al código generado solo si sus acciones de compilación se programan después de la regla de generación. Este atributo le indica a Bazel que introduzca restricciones de programación cuando se habilite --java_header_compilation.

ADVERTENCIA: Este atributo afecta el rendimiento de la compilación, úsalo solo si es necesario.

javabuilder_jvm_flags

Es una lista de cadenas. El valor predeterminado es [].

API restringida, no usar.
javacopts

Es una lista de cadenas. El valor predeterminado es [].

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

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

Es un valor booleano; el valor predeterminado es False.

Indica si esta biblioteca solo debe usarse para la compilación y no en el tiempo de ejecución. Resulta útil si el entorno de ejecución proporciona la biblioteca durante la ejecución. Algunos ejemplos de estas bibliotecas son las APIs de IDE para complementos de IDE o tools.jar para todo lo que se ejecuta en un JDK estándar.

Ten en cuenta que neverlink = True no impide que el compilador incorpore material de esta biblioteca en los destinos de compilación que dependen de ella, como lo permite la Especificación del lenguaje Java (p.ej., Constantes static final de String o de tipos primitivos). Por lo tanto, el caso de uso preferido es cuando la biblioteca del entorno de ejecución es idéntica a la biblioteca de compilación.

Si la biblioteca del entorno de ejecución difiere de la biblioteca de compilación, debes asegurarte de que difieran solo en los lugares en los que el JLS prohíbe que los compiladores inserten (y eso debe aplicarse a todas las versiones futuras del JLS).

output_licenses

Es una lista de cadenas. El valor predeterminado es [].

plugins

Es una lista de etiquetas. El valor predeterminado es [].

Complementos del compilador de Java para ejecutarse en el tiempo de compilación. Cada java_plugin especificado en este atributo se ejecutará cada vez que se compile esta regla. Una biblioteca también puede heredar complementos de dependencias que usan exported_plugins. Los recursos que genera el complemento se incluirán en el archivo JAR resultante de esta regla.
processor_class

Cadena; el valor predeterminado es ""

La clase del procesador es el tipo completamente calificado de la clase que el compilador de Java debe usar como punto de entrada al procesador de anotaciones. Si no se especifica, esta regla no proporcionará un procesador de anotaciones al procesamiento de anotaciones del compilador de Java, pero su ruta de acceso de tiempo de ejecución se incluirá en la ruta de acceso del procesador de anotaciones del compilador. (Esto se diseñó principalmente para que lo usen los complementos propensos a errores, que se cargan desde la ruta de acceso del procesador de anotaciones con java.util.ServiceLoader).
proguard_specs

Es una lista de etiquetas. El valor predeterminado es [].

Archivos que se usarán como especificación de Proguard. Estos describirán el conjunto de especificaciones que usará Proguard. Si se especifican, se agregarán a cualquier destino android_binary que dependa de esta biblioteca. Los archivos incluidos aquí solo deben tener reglas idempotentes, como -dontnote, -dontwarn, assumenosideeffects y reglas que comienzan con -keep. Otras opciones solo pueden aparecer en proguard_specs de android_binary para garantizar que las combinaciones no sean tautológicas.
resource_strip_prefix

Cadena; el valor predeterminado es ""

Es el prefijo de ruta que se quitará de los recursos de Java.

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

java_runtime

Ver la fuente de la regla
java_runtime(name, srcs, compatible_with, default_cds, deprecation, distribs, exec_compatible_with, exec_properties, features, hermetic_srcs, hermetic_static_libs, java, java_home, lib_ct_sym, lib_modules, output_licenses, restricted_to, tags, target_compatible_with, testonly, toolchains, version, visibility)

Especifica la configuración de un entorno de ejecución de Java.

Ejemplo:



java_runtime(
    name = "jdk-9-ea+153",
    srcs = glob(["jdk9-ea+153/**"]),
    java_home = "jdk9-ea+153",
)


Argumentos

Atributos
name

Nombre: Obligatorio

Un nombre único para este objetivo.

srcs

Es una lista de etiquetas. El valor predeterminado es [].

Todos los archivos del entorno de ejecución.
default_cds

Etiqueta (Label); el valor predeterminado es None

Archivo CDS predeterminado para java_runtime hermético. Cuando se habilita el modo hermético para un destino java_binary, el CDS predeterminado de java_runtime se empaqueta en el JAR de implementación hermético.
hermetic_srcs

Es una lista de etiquetas. El valor predeterminado es [].

Archivos en el entorno de ejecución necesarios para las implementaciones herméticas.
hermetic_static_libs

Es una lista de etiquetas. El valor predeterminado es [].

Las bibliotecas que están vinculadas de forma estática con el selector para implementaciones herméticas
java

Etiqueta (Label); el valor predeterminado es None

Es la ruta de acceso al ejecutable de Java.
java_home

Cadena; el valor predeterminado es ""

La ruta de acceso a la raíz del entorno de ejecución. Está sujeto a la sustitución de la variable “Make”. Si esta ruta es absoluta, la regla denota un entorno de ejecución de Java no hermético con una ruta conocida. En ese caso, los atributos srcs y java deben estar vacíos.
lib_ct_sym

Etiqueta (Label); el valor predeterminado es None

El archivo lib/ct.sym necesario para la compilación con --release Si no se especifica y hay exactamente un archivo en srcs cuya ruta de acceso termina en /lib/ct.sym, se usará ese archivo.
lib_modules

Etiqueta (Label); el valor predeterminado es None

Es el archivo lib/modules necesario para las implementaciones herméticas.
output_licenses

Es una lista de cadenas. El valor predeterminado es [].

version

Número entero (el valor predeterminado es 0)

Es la versión de la función del entorno de ejecución de Java. Es decir, el número entero que muestra Runtime.version().feature().

java_toolchain

Ver la fuente de la regla
java_toolchain(name, android_lint_data, android_lint_jvm_opts, android_lint_opts, android_lint_package_configuration, android_lint_runner, bootclasspath, compatible_javacopts, compatible_with, deprecation, deps_checker, distribs, exec_compatible_with, exec_properties, features, forcibly_disable_header_compilation, genclass, header_compiler, header_compiler_builtin_processors, header_compiler_direct, ijar, jacocorunner, java_runtime, javabuilder, javabuilder_data, javabuilder_jvm_opts, javac_supports_multiplex_workers, javac_supports_worker_cancellation, javac_supports_worker_multiplex_sandboxing, javac_supports_workers, javacopts, jspecify_implicit_deps, jspecify_javacopts, jspecify_packages, jspecify_processor, jspecify_processor_class, jspecify_stubs, jvm_opts, licenses, misc, oneversion, oneversion_allowlist, oneversion_allowlist_for_tests, oneversion_whitelist, package_configuration, proguard_allowlister, reduced_classpath_incompatible_processors, restricted_to, singlejar, source_version, tags, target_compatible_with, target_version, testonly, timezone_data, toolchains, tools, turbine_data, turbine_jvm_opts, visibility, xlint)

Especifica la configuración del compilador de Java. La cadena de herramientas que se usará se puede cambiar a través del argumento --java_toolchain. Por lo general, no debes escribir ese tipo de reglas, a menos que quieras ajustar tu compilador de Java.

Ejemplos

Un ejemplo simple sería el siguiente:



java_toolchain(
    name = "toolchain",
    source_version = "7",
    target_version = "7",
    bootclasspath = ["//tools/jdk:bootclasspath"],
    xlint = [ "classfile", "divzero", "empty", "options", "path" ],
    javacopts = [ "-g" ],
    javabuilder = ":JavaBuilder_deploy.jar",
)

Argumentos

Atributos
name

Nombre: Obligatorio

Un nombre único para este objetivo.

android_lint_data

Es una lista de etiquetas. El valor predeterminado es [].

Etiquetas de herramientas disponibles para la expansión de etiquetas en android_lint_jvm_opts.
android_lint_jvm_opts

Es una lista de cadenas. El valor predeterminado es [].

Es la lista de argumentos para la JVM cuando se invoca Android Lint.
android_lint_opts

Es una lista de cadenas. El valor predeterminado es [].

Es la lista de argumentos de Android Lint.
android_lint_package_configuration

Es una lista de etiquetas. El valor predeterminado es [].

Configuración de Android Lint que se debe aplicar a los grupos de paquetes especificados.
android_lint_runner

Etiqueta (Label); el valor predeterminado es None

Etiqueta del ejecutor de Android Lint, si corresponde.
bootclasspath

Es una lista de etiquetas. El valor predeterminado es [].

Las entradas de classpath de inicio de destino de Java Corresponde a la marca -bootclasspath de javac.
compatible_javacopts

Es nulo; el valor predeterminado es {}.

API interna, no usar.
deps_checker

Etiqueta (Label); el valor predeterminado es None

Etiqueta del jar de implementación de ImportDepsChecker.
forcibly_disable_header_compilation

Es un valor booleano; el valor predeterminado es False.

Anula --java_header_compilation para inhabilitar la compilación de encabezados en plataformas que no la admiten, p.ej., Bazel de JDK 7.
genclass

Etiqueta (Label); el valor predeterminado es None

Etiqueta del jar de implementación de GenClass.
header_compiler

Etiqueta (Label); el valor predeterminado es None

Etiqueta del compilador de encabezados. Obligatorio si está habilitado --java_header_compilation.
header_compiler_builtin_processors

Es una lista de cadenas. El valor predeterminado es [].

API interna, no usar.
header_compiler_direct

Etiqueta (Label); el valor predeterminado es None

Etiqueta opcional del compilador de encabezados que se usará para acciones de ruta de acceso a clases directas que no incluyan ningún procesador de anotaciones que genere la API.

Esta herramienta no admite el procesamiento de anotaciones.

ijar

Etiqueta (Label); el valor predeterminado es None

Etiqueta del ejecutable ijar.
jacocorunner

Etiqueta (Label); el valor predeterminado es None

Etiqueta del jar de implementación de JacocoCoverageRunner.
java_runtime

Etiqueta (Label); el valor predeterminado es None

El java_runtime que se usará con esta cadena de herramientas. De forma predeterminada, se establece en java_runtime en la configuración de ejecución.
javabuilder

Etiqueta (Label); el valor predeterminado es None

Etiqueta del archivo jar de implementación de JavaBuilder.
javabuilder_data

Es una lista de etiquetas. El valor predeterminado es [].

Etiquetas de datos disponibles para la expansión de etiquetas en javabuilder_jvm_opts.
javabuilder_jvm_opts

Es una lista de cadenas. El valor predeterminado es [].

Es la lista de argumentos para la JVM cuando se invoca JavaBuilder.
javac_supports_multiplex_workers

Es un valor booleano; el valor predeterminado es True.

Es verdadero si JavaBuilder admite la ejecución como un trabajador persistente multiplexado y falso si no lo admite.
javac_supports_worker_cancellation

Es un valor booleano; el valor predeterminado es True.

Es verdadero si JavaBuilder admite la cancelación de trabajadores persistentes y falso si no lo hace.
javac_supports_worker_multiplex_sandboxing

Es un valor booleano; el valor predeterminado es False.

Es verdadero si JavaBuilder admite la ejecución como un trabajador persistente multiplexado con zona de pruebas y falso si no es así.
javac_supports_workers

Es un valor booleano; el valor predeterminado es True.

Es verdadero si JavaBuilder admite la ejecución como un trabajador persistente y falso si no lo admite.
javacopts

Es una lista de cadenas. El valor predeterminado es [].

Es la lista de argumentos adicionales para el compilador de Java. Consulta la documentación del compilador de Java para obtener la lista extensa de las posibles marcas del compilador de Java.
jspecify_implicit_deps

Etiqueta (Label); el valor predeterminado es None

Experimental, no usar.
jspecify_javacopts

Es una lista de cadenas. El valor predeterminado es [].

Experimental, no usar.
jspecify_packages

Es una lista de etiquetas. El valor predeterminado es [].

Experimental, no usar.
jspecify_processor

Etiqueta (Label); el valor predeterminado es None

Experimental, no usar.
jspecify_processor_class

Cadena; el valor predeterminado es ""

Experimental, no usar.
jspecify_stubs

Es una lista de etiquetas. El valor predeterminado es [].

Experimental, no usar.
jvm_opts

Es una lista de cadenas. El valor predeterminado es [].

Es la lista de argumentos para la JVM cuando se invoca el compilador de Java. Consulta la documentación de la máquina virtual de Java para obtener la lista completa de marcas posibles para esta opción.
misc

Es una lista de cadenas. El valor predeterminado es [].

Obsoleto: Usa javacopts en su lugar.
oneversion

Etiqueta (Label); el valor predeterminado es None

Etiqueta del objeto binario de aplicación de una versión.
oneversion_allowlist

Etiqueta (Label); el valor predeterminado es None

Etiqueta de la lista de entidades permitidas de una versión.
oneversion_allowlist_for_tests

Etiqueta (Label); el valor predeterminado es None

Etiqueta de la lista de entidades permitidas de una versión para pruebas.
oneversion_whitelist

Etiqueta (Label); el valor predeterminado es None

Obsoleto: Usa oneversion_allowlist en su lugar
package_configuration

Es una lista de etiquetas. El valor predeterminado es [].

Es la configuración que se debe aplicar a los grupos de paquetes especificados.
proguard_allowlister

Etiqueta (Label); el valor predeterminado es "@bazel_tools//tools/jdk:proguard_whitelister"

Etiqueta del generador de listas de entidades permitidas de Proguard.
reduced_classpath_incompatible_processors

Es una lista de cadenas. El valor predeterminado es [].

API interna, no usar.
singlejar

Etiqueta (Label); el valor predeterminado es None

Etiqueta del jar de implementación de SingleJar.
source_version

Cadena; el valor predeterminado es ""

La versión de fuente de Java (p.ej., '6' o '7'). Especifica qué conjunto de estructuras de código se permite en el código fuente de Java.
target_version

Cadena; el valor predeterminado es ""

Es la versión de destino de Java (p.ej., '6' o '7'). Especifica para qué entorno de ejecución de Java se debe compilar la clase.
timezone_data

Etiqueta (Label); el valor predeterminado es None

Etiqueta de un archivo JAR de recursos que contiene datos de zona horaria. Si se establece, los datos de zona horaria se agregan como una dependencia implícita del entorno de ejecución de todas las reglas de java_binary.
tools

Es una lista de etiquetas. El valor predeterminado es [].

Etiquetas de herramientas disponibles para la expansión de etiquetas en jvm_opts.
turbine_data

Es una lista de etiquetas. El valor predeterminado es [].

Etiquetas de datos disponibles para la expansión de etiquetas en turbine_jvm_opts.
turbine_jvm_opts

Es una lista de cadenas. El valor predeterminado es [].

Es la lista de argumentos para la JVM cuando se invoca a turbine.
xlint

Es una lista de cadenas. El valor predeterminado es [].

Es la lista de advertencias que se agregarán o quitarán de la lista predeterminada. Se lo precede con un guion para quitarlo. Consulta la documentación de Javac sobre las opciones -Xlint para obtener más información.