Publier plusieurs bibliothèques Android en une seule avec la bibliothèque fusionnée

Dans les projets comportant de nombreux modules, il peut être difficile de distribuer des bibliothèques Android à vos utilisateurs tout en essayant de maintenir une structure de projet claire. Dans de nombreux cas, un nombre de bibliothèques beaucoup plus élevé que prévu doit être publié.

Le plug-in Fused Library fourni avec le plug-in Android Gradle permet d'empaqueter plusieurs modules de bibliothèque Android dans une seule bibliothèque Android publiable. Cela vous permet de modulariser le code source et les ressources de votre bibliothèque dans votre build comme vous le souhaitez, tout en évitant d'exposer la structure de votre projet une fois distribué.

Distribuer le code en tant que bibliothèque unique peut présenter les avantages suivants :

• Dépendances simplifiées : remplace plusieurs dépendances de bibliothèque par une seule AAR, ce qui simplifie la configuration du projet et la gestion des versions pour vos utilisateurs.
• Taille de bibliothèque réduite : peut améliorer la minification du code, ce qui permet d'obtenir des fichiers AAR plus petits.
• Sécurité améliorée : permet de mieux contrôler les détails d'implémentation interne des bibliothèques publiées.

Créer une bibliothèque fusionnée

Pour créer une bibliothèque fusionnée, vous devez créer un module Android, ajouter des dépendances, puis publier la bibliothèque fusionnée.

Ajouter un module de bibliothèque fusionné

Pour utiliser le plug-in, vous devez ajouter un module Android à votre projet :

Dans cet exemple, le module de bibliothèque fusionnée sera appelé myFusedLibrary.

1. Activez la prise en charge de la bibliothèque fusionnée en ajoutant android.experimental.fusedLibrarySupport=true au fichier gradle.properties.
2. Ajoutez include(":myFusedLibrary") au fichier settings.gradle.kts.
3. Ajoutez android-fusedlibrary = { id = "com.android.fused-library", version.ref = "agp" } sous la section [plugins] du fichier gradle/libs.versions.toml.
4. Ajoutez alias(libs.plugins.android.fusedlibrary) apply false dans le bloc "plugins" du fichier build.gradle.kts de premier niveau.
5. Pour créer le module myFusedLibrary, créez un répertoire nommé myFusedLibrary (effectuez un clic droit sur "My Application" (Mon application) > New (Nouveau) > Directory (Répertoire)).
6. Créez un fichier build.gradle.kts dans le module myFusedLibrary (effectuez un clic droit sur le module myFusedLibrary > Nouveau > Fichier).
7. Collez ce qui suit dans le fichier myFusedLibrary/build.gradle.kts :

plugins {
    alias(libs.plugins.android.fusedlibrary)
    `maven-publish`
}

androidFusedLibrary {
    namespace = "com.example.myFusedLibrary"
    minSdk = 21
}

dependencies { }

plugins {
    id 'fused-library'
}

androidFusedLibrary {
    namespace 'com.example.myFusedLibrary'
    minSdk 21
}

dependencies {

}

Ajouter des dépendances

La fonctionnalité principale de la bibliothèque fusionnée est de regrouper les dépendances. Le plug-in permet d'ajouter des dépendances de projet local et des bibliothèques externes. Pour spécifier les dépendances à inclure dans le package, utilisez la configuration include. Les dépendances transitives ne sont pas empaquetées.

Exemple :

dependencies {
    include(project(":image-rendering"))
    include("mycoolfonts:font-wingdings:5.0")
}

dependencies {
    include project(':image-rendering')
    include 'mycoolfonts:font-wingdings:5.0'
}

Publier votre bibliothèque fusionnée

Avant de publier une bibliothèque fusionnée, vous devez vous familiariser avec la publication d'une bibliothèque Android. La publication d'une bibliothèque fusionnée est semblable à celle d'une bibliothèque Android. Toutefois, vous devez tenir compte de certaines différences clés pour publier correctement la bibliothèque fusionnée :

• Le plug-in Maven Publish doit également être appliqué à tout module auquel le plug-in FusedLibrary est appliqué.
• La publication doit hériter de fusedLibraryComponent, car cela fournit les dépendances requises pour compiler l'artefact de la bibliothèque fusionnée.

