Configuration de la bibliothèque Support

Remarque : Avec la sortie d'Android 9.0 (niveau d'API 28), une nouvelle version de la bibliothèque Support appelée AndroidX, qui fait partie de Jetpack, est disponible. La bibliothèque AndroidX contient la bibliothèque d'assistance existante et inclut également les derniers composants Jetpack.

Vous pouvez continuer à utiliser la bibliothèque d'assistance. Les anciens artefacts (ceux dont la version est 27 ou antérieure et qui sont empaquetés en tant que android.support.*) resteront disponibles sur Google Maven. Toutefois, tous les nouveaux développements de la bibliothèque auront lieu dans la bibliothèque AndroidX.

Nous vous recommandons d'utiliser les bibliothèques AndroidX dans tous les nouveaux projets. Vous devriez également envisager de migrer les projets existants vers AndroidX.

La façon dont vous configurez les bibliothèques Android Support dans votre projet de développement dépend des fonctionnalités que vous souhaitez utiliser et de la plage de versions de la plate-forme Android que vous souhaitez prendre en charge avec votre application.

Ce document vous explique comment télécharger le package de la bibliothèque d'assistance et ajouter des bibliothèques à votre environnement de développement.

Les bibliothèques d'assistance sont désormais disponibles dans le dépôt Maven de Google. Nous ne prenons plus en charge le téléchargement des bibliothèques via le SDK Manager, et cette fonctionnalité sera bientôt supprimée.

Choisir des bibliothèques d'assistance

Avant d'ajouter une bibliothèque Support à votre application, déterminez les fonctionnalités que vous souhaitez inclure et les versions d'Android les plus anciennes que vous souhaitez prendre en charge. Pour en savoir plus sur les fonctionnalités fournies par les différentes bibliothèques, consultez Fonctionnalités de la bibliothèque Support.

Ajouter des bibliothèques Support

Pour utiliser une bibliothèque Support, vous devez modifier les dépendances de chemin de classe du projet de votre application dans votre environnement de développement. Vous devez effectuer cette procédure pour chaque bibliothèque Support que vous souhaitez utiliser.

Pour ajouter une bibliothèque d'assistance à votre projet d'application :

  1. Incluez le dépôt Maven de Google dans le fichier settings.gradle de votre projet.
    dependencyResolutionManagement {
        repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
        repositories {
            google()
    
            // If you're using a version of Gradle lower than 4.1, you must
            // instead use:
            //
            // maven {
            //     url 'https://maven.google.com'
            // }
        }
    }
  2. Pour chaque module dans lequel vous souhaitez utiliser une bibliothèque Support, ajoutez la bibliothèque dans le bloc dependencies du fichier build.gradle du module. Par exemple, pour ajouter la bibliothèque v4 core-utils, ajoutez ce qui suit :
    dependencies {
        ...
        implementation "com.android.support:support-core-utils:28.0.0"
    }

Attention : L'utilisation de dépendances dynamiques (par exemple, palette-v7:23.0.+) peut entraîner des mises à jour de version inattendues et des incompatibilités de régression. Nous vous recommandons de spécifier explicitement une version de bibliothèque (par exemple, palette-v7:28.0.0).

Utiliser les API de la bibliothèque Support

Les classes de la bibliothèque Support qui fournissent une assistance pour les API de framework existantes portent généralement le même nom que la classe de framework, mais se trouvent dans les packages de classe android.support ou comportent un suffixe *Compat.

Attention : Lorsque vous utilisez des classes de la bibliothèque Support, assurez-vous d'importer la classe à partir du package approprié. Par exemple, lorsque vous appliquez la classe ActionBar :

  • android.support.v7.app.ActionBar lorsque vous utilisez la bibliothèque Support.
  • android.app.ActionBar lorsque vous développez uniquement pour le niveau d'API 11 ou supérieur.

Remarque : Après avoir inclus la bibliothèque Support dans le projet de votre application, nous vous recommandons vivement de réduire, d'obfusquer et d'optimiser votre application pour la publication. En plus de protéger votre code source avec l'obscurcissement, la réduction supprime les classes inutilisées des bibliothèques que vous incluez dans votre application, ce qui permet de maintenir la taille de téléchargement de votre application aussi petite que possible.

Vous trouverez d'autres conseils sur l'utilisation de certaines fonctionnalités de la bibliothèque Support dans les cours de formation, les guides et les exemples pour les développeurs Android. Pour en savoir plus sur les classes et méthodes individuelles de la bibliothèque d'assistance, consultez les packages android.support dans la documentation de référence de l'API.

Modifications apportées à la déclaration du fichier manifeste

Si vous augmentez la rétrocompatibilité de votre application existante avec une version antérieure de l'API Android à l'aide de la bibliothèque Support, veillez à mettre à jour le fichier manifeste de votre application. Plus précisément, vous devez remplacer l'élément android:minSdkVersion de la balise <uses-sdk> dans le fichier manifeste par le nouveau numéro de version inférieur, comme indiqué ci-dessous :

  <uses-sdk
      android:minSdkVersion="14"
      android:targetSdkVersion="23" />

Le paramètre du fichier manifeste indique à Google Play que votre application peut être installée sur des appareils équipés d'Android 4.0 (niveau d'API 14) ou version ultérieure.

Si vous utilisez des fichiers de compilation Gradle, le paramètre minSdkVersion du fichier de compilation remplace les paramètres du fichier manifeste.

plugins {
  id 'com.android.application'
}

android {
    ...

    defaultConfig {
        minSdkVersion 16
        ...
    }
    ...
}

Dans ce cas, le paramètre du fichier build indique à Google Play que la variante de build par défaut de votre application peut être installée sur les appareils équipés d'Android 4.1 (niveau d'API 16) ou version ultérieure. Pour en savoir plus sur les variantes de compilation, consultez Présentation du système de compilation.

Remarque : Si vous incluez plusieurs bibliothèques d'assistance, la version minimale du SDK doit être la version la plus élevée requise par l'une des bibliothèques spécifiées. Par exemple, si votre application inclut à la fois la bibliothèque de compatibilité des préférences v14 et la bibliothèque Leanback v17, votre version minimale du SDK doit être 17 ou supérieure.