Configurer une application cliente Firebase Cloud Messaging sur Android

Pour écrire votre Firebase cloud messagerie Android application client, utilisez le FirebaseMessaging API et Android 1.4 ou supérieur studio avec Gradle. Les instructions contenues dans cette page supposent que vous avez terminé les étapes pour ajouter Firebase à votre projet Android .

Les clients FCM nécessitent des appareils exécutant Android 4.1 ou une version ultérieure sur lesquels l'application Google Play Store est également installée, ou un émulateur exécutant Android 4.1 avec les API Google. Notez que vous n'êtes pas limité au déploiement de vos applications Android via Google Play Store.

Configurer le SDK

Cette section couvre les tâches que vous avez peut-être effectuées si vous avez déjà activé d'autres fonctionnalités Firebase pour votre application.

Avant que tu commences

• Installer ou mettre à jour Android Studio est à sa dernière version.

• Assurez-vous que votre projet répond aux exigences suivantes :

  • Cible API niveau 16 (Jelly Bean) ou supérieur
  • Utilise Android 4.1 ou supérieur
  • Utilise Jetpack (AndroidX) , qui comprend la réalisation de ces exigences de version:
    • com.android.tools.build:gradle v3.2.1 ou plus tard
    • compileSdkVersion 28 ou plus tard

• Mettre en place un dispositif physique ou utiliser un émulateur pour exécuter votre application.
  Notez que Firebase avec une dépendance SDKs sur les services Google Play nécessitent l'appareil ou émulateur pour avoir des services Google Play installés.

• Connectez - vous à Firebase en utilisant votre compte Google.

Si vous ne possédez pas déjà un projet Android et que vous voulez juste essayer un produit Firebase, vous pouvez télécharger un de nos échantillons de démarrage rapide .

Créer un projet Firebase

Avant de pouvoir ajouter Firebase à votre application Android, vous devez créer un projet Firebase pour vous connecter à votre application Android. Visitez Comprendre Firebase projets pour en savoir plus sur les projets Firebase.

Enregistrez votre application avec Firebase

Pour utiliser Firebase dans votre application Android, vous devez enregistrer votre application avec votre projet Firebase. L'enregistrement de votre application est souvent appelé "ajout" de votre application à votre projet.

1. Allez à la console Firebase .

2. Au centre de la page d'aperçu du projet, cliquez sur l'icône Android ( plat_android ) ou Ajouter application pour lancer le flux de travail de configuration.

3. Entrez le nom du package de votre application dans le champ Nom du package Android.

   Qu'est-ce qu'un nom de package et où le trouvez-vous ?

   • Un nom de package identifie de manière unique votre application sur l'appareil et dans le Google Play Store.

   • Un nom de package est souvent désigné comme un ID d'application.

   • Trouvez votre nom de package d'application dans votre module (niveau d'application) de fichier Gradle, généralement app/build.gradle ( par exemple nom du package: com.yourcompany.yourproject ).

   • Sachez que la valeur du nom du package est sensible à la casse et qu'elle ne peut pas être modifiée pour cette application Firebase Android après son enregistrement dans votre projet Firebase.

4. (Facultatif) Entrez les autres informations de l' application: certificat pseudonyme App et signature de débogage SHA-1.

   Comment sont le surnom App et le certificat de signature de débogage SHA-1 utilisé dans Firebase?

   • Surnom App: Un interne, identifiant de commodité qui est seulement visible pour vous dans la console Firebase

   • Certificat de signature de débogage SHA-1: Un hachage SHA-1 est requis par l' authentification Firebase (lors de l' utilisation de Google Connexion ou signe numéro de téléphone ) et Firebase dynamique Liens .

5. Cliquez sur l' application de vous inscrire.

Ajouter un fichier de configuration Firebase