Voici un exemple de configuration de publications :

plugins {
    alias(libs.plugins.android.fusedlibrary)
    `maven-publish`
}

androidFusedLibrary { … }

dependencies { … }

publishing {
    publications {
        register<MavenPublication>("release") {
             groupId = "my-company"
             artifactId = "my-fused-library"
             version = "1.0"
             from(components["fusedLibraryComponent"])
        }
    }
}

plugins {
    id 'fused-library'
    id 'maven-publish'
}

androidFusedLibrary { … }

dependencies { … }

publishing {
    publications {
        release(MavenPublication) {
            groupId = "my-company"
            artifactId = "my-fused-library"
            version = "1.0"
            afterEvaluate {
            from components.fusedLibraryComponent
        }
    }
}

Publier votre bibliothèque fusionnée pour les tests

Vous devez effectuer des tests en fonction d'une bibliothèque fusionnée publiée à partir d'une application ou d'une bibliothèque Android. La méthode recommandée consiste à publier la bibliothèque fusionnée et ses dépendances de projet dans un dépôt Maven local.

Pour publier les artefacts de la bibliothèque fusionnée dans un dépôt local, définissez une configuration semblable à la suivante :

plugins {
    alias(libs.plugins.android.fusedlibrary)
    `maven-publish`
}

repositories {
    maven {
        name = "myLocalRepo"
        url = uri(layout.buildDirectory.dir("myLocalRepo"))
    }
}

plugins {
    id 'fused-library'
    id 'maven-publish'
}

repositories {
    maven {
        name 'myLocalRepo'
        url layout.buildDirectory.dir('myLocalRepo')
    }
}

Importer votre bibliothèque fusionnée

Pour distribuer votre bibliothèque fusionnée, consultez Importer votre bibliothèque.

Comportement et mesures de protection

La combinaison de bibliothèques Android présente des subtilités qui peuvent rendre difficile pour le plug-in de raisonner sur les priorités. Par exemple, deux bibliothèques avec le même chemin d'accès aux classes entraîneront un échec de compilation lors de la fusion de la bibliothèque. La fusion des ressources tiendra compte de l'ordre des dépendances spécifié lors de la sélection d'une ressource portant le même nom dans différentes bibliothèques.

• Les bibliothèques fusionnées ne peuvent être publiées que sous forme d'artefact de bibliothèque Android AAR pour pouvoir être ajoutées en tant que dépendance.
• La fusion de bibliothèques qui utilisent la liaison de données n'est pas prise en charge.
• Vous ne pouvez pas fusionner plusieurs types de compilation et saveurs de produit dans une même bibliothèque fusionnée. Créez des bibliothèques fusionnées distinctes pour différentes variantes.

Pour équilibrer la quantité de configuration nécessaire et la facilité d'utilisation, le plug-in échouera à la compilation en cas de conflits ambigus ou utilisera des heuristiques lors de la fusion des artefacts. Le tableau suivant explique comment les artefacts sont fusionnés :

 androidFusedLibrary { aarMetadata { minCompileSdk = 21 minCompileSdkExtension = 1 } }

Problèmes connus

Fused Library est un nouveau plug-in. Des problèmes connus sont en cours de résolution pour répondre à tous les cas d'utilisation.

• Impossible de générer les fichiers JAR sources
• Ajouter des dépendances de fichier sur d'autres fichiers .aar
• Incompatibilité avec la fusion des artefacts RenderScript et Prefab

Comprendre les dépendances d'une bibliothèque fusionnée

La bibliothèque fusionnée n'a pas de sources et utilise efficacement les bibliothèques Android comme seule source. Il est important de comprendre d'où proviennent les éléments. Pour lister les dépendances fusionnées dans l'artefact résultant et les dépendances nécessaires à la création de l'artefact, exécutez la tâche gradle :report sur la bibliothèque fusionnée. Les tâches génèrent un rapport JSON qui est enregistré dans le répertoire build/reports de la bibliothèque fusionnée.

Pour en savoir plus sur les dépendances de plug-in internes, exécutez la tâche gradle :dependencies pour afficher l'état des configurations de plug-in.