Versions de Java dans les builds Android

Configuration du JDK Gradle dans Android Studio

Pour modifier la configuration JDK Gradle du projet existant, ouvrez les paramètres Gradle depuis File (ou Android Studio sous macOS) > Settings > Build, Execution, Deployment > Build Tools > 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 table JDK au format vendor-version, comme jbr-17, 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 du chemin JDK est utilisée pour exécuter Gradle lorsqu'il est démarré via Android Studio.

Les macros permettent de sélectionner dynamiquement le 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 est défini par défaut sur JetBrains Runtime.

Le JDK sélectionné est utilisé pour exécuter votre compilation Gradle et résoudre les références d'API JDK lorsque vous modifiez vos scripts de compilation et votre code source. Notez que le compileSdk spécifié limitera davantage les symboles Java disponibles lors de la modification et de la compilation de votre code source.

Veillez à choisir une version du JDK supérieure ou égale à celle utilisée 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 version 8.x nécessite JDK 17. Si vous essayez d'exécuter une compilation 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/jdk
      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 le cadre de ses 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.

android {
    ...
    compileSdk = 33
}

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 utiliser l'API dans la version antérieure d'Android grâce à un processus appelé désucrage. Pour connaître les API compatibles, consultez API Java 11 ou version ultérieure disponibles via le désucrage.

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

Quel JDK compile mon code source Java ?

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

La chaîne d'outils est définie par défaut sur le JDK utilisé pour exécuter Gradle. Si vous utilisez la valeur par défaut et exécutez un build sur différentes machines (par exemple, votre machine locale et un serveur d'intégration continue distinct), les résultats de votre build peuvent différer si différentes versions de JDK sont utilisées.

Pour créer une compilation plus cohérente, vous pouvez spécifier explicitement une version de la chaîne d'outils Java. Spécifiez les éléments suivants :

• 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 la chaîne d'outils pour les appels à partir du code source.
• Compile la source Java à l'aide de sa version du 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 outil de résolution 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 dans 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 :

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

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

Cela fonctionne si votre source est en Kotlin, en Java ou dans les deux.

La version JDK de la chaîne d'outils peut être la même que celle utilisée pour exécuter Gradle, mais gardez à l'esprit qu'elles ont des objectifs différents.

Quelles fonctionnalités de langage source 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'affecte pas la source Kotlin.

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

android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_17
    }
}

android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_17
    }
}

Si aucune valeur n'est spécifiée, cette propriété est définie par défaut sur la version de la chaîne d'outils Java. Si vous n'utilisez pas de chaîne d'outils Java, la version par défaut est celle choisie par le plug-in Android Gradle (par exemple, Java 8 ou version ultérieure).

Quelles fonctionnalités binaires Java puis-je utiliser lorsque je compile ma source Kotlin ou Java ?

Les propriétés targetCompatibility et jvmTarget déterminent la version du format de classe Java utilisée lors de la génération du bytecode pour les sources Java et Kotlin compilées, respectivement.

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

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

Notez que targetCompatibility doit être supérieur ou égal à sourceCompatibility. En pratique, sourceCompatibility, targetCompatibility et jvmTarget doivent généralement utiliser la même valeur. Vous pouvez les définir comme suit :

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

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

Si aucune valeur n'est spécifiée, ces propriétés sont définies par défaut sur la version de la chaîne d'outils Java. Si vous n'utilisez pas de chaîne d'outils Java, les valeurs par défaut peuvent être différentes et entraîner des problèmes de compilation. Par conséquent, nous vous recommandons de toujours spécifier explicitement ces valeurs ou d'utiliser une chaîne d'outils Java.