Versions de Java dans les builds Android

Que votre code source soit écrit en Java, en Kotlin ou en les deux, vous devez choisir une version du langage JDK ou Java pour votre build à plusieurs endroits.

Glossaire

Java Development Kit (JDK)

Le kit de développement Java (JDK) contient :

• Outils, tels qu'un compilateur, un profileur et un créateur d'archives Ils sont utilisés en arrière-plan lors de la compilation pour créer votre application.
• Bibliothèques contenant des API que vous pouvez appeler à partir de votre code source Kotlin ou Java. Notez que toutes les fonctions ne sont pas disponibles sur Android.
• La machine virtuelle Java (JVM), un interpréteur qui exécute des applications Java. Vous utiliserez la JVM pour exécuter l'IDE Android Studio et l'outil de compilation Gradle. La JVM n'est pas utilisée sur les appareils ou les émulateurs Android.

Environnement d'exécution JetBrains (JBR)

JetBrains Runtime (JBR) est un JDK amélioré, distribué avec Android Studio. Il inclut plusieurs optimisations à utiliser dans Studio et les produits JetBrains associés, mais peut également être utilisé pour exécuter d'autres applications Java.

Comment choisir un JDK pour exécuter Android Studio ?

Nous vous recommandons d'utiliser le JBR pour exécuter Android Studio. Il est déployé et utilisé pour tester Android Studio, et inclut des améliorations pour une utilisation optimale d'Android Studio. Pour ce faire, ne définissez pas la variable d'environnement STUDIO_JDK.

Les scripts de démarrage pour Android Studio recherchent une JVM dans l'ordre suivant:

