Utilisation de Gradle

Modifier la page

Pour construire un projet Kotlin avec Gradle, vous devez appliquer le plugin Kotlin Gradle à votre projet et configurer les dépendances.

Plugin et versions

Appliquez le plugin Kotlin Gradle en utilisant le DSL des plugins Gradle.

Le plugin Kotlin Gradle 1.4.30 fonctionne avec Gradle 5.4 et plus. Le plugin kotlin-multiplatformnécessite Gradle 6.0 ou plus récent.

plugins { id 'org.jetbrains.kotlin.<...>' version '1.4.30'}

plugins { kotlin("<...>") version "1.4.30"}

Le caractère générique <...> doit être remplacé par l’un des noms de plugins que l’on trouve dans les sections suivantes.

Cibler plusieurs plateformes

Les projets ciblant plusieurs plateformes, appelés projets multiplateformes, nécessitent le plugin kotlin-multiplatform. En savoir plus sur ce plugin.

Le plugin kotlin-multiplatform fonctionne avec Gradle 6.0 ou plus récent.

plugins { id 'org.jetbrains.kotlin.multiplatform' version '1.4.30'}

plugins { kotlin("multiplatform") version "1.4.30"}

Cibler la JVM

Pour cibler la JVM, appliquez le plugin Kotlin JVM.

plugins { id "org.jetbrains.kotlin.jvm" version "1.4.30"}

plugins { kotlin("jvm") version "1.4.30"}

Le version doit être littéral dans ce bloc, et il ne peut pas être appliqué depuis un autre script de construction.

Alternativement, vous pouvez utiliser l’ancienne approche apply plugin:

apply plugin: 'kotlin'

Il n’est pas recommandé d’appliquer les plugins Kotlin avec apply dans Gradle Kotlin DSL – voir pourquoi.

Sources Kotlin et Java

Les sources Kotlin peuvent être stockées avec les sources Java dans le même dossier, ou placées dans des dossiers différents. La convention par défaut consiste à utiliser des dossiers différents :

project - src - main (root) - kotlin - java

La propriété sourceSets correspondante doit être mise à jour si l’on n’utilise pas la convention par défaut :

sourceSets { main.kotlin.srcDirs += 'src/main/myKotlin' main.java.srcDirs += 'src/main/myJava'}

sourceSets.main { java.srcDirs("src/main/myJava", "src/main/myKotlin")}

Cibler JavaScript

Lorsque l’on cible uniquement JavaScript, il faut utiliser le plugin kotlin-js. En savoir plus

plugins { id 'org.jetbrains.kotlin.js' version '1.4.30'}

plugins { kotlin("js") version "1.4.30"}

Sources Kotlin et Java

Ce plugin ne fonctionne que pour les fichiers Kotlin, il est donc recommandé de conserver les fichiers Kotlin et Java séparément (au cas où le projet contient des fichiers Java). Si vous ne les stockez pas séparément , spécifiez le dossier source dans le bloc sourceSets:

kotlin { sourceSets { main.kotlin.srcDirs += 'src/main/myKotlin' }}

kotlin { sourceSets.apply { kotlin.srcDir("src/main/myKotlin") }}

Targeting Android

Il est recommandé d’utiliser Android Studio pour créer des applications Android. Apprenez à utiliser le plugin Android Gradle.

Configurer les dépendances

Pour ajouter une dépendance à une bibliothèque, définissez la dépendance du type requis (par exemple, implementation) dans le bloc dependencies du DSL des ensembles de sources.

kotlin { sourceSets { commonMain { dependencies { implementation 'com.example:my-library:1.0' } } }}

kotlin { sourceSets { val commonMain by getting { dependencies { implementation("com.example:my-library:1.0") } } }}

Alternativement, vous pouvez définir des dépendances au niveau supérieur.

Types de dépendance

Choisissez le type de dépendance en fonction de vos besoins.

Dépendance de la bibliothèque standard

Une dépendance d’une bibliothèque standard (stdlib) dans chaque ensemble de sources est ajoutée automatiquement. La version de la bibliothèque standard est la même que la version du plugin Kotlin Gradle.

Pour les ensembles de sources spécifiques à une plateforme, la variante de la bibliothèque spécifique à la plateforme correspondante est utilisée, tandis qu’une bibliothèque standard commune est ajoutée au reste. Le plugin Kotlin Gradle sélectionnera la bibliothèque standard JVM appropriée en fonction de l’option de compilation kotlinOptions.jvmTarget de votre script de construction Gradle.

Si vous déclarez explicitement une dépendance de bibliothèque standard (par exemple, si vous avez besoin d’une version différente), le plugin Kotlin Gradle ne la remplacera pas ou n’ajoutera pas une deuxième bibliothèque standard.

Si vous n’avez pas du tout besoin d’une bibliothèque standard, vous pouvez ajouter le drapeau d’exclusion au gradle.properties:

kotlin.stdlib.default.dependency=false

Déclarer les dépendances des bibliothèques de test

L’API kotlin.test est disponible pour tester différents projets Kotlin.

Ajouter les dépendances correspondantes sur les bibliothèques de test :

• Pour commonTest, ajouter les dépendances kotlin-test-common et kotlin-test-annotations-common.
• Pour les cibles JVM, utilisez kotlin-test-junit ou kotlin-test-testng pour l’implémentation de l’asserteur correspondant et le mappage des annotations.
• Pour les cibles Kotlin/JS, ajoutez kotlin-test-js comme dépendance de test.

Les cibles Kotlin/Natives ne nécessitent pas de dépendances de test supplémentaires, et les implémentations de l’API kotlin.test sont intégrées.

Vous pouvez utiliser un raccourci pour une dépendance sur un module Kotlin, par exemple, kotlin(« test ») pour « org.jetbrains.kotlin:kotlin-test ».

Définir une dépendance sur une bibliothèque kotlinx

Si vous utilisez une bibliothèque kotlinx et que vous avez besoin d’une dépendance spécifique à la plateforme, vous pouvez utiliser des variantes de bibliothèques spécifiques à la plateforme avec des suffixes tels que -jvm ou -js, par exemple, kotlinx-coroutines-core-jvm. Vous pouvez également utiliser le nom d’artefact de base de la bibliothèque à la place – kotlinx-coroutines-core.

kotlin { sourceSets { jvmMain { dependencies { implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.4.2' } } }}

Si vous utilisez une bibliothèque multiplateforme et que vous avez besoin de dépendre du code partagé, définissez la dépendance une seule fois dans le jeu de sources partagées. Utilisez le nom d’artefact de base de la bibliothèque, tel que kotlinx-coroutines-core ou ktor-client-core.

kotlin { sourceSets { commonMain { dependencies { implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.4.2' } } }}

Définir les dépendances au niveau supérieur

Alternativement, vous pouvez spécifier les dépendances au niveau supérieur avec les noms de configuration suivant le modèle <sourceSetName><DependencyType>. Ceci est utile pour certaines dépendances intégrées à Gradle, comme gradleApi(), localGroovy(), ou gradleTestKit(), qui ne sont pas disponibles dans le DSL de dépendance des ensembles de sources.

dependencies { commonMainImplementation 'com.example:my-library:1.0'}

dependencies { "commonMainImplementation"("com.example:my-library:1.0")}

compileKotlin { kotlinOptions.suppressWarnings = true}//orcompileKotlin { kotlinOptions { suppressWarnings = true }}

tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).configureEach { kotlinOptions { /*...*/ }}

tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile>().configureEach { kotlinOptions { /*...*/ }}