Utiliser des polices téléchargeables

Essayez Compose

Jetpack Compose est le kit d'outils d'interface utilisateur recommandé pour Android. Découvrez comment utiliser du texte dans Compose.

Polices téléchargeables →

La fonctionnalité Polices téléchargeables permet aux API de demander des polices à une application de fournisseur au lieu de regrouper des fichiers dans l'application ou de laisser l'application télécharger des polices. Les polices téléchargeables sont disponibles sur les appareils exécutant les versions 14 et ultérieures de l'API Android via la bibliothèque AndroidX Core.

Les polices téléchargeables offrent les avantages suivants :

• Réduction de la taille de l'application, ce qui augmente le taux de réussite de l'installation.
• Amélioration de l'état général du système, car plusieurs applications peuvent partager la même police via un fournisseur. Cela permet aux utilisateurs d'économiser des données mobiles, de la mémoire de téléphone et de l'espace disque. Dans ce modèle, la police est récupérée sur le réseau si nécessaire.

Comment fonctionnent les polices téléchargeables ?

Un fournisseur de polices est une application qui récupère les polices et les met en cache localement afin que d'autres applications puissent les demander et les partager. L'illustration suivante montre le processus.

Principes de base

Vous pouvez utiliser la fonctionnalité Polices téléchargeables de différentes manières, qui sont décrites en détail dans les sections suivantes :

• Utiliser Android Studio et les services Google Play
• Par programmation
• Utiliser la bibliothèque AndroidX Core

Utiliser les polices téléchargeables avec Android Studio et les services Google Play

Vous pouvez configurer votre application pour qu'elle télécharge des polices à l'aide d'Android Studio 3.0 ou version ultérieure. Pour vous aider à démarrer avec les fonctionnalités des polices téléchargeables, vous pouvez utiliser le fournisseur de polices des services Google Play.

1. Dans l'éditeur de mise en page, sélectionnez un TextView. Ensuite, sous Attributs, sélectionnez fontFamily > Autres polices.

   

   La fenêtre Ressources s'affiche.
2. Dans le menu Source, sélectionnez Google Fonts.
3. Dans la zone Polices, sélectionnez une police dans la zone "Téléchargeable".
4. Sélectionnez Créer une police téléchargeable , puis cliquez sur OK.

   

Android Studio génère automatiquement les fichiers XML pertinents nécessaires pour afficher correctement la police dans votre application.

Utiliser les polices téléchargeables par programmation