1. Variable d'environnement STUDIO_JDK
2. Répertoire studio.jdk (dans la distribution Android Studio)
3. Répertoire jbr (environnement d'exécution JetBrains), dans la distribution Android Studio. Recommandé.
4. Variable d'environnement JDK_HOME
5. Variable d'environnement JAVA_HOME
6. Exécutable java dans la variable d'environnement PATH

Comment choisir le JDK qui exécute mes compilations Gradle ?

Si vous exécutez Gradle à l'aide des boutons d'Android Studio, le JDK défini dans les paramètres d'Android Studio est utilisé pour exécuter Gradle. Si vous exécutez Gradle dans un terminal, à l'intérieur ou à l'extérieur d'Android Studio, la variable d'environnement JAVA_HOME (si définie) détermine le JDK qui exécute les scripts Gradle. Si JAVA_HOME n'est pas défini, la commande java est exécutée sur la variable d'environnement PATH.

Pour obtenir des résultats plus cohérents, veillez à définir votre variable d'environnement JAVA_HOME et la configuration JDK Gradle dans Android Studio sur ce même JDK.

Remarque :Si vous exécutez une commande Gradle dans le terminal Android Studio en effectuant un clic droit et en sélectionnant Exécuter la commande en surbrillance à l'aide de l'IDE, le JDK est alors utilisé dans les paramètres d'Android Studio, et non JAVA_HOME.

Lors de l'exécution de votre compilation, Gradle crée un processus appelé daemon pour effectuer la compilation proprement dite. Ce processus peut être réutilisé, à condition que les compilations utilisent la même version du JDK et de Gradle. La réutilisation d'un daemon réduit le temps nécessaire au démarrage d'une nouvelle JVM et à l'initialisation du système de compilation.

Si vous lancez des compilations avec différentes versions de JDK ou de Gradle, des daemons supplémentaires sont créés, ce qui consomme plus de processeur et de mémoire.

Conseil :Lorsque vous travaillez simultanément sur plusieurs projets, si possible, spécifiez la même version de Gradle dans le fichier gradle-wrapper.properties afin de réduire le nombre de daemons Gradle créés.

Configuration du JDK Gradle dans Android Studio

Pour modifier la configuration du JDK Gradle du projet existant, ouvrez les paramètres Gradle en sélectionnant File (Fichier) (ou Android Studio sous macOS) > Settings > Build, Execution, Deployment > Build Tools > Gradle (Paramètres > Compilation, exécution, déploiement > Outils de compilation > Gradle). Le menu déroulant Gradle JDK (JDK Gradle) contient les options suivantes:

• Macros telles que JAVA_HOME et GRADLE_LOCAL_JAVA_HOME
• Entrées de la table JDK au format vendor-version, telles que jbr-17, qui sont stockées dans les fichiers de configuration Android
• Télécharger un JDK
• Ajouter un JDK spécifique
• JDK détectés localement à partir du répertoire d'installation JDK par défaut du système d'exploitation

L'option sélectionnée est stockée dans l'option gradleJvm du fichier .idea/gradle.xml du projet, et sa résolution de chemin d'accès JDK est utilisée pour exécuter Gradle lorsqu'il est lancé via Android Studio.

Image 1. Paramètres du JDK Gradle dans Android Studio.

Les macros permettent la sélection dynamique du chemin d'accès au JDK du projet:

• JAVA_HOME: utilise la variable d'environnement portant le même nom.
• GRADLE_LOCAL_JAVA_HOME: utilise la propriété java.home dans le fichier .gradle/config.properties, qui utilise par défaut l'environnement d'exécution JetBrains.

Le JDK sélectionné permet d'exécuter votre build Gradle et de résoudre les références de l'API JDK lors de la modification de vos scripts de compilation et de votre code source. Notez que le compileSdk spécifié limite davantage les symboles Java disponibles lors de la modification et de la création de votre code source.

Remarque :Dans la plupart des cas, nous vous recommandons d'utiliser GRADLE_LOCAL_JAVA_HOME, qui est la valeur par défaut pour les nouveaux projets. Cela vous permet de définir un JDK spécifique à un projet sans avoir à ouvrir le projet au préalable.

Veillez à choisir une version de JDK supérieure ou égale à celles utilisées par les plug-ins que vous utilisez dans votre build Gradle. Pour déterminer la version minimale requise du JDK pour le plug-in Android Gradle (AGP), consultez le tableau de compatibilité dans les notes de version.

Par exemple, le plug-in Android Gradle 8.x nécessite JDK 17. Si vous essayez d'exécuter un build Gradle qui l'utilise avec une version antérieure du JDK, un message semblable à celui-ci s'affiche:

An exception occurred applying plugin request [id: 'com.android.application']
> Failed to apply plugin 'com.android.internal.application'.
   > Android Gradle plugin requires Java 17 to run. You are currently using Java 11.
      Your current JDK is located in /usr/local/buildtools/java/jdk11
      You can try some of the following options:
       - changing the IDE settings.
       - changing the JAVA_HOME environment variable.
       - changing `org.gradle.java.home` in `gradle.properties`.

Quelles API Java puis-je utiliser dans mon code source Java ou Kotlin ?

Une application Android peut utiliser certaines des API définies dans un JDK, mais pas toutes. Le SDK Android définit les implémentations de nombreuses fonctions de la bibliothèque Java dans les API disponibles. La propriété compileSdk spécifie la version du SDK Android à utiliser lors de la compilation de votre code source Kotlin ou Java.

Kotlin

android {
    ...
    compileSdk = 33
}

Groovy

android {
    ...
    compileSdk 33
}

Chaque version d'Android est compatible avec une version spécifique du JDK et un sous-ensemble de ses API Java disponibles. Si vous utilisez une API Java disponible dans un compileSdk qui n'est pas disponible dans le minSdk spécifié, vous pourrez peut-être l'utiliser dans la version antérieure d'Android via un processus appelé désucrage. Consultez la section API Java 11 et versions ultérieures disponibles via le désucrage pour connaître les API compatibles.

Utilisez ce tableau pour déterminer quelle version de Java est compatible avec chaque API Android et où trouver des informations sur les API Java disponibles.

Android	Java	API et fonctionnalités de langage compatibles
14 (API 34)	17	Bibliothèques principales
13 (API 33)	11	Bibliothèques principales
12 (API 32)	11	API Java
11 et versions antérieures		Versions d'Android

Quel JDK compile mon code source Java ?

Le JDK de la chaîne d'outils Java contient le compilateur Java utilisé pour compiler le code source Java. Ce JDK exécute également Javadoc et des tests unitaires pendant la compilation.

Par défaut, la chaîne d'outils utilise le JDK utilisé pour exécuter Gradle. Si vous utilisez la version par défaut et exécutez une compilation sur différentes machines (par exemple, votre ordinateur local et un serveur d'intégration continue distinct), les résultats de votre compilation peuvent différer si des versions du JDK sont utilisées.