1. Ajoutez le fichier de configuration Android Firebase à votre application :

   1. Cliquez sur Télécharger google-services.json pour obtenir votre fichier de configuration Firebase Android ( google-services.json ).

   2. Déplacez votre fichier de configuration dans le répertoire du module (au niveau de l'application) de votre application.

   Que devez-vous savoir sur ce fichier de configuration ?

   • Le fichier de configuration Firebase contient des identifiants uniques mais non secrets pour votre projet. Pour en savoir plus sur ce fichier de configuration, visitez Comprendre les projets Firebase .

   • Vous pouvez télécharger le fichier de configuration Firebase à tout moment.

   • Assurez - vous que le nom du fichier de configuration n'est pas ajouté avec des caractères supplémentaires, comme (2) .

2. Pour activer les produits Firebase dans votre application, ajoutez les services de google-plugin pour vos fichiers Gradle.

   1. Dans votre niveau racine (niveau du projet) de fichier Gradle ( build.gradle ), ajouter des règles pour inclure le plug - in Services Google Gradle. Vérifiez que vous disposez également du référentiel Maven de Google.

      buildscript {
      
        repositories {
          // Check that you have the following line (if not, add it):
          google()  // Google's Maven repository
        }
      
        dependencies {
          // ...
      
          // Add the following line:
          classpath 'com.google.gms:google-services:4.3.10'  // Google Services plugin
        }
      }
      
      allprojects {
        // ...
      
        repositories {
          // Check that you have the following line (if not, add it):
          google()  // Google's Maven repository
          // ...
        }
      }
      

   2. Dans votre module fichier (app-niveau) Gradle (généralement app/build.gradle ), appliquer le plugin Google Services de Gradle:

      apply plugin: 'com.android.application'
      // Add the following line:
      apply plugin: 'com.google.gms.google-services'  // Google Services plugin
      
      android {
        // ...
      }
      

Ajouter des SDK Firebase à votre application

1. Utilisation de la Firebase Android BoM , déclarer la dépendance de la bibliothèque - Cloud Firebase Messaging Android dans votre module (app-niveau) de fichier Gradle (généralement app/build.gradle ).

   Pour une expérience optimale avec Firebase Nuage de messagerie, nous vous recommandons de permettre à Google Analytics dans votre projet Firebase et en ajoutant le SDK Firebase Google Analytics à votre application.

   Java

   dependencies {
       // Import the BoM for the Firebase platform
       implementation platform('com.google.firebase:firebase-bom:28.4.1')
   
       // Declare the dependencies for the Firebase Cloud Messaging and Analytics libraries
       // When using the BoM, you don't specify versions in Firebase library dependencies
       implementation 'com.google.firebase:firebase-messaging'
       implementation 'com.google.firebase:firebase-analytics'
   }
   

   En utilisant le Firebase Android BoM , votre application utilise toujours des versions compatibles des bibliothèques Firebase Android.

   (Alternative) déclarer des dépendances de bibliothèque firebase sans utiliser la nomenclature

   Si vous choisissez de ne pas utiliser la nomenclature de Firebase, vous devez spécifier chaque version de la bibliothèque Firebase dans sa ligne de dépendance.

   Notez que si vous utilisez plusieurs bibliothèques Firebase dans votre application, nous vous recommandons fortement d' utiliser la BoM pour gérer les versions bibliothèque, ce qui garantit que toutes les versions sont compatibles.

   dependencies {
       // Declare the dependencies for the Firebase Cloud Messaging and Analytics libraries
       // When NOT using the BoM, you must specify versions in Firebase library dependencies
       implementation 'com.google.firebase:firebase-messaging:22.0.0'
       implementation 'com.google.firebase:firebase-analytics:19.0.1'
   }
   

   Kotlin+KTX

   dependencies {
       // Import the BoM for the Firebase platform
       implementation platform('com.google.firebase:firebase-bom:28.4.1')
   
       // Declare the dependencies for the Firebase Cloud Messaging and Analytics libraries
       // When using the BoM, you don't specify versions in Firebase library dependencies
       implementation 'com.google.firebase:firebase-messaging-ktx'
       implementation 'com.google.firebase:firebase-analytics-ktx'
   }
   

   En utilisant le Firebase Android BoM , votre application utilise toujours des versions compatibles des bibliothèques Firebase Android.

   (Alternative) déclarer des dépendances de bibliothèque firebase sans utiliser la nomenclature

   Si vous choisissez de ne pas utiliser la nomenclature de Firebase, vous devez spécifier chaque version de la bibliothèque Firebase dans sa ligne de dépendance.

   Notez que si vous utilisez plusieurs bibliothèques Firebase dans votre application, nous vous recommandons fortement d' utiliser la BoM pour gérer les versions bibliothèque, ce qui garantit que toutes les versions sont compatibles.

   dependencies {
       // Declare the dependencies for the Firebase Cloud Messaging and Analytics libraries
       // When NOT using the BoM, you must specify versions in Firebase library dependencies
       implementation 'com.google.firebase:firebase-messaging-ktx:22.0.0'
       implementation 'com.google.firebase:firebase-analytics-ktx:19.0.1'
   }
   

2. Synchronisez votre application pour vous assurer que toutes les dépendances ont les versions nécessaires.

   Obtention d'un échec de génération concernant la prise en charge d'invocation-custom et activation du désucrage ? Voici comment y remédier.

   Les versions Gradle qui utilisent le plug-in Android Gradle (AGP) v4.2 ou une version antérieure doivent activer la prise en charge de Java 8. Sinon, ces projets Android échouent lors de l'ajout d'un SDK Firebase.

   Pour corriger cet échec de compilation, vous pouvez suivre l'une des deux options suivantes :

   • Ajouter les énumérés compileOptions du message d'erreur à votre niveau d'application build.gradle fichier.
   • Augmenter le minSdkVersion pour votre projet Android au 26 ou au- dessus.

   En savoir plus sur cet échec de construction dans cette FAQ .

Modifier le manifeste de votre application

Ajoutez les éléments suivants au manifeste de votre application :

• Un service qui se prolonge FirebaseMessagingService . Ceci est nécessaire si vous souhaitez gérer les messages au-delà de la réception de notifications sur les applications en arrière-plan. Pour recevoir des notifications dans les applications au premier plan, pour recevoir des données utiles, pour envoyer des messages en amont, etc., vous devez étendre ce service.

<service
    android:name=".java.MyFirebaseMessagingService"
    android:exported="false">
    <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT" />
    </intent-filter>
</service>
AndroidManifest.xml

• (Facultatif) Dans le composant d'application, des éléments de métadonnées pour définir une icône et une couleur de notification par défaut. Android utilise ces valeurs chaque fois que les messages entrants ne définissent pas explicitement l'icône ou la couleur.

<!-- Set custom default icon. This is used when no icon is set for incoming notification messages.
     See README(https://goo.gl/l4GJaQ) for more. -->
<meta-data
    android:name="com.google.firebase.messaging.default_notification_icon"
    android:resource="@drawable/ic_stat_ic_notification" />
<!-- Set color used with incoming notification messages. This is used when no color is set for the incoming
     notification message. See README(https://goo.gl/6BKBk7) for more. -->
<meta-data
    android:name="com.google.firebase.messaging.default_notification_color"
    android:resource="@color/colorAccent" />
AndroidManifest.xml

• (Facultatif) A partir de Android 8.0 (niveau API 26) et plus, les voies de notification sont pris en charge et a recommandé. FCM fournit un canal de notification par défaut avec des paramètres de base. Si vous préférez créer et utiliser votre propre canal par défaut, ensemble default_notification_channel_id à l'ID de votre objet de canal de notification comme indiqué; FCM utilisera cette valeur chaque fois que les messages entrants ne définissent pas explicitement un canal de notification. Pour en savoir plus, consultez la section Gérer les canaux de notification .

<meta-data
    android:name="com.google.firebase.messaging.default_notification_channel_id"
    android:value="@string/default_notification_channel_id" />
AndroidManifest.xml

Accéder au jeton d'enregistrement de l'appareil

Au démarrage initial de votre application, le SDK FCM génère un jeton d'enregistrement pour l'instance d'application cliente. Si vous souhaitez cibler un ou plusieurs périphériques créer des groupes de périphériques, vous aurez besoin d'accéder à ce jeton en élargissant FirebaseMessagingService et en remplaçant onNewToken .

Cette section décrit comment récupérer le jeton et comment surveiller les modifications apportées au jeton. Étant donné que le jeton peut être tourné après le démarrage initial, il est fortement recommandé de récupérer le dernier jeton d'enregistrement mis à jour.

Le jeton d'enregistrement peut changer lorsque :

• L'application est restaurée sur un nouvel appareil
• L'utilisateur désinstalle/réinstalle l'application
• L'utilisateur efface les données de l'application.

Récupérer le jeton d'enregistrement actuel

Lorsque vous avez besoin de récupérer le jeton en cours, appelez FirebaseMessaging.getInstance().getToken() :

FirebaseMessaging.getInstance().getToken()
    .addOnCompleteListener(new OnCompleteListener<String>() {
        @Override
        public void onComplete(@NonNull Task<String> task) {
          if (!task.isSuccessful()) {
            Log.w(TAG, "Fetching FCM registration token failed", task.getException());
            return;
          }

          // Get new FCM registration token
          String token = task.getResult();

          // Log and toast
          String msg = getString(R.string.msg_token_fmt, token);
          Log.d(TAG, msg);
          Toast.makeText(MainActivity.this, msg, Toast.LENGTH_SHORT).show();
        }
    });

FirebaseMessaging.getInstance().token.addOnCompleteListener(OnCompleteListener { task ->
    if (!task.isSuccessful) {
        Log.w(TAG, "Fetching FCM registration token failed", task.exception)
        return@OnCompleteListener
    }

    // Get new FCM registration token
    val token = task.result

    // Log and toast
    val msg = getString(R.string.msg_token_fmt, token)
    Log.d(TAG, msg)
    Toast.makeText(baseContext, msg, Toast.LENGTH_SHORT).show()
})

Surveiller la génération de jetons

Les onNewToken feux de rappel à chaque fois est généré un nouveau jeton.

/**
 * There are two scenarios when onNewToken is called:
 * 1) When a new token is generated on initial app startup
 * 2) Whenever an existing token is changed
 * Under #2, there are three scenarios when the existing token is changed:
 * A) App is restored to a new device
 * B) User uninstalls/reinstalls the app
 * C) User clears app data
 */
@Override
public void onNewToken(String token) {
    Log.d(TAG, "Refreshed token: " + token);

    // If you want to send messages to this application instance or
    // manage this apps subscriptions on the server side, send the
    // FCM registration token to your app server.
    sendRegistrationToServer(token);
}
MyFirebaseMessagingService.java

/**
 * Called if the FCM registration token is updated. This may occur if the security of
 * the previous token had been compromised. Note that this is called when the
 * FCM registration token is initially generated so this is where you would retrieve the token.
 */
override fun onNewToken(token: String) {
    Log.d(TAG, "Refreshed token: $token")

    // If you want to send messages to this application instance or
    // manage this apps subscriptions on the server side, send the
    // FCM registration token to your app server.
    sendRegistrationToServer(token)
}
MyFirebaseMessagingService.kt

Une fois que vous avez obtenu le jeton, vous pouvez l'envoyer à votre serveur d'applications et le stocker en utilisant votre méthode préférée.

Rechercher les services Google Play

Les applications qui reposent sur le SDK des services Play doivent toujours rechercher sur l'appareil un APK compatible avec les services Google Play avant d'accéder aux fonctionnalités des services Google Play. Il est recommandé de le faire en deux endroits: dans l'activité principale de onCreate() la méthode, et dans son onResume() méthode. Le contrôle en onCreate() veille à ce que l'application ne peut pas être utilisé sans contrôle avec succès. Le contrôle en onResume() assure que si l'utilisateur revient à l'application en cours d' exécution par d'autres moyens, tels que par l'intermédiaire du bouton de retour, la vérification est encore effectuée.

Si l'appareil ne dispose pas d' une version compatible de services Google Play, votre application peut appeler GoogleApiAvailability.makeGooglePlayServicesAvailable() pour permettre aux utilisateurs de télécharger des services Google Play depuis le Play Store.

Empêcher l'initialisation automatique

Lorsqu'un jeton d'enregistrement FCM est généré, la bibliothèque télécharge l'identifiant et les données de configuration sur Firebase. Si vous préférez éviter autoproduction jeton, désactiver la collecte Analytics et initialisation automatique FCM (vous devez désactiver les deux) en ajoutant ces valeurs de métadonnées à votre AndroidManifest.xml :

<meta-data
    android:name="firebase_messaging_auto_init_enabled"
    android:value="false" />
<meta-data
    android:name="firebase_analytics_collection_enabled"
    android:value="false" />
AndroidManifest.xml

Pour réactiver l'initialisation automatique du FCM, effectuez un appel d'exécution :

FirebaseMessaging.getInstance().setAutoInitEnabled(true);
MainActivity.java

Firebase.messaging.isAutoInitEnabled = true
MainActivity.kt

Pour réactiver la collecte Analytics, appelez le setAnalyticsCollectionEnabled() méthode de la FirebaseAnalytics classe. Par exemple:

setAnalyticsCollectionEnabled(true);

Ces valeurs persistent lors des redémarrages de l'application une fois définies.

Prochaines étapes

Après l'application cliente est mis en place, vous êtes prêt à commencer à envoyer des messages en aval avec le Notifications compositeur . Cette fonctionnalité est mise en évidence dans l' échantillon de QuickStart , que vous pouvez télécharger, exécuter et examen.

Pour ajouter d'autres comportements plus avancés à votre application, vous pouvez déclarer un filtre d'intention et implémenter une activité pour répondre aux messages entrants. Pour plus de détails, consultez les guides d'envoi de messages à partir d'un serveur d'applications :

• Envoyer des messages thématiques
• Envoyer aux groupes d'appareils
• Envoyer des messages en amont

Gardez à l' esprit que, pour tirer parti de ces fonctionnalités, vous aurez besoin d' une implémentation du serveur et le serveur procotols (HTTP ou XMPP), ou une mise en œuvre du SDK d' administration .