Depuis Android 8.0 (niveau d'API 26), AndroidX Core offre une prise en charge complète des polices téléchargeables. Pour en savoir plus sur l'utilisation de la bibliothèque AndroidX Core, consultez la section Bibliothèque AndroidX Core pour les polices téléchargeables sur cette page.

Pour utiliser la fonctionnalité Polices téléchargeables par programmation, interagissez avec deux classes clés :

• android.graphics.fonts.FontRequest: cette classe vous permet de créer une requête de police.
• FontsContractCompat: cette classe vous permet de créer un nouvel Typeface objet basé sur la requête de police.

Votre application récupère les polices auprès du fournisseur de polices à l'aide de l'API FontsContract. Chaque fournisseur a son propre ensemble de restrictions concernant les versions d'Android et le langage de requête qu'il prend en charge. Pour en savoir plus sur les versions d'Android et le format de requête, consultez la documentation de votre fournisseur.

Pour télécharger une police, procédez comme suit :

1. Créez une instance de la classe android.graphics.fonts.FontRequest pour demander la police au fournisseur. Pour créer une requête, transmettez les paramètres suivants :
   • Autorité du fournisseur de polices.
   • Package du fournisseur de polices permettant de vérifier l'identité du fournisseur.
   • Requête de chaîne de la police. Pour en savoir plus sur les formats de requête, consultez la documentation de votre fournisseur de polices, par exemple Google Fonts.
   • Liste d'ensembles de hachages des certificats permettant de vérifier l'identité du fournisseur.

   Kotlin

   val request = FontRequest(
           "com.example.fontprovider.authority",
           "com.example.fontprovider",
           "my font",
           certs
   )

   Java

   FontRequest request = new FontRequest("com.example.fontprovider",
                      "com.example.fontprovider", "my font", certs);

2. Créez une instance de la FontsContract.FontRequestCallback classe.
3. Remplacez la onTypefaceRetrieved() méthode pour indiquer que la requête de police est terminée. Fournissez la police récupérée comme paramètre. Vous pouvez utiliser cette méthode pour définir la police selon vos besoins. Par exemple, vous pouvez définir la police sur un TextView.
4. Remplacez la onTypefaceRequestFailed() méthode pour recevoir des informations sur les erreurs survenues lors du processus de requête de police. Pour en savoir plus sur les codes d'erreur, consultez les constantes de code d'erreur.
5. Appelez la méthode FontsContract.requestFont() pour récupérer la police auprès du fournisseur de polices. La méthode lance une vérification pour déterminer si la police existe dans le cache. Si la police n'est pas disponible localement, elle appelle le fournisseur de polices, récupère la police de manière asynchrone et transmet le résultat au rappel. Transmettez les paramètres suivants :
   • Une instance de la Context classe
   • Une instance de la classe android.graphics.fonts.FontRequest
   • Un rappel pour recevoir les résultats de la requête de police
   • Un gestionnaire pour récupérer les polices sur un thread

L'exemple de code suivant illustre le processus global des polices téléchargeables :

val request = FontRequest(
        "com.example.fontprovider.authority",
        "com.example.fontprovider",
        "my font",
        certs
)
val callback = object : FontsContract.FontRequestCallback() {

    override fun onTypefaceRetrieved(typeface: Typeface) {
        // Your code to use the font goes here.
        ...
    }

    override fun onTypefaceRequestFailed(reason: Int) {
        // Your code to deal with the failure goes here.
        ...
    }
}
FontsContract.requestFonts(context, request, handler, null, callback)

FontRequest request = new FontRequest("com.example.fontprovider.authority",
        "com.example.fontprovider", "my font", certs);
FontsContract.FontRequestCallback callback =
    new FontsContract.FontRequestCallback() {
        @Override
        public void onTypefaceRetrieved(Typeface typeface) {
            // Your code to use the font goes here.
            ...
        }

        @Override
        public void onTypefaceRequestFailed(int reason) {
            // Your code to deal with the failure goes here.
            ...
        }
};
FontsContract.requestFonts(context, request, handler, null, callback);

Pour en savoir plus sur le téléchargement d'une police auprès d'un fournisseur de polices, consultez l' application exemple DownloadableFonts.

Utiliser les polices téléchargeables avec AndroidX Core

AndroidX Core prend en charge la fonctionnalité Polices téléchargeables sur les appareils exécutant les versions 14 ou ultérieures de l' API Android. Le package androidx.core.provider contient les classes FontsContractCompat et FontRequest pour implémenter la prise en charge de la fonctionnalité Polices téléchargeables rétrocompatible. Les classes AndroidX contiennent des méthodes semblables aux méthodes du framework, et le processus de téléchargement des polices est semblable à celui décrit dans la section de cette page sur l'utilisation des polices téléchargeables par programmation.

Pour télécharger des polices à l'aide d'AndroidX, importez les classes FontsContractCompat et FontRequest à partir du package androidx.core.provider. Créez des instances de ces classes au lieu des classes de framework FontsContract et android.graphics.fonts.FontRequest.

Ajouter une dépendance AndroidX Core

Pour utiliser les classes FontsContractCompat et FontRequest, vous devez modifier les dépendances de chemin de classe du projet de votre application dans votre environnement de développement.

Pour ajouter AndroidX Core au projet de votre application, ajoutez la dépendance suivante au fichier build.gradle de votre application :

dependencies {
    ...
    implementation "androidx.core:core-ktx:1.18.0"
}

dependencies {
    ...
    implementation("androidx.core:core-ktx:1.18.0")
}

Utiliser les polices téléchargeables comme ressources en XML

Android 8.0 (niveau d'API 26) et AndroidX Core offrent un moyen plus rapide et plus pratique de déclarer une police personnalisée en tant que ressource dans la mise en page XML. Cela signifie qu'il n'est pas nécessaire de regrouper la police en tant qu'élément. Vous pouvez définir une police personnalisée pour l'ensemble de votre thème, ce qui accélère l'utilisation pour plusieurs épaisseurs et styles, tels que le gras, le moyen ou le clair, lorsqu'ils sont fournis.

1. Créez un fichier XML dans le dossier res/font.
2. Ajoutez un élément racine <font-family> et définissez les attributs liés à la police, comme indiqué dans l'exemple de fichier XML suivant :

<?xml version="1.0" encoding="utf-8"?>
<font-family xmlns:android="http://schemas.android.com/apk/res/android"
        android:fontProviderAuthority="com.example.fontprovider.authority"
        android:fontProviderPackage="com.example.fontprovider"
        android:fontProviderQuery="example font"
        android:fontProviderCerts="@array/certs">
</font-family>

3. Faites référence au fichier en tant que @font/font_file_name dans le fichier XML de mise en page. Vous pouvez également utiliser la getFont() méthode pour récupérer le fichier par programmation, par exemple getFont(R.font.font_file_name).

Prédéclarer des polices dans le fichier manifeste

L'inflation de la mise en page et la récupération des ressources sont des tâches synchrones. Par défaut, la première tentative de récupération des polices déclenche une requête auprès du fournisseur de polices, ce qui augmente le temps de la première mise en page. Pour éviter ce délai, vous pouvez prédéclarer les polices à récupérer dans votre fichier manifeste. Une fois que le système a récupéré la police auprès du fournisseur, elle est disponible immédiatement. Si la récupération de la police prend plus de temps que prévu, le système abandonne le processus de récupération et utilise la police par défaut.

Pour prédéclarer des polices dans le fichier manifeste, procédez comme suit :

1. Créez un tableau de ressources dans res/values/arrays.xml et déclarez les polices que vous souhaitez précharger.

res/values/arrays.xml
<?xml version="1.0" encoding="utf-8"?>
<resources>
    <array name="preloaded_fonts">
        <item>@font/font1</item>
        <item>@font/font2</item>
    </array>
</resources>

2. Utilisez une balise meta-data pour déclarer le tableau de ressources dans votre fichier manifeste.

<meta-data android:name="preloaded_fonts" android:resource="@array/preloaded_fonts" />

Ajouter des certificats

Lorsqu'un fournisseur de polices n'est pas préinstallé ou si vous utilisez la bibliothèque AndroidX Core, déclarez les certificats avec lesquels le fournisseur de polices est signé. Le système utilise les certificats pour vérifier l'identité du fournisseur de polices.

Pour ajouter des certificats, procédez comme suit :

1. Créez un tableau de chaînes contenant les détails du certificat. Pour en savoir plus sur les détails du certificat, consultez la documentation de votre fournisseur de polices.

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string-array name="certs">
       <item>MIIEqDCCA5CgAwIBAgIJA071MA0GCSqGSIb3DQEBBAUAMIGUMQsww...</item>
    </string-array>
</resources>

2. Définissez l'attribut fontProviderCerts sur le tableau.

android:fontProviderCerts="@array/certs"

Polices téléchargeables dans Compose