Ce guide explique comment configurer Firebase Cloud Messaging dans vos applications clientes mobiles et Web pour recevoir des messages de manière fiable.
Pour recevoir des messages, vous pouvez utiliser un service qui étend FirebaseMessagingService.
Votre service doit remplacer les rappels onMessageReceived et onDeletedMessages. Pour obtenir un exemple complet, consultez l'exemple de guide de démarrage rapide Firebase Cloud Messaging.
onMessageReceived est disponible pour la plupart des types de messages, à l'exception des suivants :
Messages de notification envoyés lorsque votre application est en arrière-plan. Dans ce cas, la notification est envoyée dans la barre d'état système de l'appareil. Par défaut, lorsqu'un utilisateur appuie sur une notification, le lanceur d'applications s'ouvre.
Messages avec charge utile de notification et de données, lorsqu'ils sont reçus en arrière-plan. Dans ce cas, la notification est envoyée dans la barre d'état système de l'appareil, et la charge utile de données est envoyée dans les extras de l'intent de votre activité de lanceur.
En résumé :
| État de l'application | Notification | Données | Les deux |
|---|---|---|---|
| Premier plan | onMessageReceived |
onMessageReceived |
onMessageReceived |
| Arrière-plan | Barre d'état système | onMessageReceived |
Notification : barre d'état système Données : dans les extras de l'intention. |
Pour en savoir plus sur les types de messages, consultez Notifications et messages de données.
La fonction de rappel onMessageReceived dispose d'une courte fenêtre d'exécution. De nombreux facteurs peuvent affecter la durée de cette fenêtre, y compris les retards de l'OS, le temps de démarrage de l'application, le blocage du thread principal par d'autres opérations ou les appels onMessageReceived précédents qui prennent trop de temps.
Pour cette raison, vous devez éviter les tâches de longue durée (comme la récupération d'images à partir d'un serveur pour les afficher dans une notification) dans onMessageReceived et planifier plutôt une tâche à l'aide de WorkManager pour gérer les tâches qui peuvent prendre plus de quelques secondes. Pour en savoir plus sur la priorité des messages et son impact sur le traitement, consultez Traitement des messages à priorité élevée et normale.
Modifier le fichier manifeste de l'application
Pour utiliser FirebaseMessagingService, vous devez ajouter le code suivant au fichier manifeste de votre application :
<service
android:name=".java.MyFirebaseMessagingService"
android:exported="false">
<intent-filter>
<action android:name="com.google.firebase.MESSAGING_EVENT" />
</intent-filter>
</service>
Nous vous recommandons de définir des valeurs par défaut pour personnaliser l'apparence des notifications. Vous pouvez spécifier une icône et une couleur par défaut personnalisées qui sont appliquées chaque fois que des valeurs équivalentes ne sont pas définies dans la charge utile de la notification.
Ajoutez les lignes suivantes dans la balise application pour définir l'icône et la couleur personnalisées par défaut :
<!-- 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" />
Android affiche et utilise l'icône par défaut personnalisée pour
- Tous les messages de notification envoyés depuis le composant Notifications.
- Tout message de notification qui ne définit pas explicitement l'icône dans la charge utile de la notification.
Si aucune icône par défaut personnalisée n'est définie et qu'aucune icône n'est définie dans la charge utile de notification, Android affiche l'icône de l'application en blanc.
Ignorer onMessageReceived
En remplaçant la méthode FirebaseMessagingService.onMessageReceived, vous pouvez effectuer des actions en fonction de l'objet RemoteMessage reçu et obtenir les données du message :
Kotlin
override fun onMessageReceived(remoteMessage: RemoteMessage) { // TODO(developer): Handle FCM messages here. // Not getting messages here? See why this may be: https://goo.gl/39bRNJ Log.d(TAG, "From: ${remoteMessage.from}") // Check if message contains a data payload. if (remoteMessage.data.isNotEmpty()) { Log.d(TAG, "Message data payload: ${remoteMessage.data}") // Check if data needs to be processed by long running job if (needsToBeScheduled()) { // For long-running tasks (10 seconds or more) use WorkManager. scheduleJob() } else { // Handle message within 10 seconds handleNow() } } // Check if message contains a notification payload. remoteMessage.notification?.let { Log.d(TAG, "Message Notification Body: ${it.body}") } // Also if you intend on generating your own notifications as a result of a received FCM // message, here is where that should be initiated. See sendNotification method below. }
Java
@Override public void onMessageReceived(RemoteMessage remoteMessage) { // TODO(developer): Handle FCM messages here. // Not getting messages here? See why this may be: https://goo.gl/39bRNJ Log.d(TAG, "From: " + remoteMessage.getFrom()); // Check if message contains a data payload. if (remoteMessage.getData().size() > 0) { Log.d(TAG, "Message data payload: " + remoteMessage.getData()); if (/* Check if data needs to be processed by long running job */ true) { // For long-running tasks (10 seconds or more) use WorkManager. scheduleJob(); } else { // Handle message within 10 seconds handleNow(); } } // Check if message contains a notification payload. if (remoteMessage.getNotification() != null) { Log.d(TAG, "Message Notification Body: " + remoteMessage.getNotification().getBody()); } // Also if you intend on generating your own notifications as a result of a received FCM // message, here is where that should be initiated. See sendNotification method below. }
Ignorer onDeletedMessages
Dans certains cas, FCM ne peut pas envoyer de message. Cela se produit lorsqu'il y a trop de messages (> 100) en attente pour votre application sur un appareil spécifique au moment où il se connecte, ou si l'appareil ne s'est pas connecté à FCM depuis plus d'un mois. Dans ce cas, vous pouvez recevoir un appel au FirebaseMessagingService.onDeletedMessages(). Lorsque l'instance d'application reçoit ce rappel, elle doit effectuer une synchronisation complète avec le serveur de votre application. Si vous n'avez pas envoyé de message à l'application sur cet appareil au cours des quatre dernières semaines, FCM ne passera pas d'appel onDeletedMessages().
Gérer les messages de notification dans une application en arrière-plan
Lorsque votre application est en arrière-plan, Android redirige les messages de notification vers la barre d'état système. Par défaut, lorsqu'un utilisateur appuie sur la notification, le lanceur d'applications s'ouvre.
Cela inclut les messages contenant à la fois une charge utile de notification et de données (ainsi que tous les messages envoyés depuis la console Notifications). Dans ce cas, la notification est envoyée dans la barre d'état système de l'appareil, et la charge utile de données est envoyée dans les extras de l'intent de votre activité de lanceur.
Pour en savoir plus sur la distribution des messages à votre application, consultez le
tableau de bord de reporting FCM, qui enregistre le nombre de messages envoyés et ouverts sur les appareils Apple et Android, ainsi que les données sur les "impressions" (notifications vues par les utilisateurs) pour les applications Android.