Pour créer une compilation plus cohérente, vous pouvez spécifier explicitement une version de chaîne d'outils Java. Spécifier ceci:

• localise un JDK compatible sur le système exécutant la compilation ;
  • Si aucun JDK compatible n'existe (et qu'un résolveur de chaîne d'outils est défini), il en télécharge un.
• Expose les API Java de chaîne d'outils pour les appels à partir du code source.
• Compile la source Java à l'aide de sa version en langage Java.
• Fournit les valeurs par défaut pour sourceCompatibility et targetCompatibility.

Nous vous recommandons de toujours spécifier la chaîne d'outils Java, et de vous assurer que le JDK spécifié est installé ou d'ajouter un résolveur de chaîne d'outils à votre build.

Vous pouvez spécifier la chaîne d'outils, que votre code source soit écrit en Java, en Kotlin ou les deux. Spécifiez la chaîne d'outils au niveau supérieur du fichier build.gradle(.kts) de votre module.

Spécifiez la version de la chaîne d'outils Java comme suit:

Kotlin

java {
    toolchain {
        languageVersion = JavaLanguageVersion.of(17)
    }
}

Groovy

java {
    toolchain {
        languageVersion = JavaLanguageVersion.of(17)
    }
}

Cela fonctionne si votre source est Kotlin, Java ou une combinaison des deux.

La version du JDK de la chaîne d'outils peut être identique à celle du JDK utilisé pour exécuter Gradle, mais gardez à l'esprit qu'elle a des objectifs différents.

Quelles fonctionnalités source du langage Java puis-je utiliser dans mon code source Java ?

La propriété sourceCompatibility détermine les fonctionnalités du langage Java disponibles lors de la compilation de la source Java. Cela n'a aucune incidence sur la source Kotlin.

Si aucune valeur n'est spécifiée, la chaîne d'outils Java ou le JDK utilisé pour exécuter Gradle est utilisé par défaut. Nous vous recommandons de toujours spécifier explicitement une chaîne d'outils (recommandé) ou sourceCompatibility.

Spécifiez sourceCompatibility dans le fichier build.gradle(.kts) de votre module.

Kotlin

android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_17
    }
}

Groovy

android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_17
    }
}

Remarque :Depuis Android Studio Giraffe, lorsque des projets sont importés, l'option sourceCompatibility est également utilisée par défaut pour l'assistance au code IDE et le linting lors de l'écriture de code source Java. Certaines fonctionnalités du langage Java nécessitent la compatibilité avec les bibliothèques et ne sont pas disponibles sur Android. L'option compileSdk détermine les bibliothèques disponibles. D'autres fonctionnalités, telles que les expressions switch, ne nécessitent que le compilateur Java et fonctionnent sur Android.

Quelles fonctionnalités binaires Java peuvent être utilisées lorsque je compile ma source Kotlin ou Java ?

Spécifier targetCompatibility et jvmTarget détermine la version au format de classe Java utilisée lors de la génération du bytecode pour la source Java et Kotlin compilée, respectivement.

Certaines fonctionnalités Kotlin existaient avant l'ajout de fonctionnalités Java équivalentes. Les premiers compilateurs Kotlin ont dû créer leur propre façon de représenter ces fonctionnalités Kotlin. Certaines de ces fonctionnalités ont ensuite été ajoutées à Java. Avec les niveaux jvmTarget ultérieurs, le compilateur Kotlin peut utiliser directement la fonctionnalité Java, ce qui peut améliorer les performances.

targetCompatibility est défini par défaut sur la même valeur que sourceCompatibility, mais si elle est spécifiée, elle doit être supérieure ou égale à sourceCompatibility.

jvmTarget utilise par défaut la version de la chaîne d'outils.

Les différentes versions d'Android sont compatibles avec différentes versions de Java. Vous pouvez bénéficier de fonctionnalités Java supplémentaires en augmentant targetCompatibility et jvmTarget, mais cela peut également vous obliger à augmenter la version minimale du SDK Android pour vous assurer que la fonctionnalité est disponible.

Kotlin

android {
    compileOptions {
        targetCompatibility = JavaVersion.VERSION_17
    }
    kotlinOptions {
        jvmTarget = "17"
    }
}

Groovy

android {
    compileOptions {
        targetCompatibility JavaVersion.VERSION_17
    }
    kotlinOptions {
        jvmTarget '17'
    }
}