Ajouter des notifications push à une application iOS

1. Introduction

Dernière mise à jour:06/01/2020

Firebase Cloud Messaging (FCM) est une solution de messagerie multiplate-forme qui vous permet d'envoyer des messages de manière fiable et sans frais.

FCM vous permet d'informer une application cliente que de nouveaux e-mails ou d'autres données peuvent être synchronisés. Vous pouvez envoyer des messages de notification pour réengager et fidéliser les utilisateurs. Pour des cas d'utilisation tels que la messagerie instantanée, un message peut transférer une charge utile allant jusqu'à 4 Ko vers une application cliente.

Comment ça marche ?

Une implémentation FCM comprend deux composants principaux pour l'envoi et la réception:

1. Un environnement de confiance tel que Cloud Functions for Firebase ou un serveur d'applications sur lequel créer, cibler et envoyer des messages
2. Une application cliente iOS, Android ou Web (JavaScript) qui reçoit des messages via le service de transport spécifique à la plate-forme correspondant

Présentation de l'architecture FCM

FCM s'appuie sur l'ensemble de composants suivant pour créer, transporter et recevoir des messages:

1. Outils permettant de rédiger ou de créer des invitations à discuter L'outil de création de notifications fournit une option basée sur une IUG pour créer des demandes de notification. Pour bénéficier d'une automatisation et d'une compatibilité totales pour tous les types de messages, vous devez créer des invitations à discuter dans un environnement de serveur de confiance compatible avec le SDK Firebase Admin ou les protocoles de serveur FCM. Il peut s'agir de Cloud Functions for Firebase, de Google App Engine ou de votre propre serveur d'applications.
2. Le backend FCM, qui (entre autres fonctions) accepte les demandes de messages, effectue une distribution ramifiée des messages via des sujets et génère des métadonnées de message telles que leur ID.
3. Une couche de transport au niveau de la plate-forme, qui achemine le message vers l'appareil ciblé, gère la distribution des messages et applique la configuration spécifique à la plate-forme, le cas échéant. Cette couche transport comprend:

• Couche de transport Android (ATL) pour les appareils Android avec les services Google Play
• Service de notifications push Apple (APN) pour les appareils iOS
• Protocole Web push pour les applications Web

Remarque:Les couches de transport au niveau de la plate-forme se trouvent en dehors du service FCM. Les messages FCM acheminés vers une couche de transport au niveau de la plate-forme peuvent être soumis à des conditions spécifiques à cette plate-forme plutôt qu'aux conditions d'utilisation de FCM. Le routage des messages Android via ATL est soumis aux conditions d'utilisation des API Google.

4. SDK FCM sur l'appareil de l'utilisateur, où la notification est affichée ou le message est géré en fonction de l'état de premier plan/d'arrière-plan de l'application et de toute logique d'application pertinente.

Objectifs de l'atelier

Dans cet atelier de programmation, vous allez ajouter une notification push à un exemple d'application iOS avec FCM.

Points abordés

• Abonner un utilisateur aux messages push et le désabonner de celui-ci
• Gérer les messages push entrants
• Afficher une notification
• Répondre aux clics sur les notifications

Prérequis

• Xcode 11.0 ou version ultérieure
• CocoaPods 1.9.0 ou version ultérieure
• Compte de développeur Apple
• Un appareil iOS physique pour exécuter votre application
• Connaissances de base sur Swift

2. Configuration

Télécharger l'exemple de code

Dans cet atelier de programmation, vous allez créer votre propre application de test. Toutefois, si vous souhaitez voir et exécuter l'application exemple existante, vous pouvez télécharger l'exemple de code du guide de démarrage rapide.

Il existe deux façons d'obtenir l'échantillon:

• Clonez le dépôt Git :

$ git clone https://github.com/firebase/quickstart-ios.git

• Téléchargez le fichier ZIP:

Si vous téléchargez la source en tant que fichier ZIP, vous obtiendrez un dossier racine quickstart-ios.

Télécharger le code source

Créer une application

Créez votre propre application de test en suivant les étapes ci-dessous (dans XCode 12.3):

1. Ouvrez XCode, puis sélectionnez Create a new Xcode project (Créer un projet Xcode).
2. Sélectionnez App (Application), puis cliquez sur Next (Suivant).

3. Indiquez le nom du produit (par exemple, MessagingExample)
4. Sélectionnez Équipe (si vous n'avez pas créé d'équipe, configurez-la dans le compte de développeur Apple).
5. Indiquez l'identifiant de l'organisation (par exemple, com.your-name)
6. Saisissez un identifiant de bundle (par exemple, com.your-name.MessagingExample, il doit être unique parmi toutes les applications iOS).
7. Sélectionnez Storyboard dans le menu déroulant Interface.
8. Sélectionnez Délégué d'application UIKit dans le menu déroulant Cycle de vie.
9. Dans le champ Language (Langue), sélectionnez Swift.
10. Cliquez sur Suivant.

Vous aurez besoin de l'identifiant de bundle lorsque vous créerez une clé APN et enregistrerez votre application dans votre projet Firebase.

3. Configuration des APNs

Créer la clé d'authentification

Cette section explique comment générer une clé d'authentification pour un ID d'application compatible avec les notifications push. Si vous disposez déjà d'une clé, vous pouvez l'utiliser au lieu d'en générer une nouvelle.

Pour créer une clé d'authentification:

1. Dans votre compte de développeur, accédez à Certificates, Identifiers & Profils, puis accédez à Clés.

2. Cliquez sur le bouton Ajouter (+) dans le coin supérieur droit.

3. Saisissez une description pour la clé d'authentification APNs
4. Sous "Services de clés", cochez la case "APN", puis cliquez sur Continuer.

5. Cliquez sur Register (S'inscrire), puis sur Download (Télécharger). Conservez votre clé en lieu sûr. Il s'agit d'un téléchargement unique et la clé ne peut pas être récupérée ultérieurement.

Créer un ID d'application

Un ID d'application est un identifiant qui identifie une application de manière unique. Par convention, elle est représentée par un domaine inversé.

1. Accédez à l'Apple Developer Member Center et connectez-vous.
2. Accédez à Certificats, identifiants et profils.
3. Accédez à Identifiants.
4. Cliquez sur le bouton + pour créer un ID d'application.
5. Sélectionnez la case d'option ID des applications, puis cliquez sur Continuer.

6. Sélectionnez Application, puis cliquez sur Continuer.

7. Pour créer l'ID d'application:
8. Saisissez un nom pour l'ID de votre application.
9. Saisissez un ID d'équipe. Cette valeur doit correspondre à l'ID d'équipe de l'onglet "Membres".
10. Dans la section Suffixe d'ID d'application, sélectionnez ID d'application explicite, puis saisissez votre ID de bundle.
11. Dans la section Services d'applications, assurez-vous que l'option Notifications push est cochée.
12. Cliquez sur Continue (Continuer) et vérifiez que votre saisie est correcte:
13. La valeur de l'identifiant doit correspondre à la concaténation des valeurs de l'ID d'équipe et de l'ID de bundle
14. Les notifications push doivent être configurables.
15. Cliquez sur Enregistrer pour créer l'ID d'application.

Créer le profil

Pour tester votre application pendant le développement, vous avez besoin d'un profil de développement afin d'autoriser vos appareils à exécuter une application qui n'est pas encore publiée sur l'App Store.

1. Accédez à l'Apple Developer Member Center et connectez-vous.
2. Accédez à Certificats, identifiants et profils.
3. Dans le menu déroulant en haut à gauche, sélectionnez iOS, tvOS, watchOS si ce n'est pas déjà fait, puis accédez à Profiles (Profils).
4. Cliquez sur le bouton + pour créer un profil.
5. Sélectionnez iOS App Development (Développement d'applications iOS) comme type de profil de provisionnement, puis cliquez sur Continue (Continuer).

6. Dans le menu déroulant, sélectionnez l'ID d'application que vous souhaitez utiliser, puis cliquez sur Continuer.
7. Sélectionnez le certificat de développement iOS associé à l'ID d'application que vous avez choisi à l'étape précédente, puis cliquez sur Continuer.
8. Sélectionnez les appareils iOS que vous souhaitez inclure dans le profil de provisionnement, puis cliquez sur Continuer. Veillez à sélectionner tous les appareils que vous souhaitez utiliser pour vos tests.
9. Attribuez un nom à ce profil de gestion des comptes (par exemple, MessagingExampleProfile), puis cliquez sur Générer.

10. Cliquez sur Download (Télécharger) pour enregistrer le profil de provisionnement sur votre Mac.

11. Double-cliquez sur le fichier de profil de provisionnement pour l'installer.

4. Ajouter Firebase à votre projet iOS

Créer un projet Firebase

Avant d'ajouter Firebase à votre application iOS, vous devez créer un projet Firebase afin de l'associer à votre application iOS. Pour en savoir plus sur les projets Firebase, consultez Comprendre les projets Firebase.

1. Dans la console Firebase, cliquez sur Ajouter un projet, puis sélectionnez ou saisissez un nom de projet.

Si vous disposez déjà d'un projet Google Cloud Platform (GCP), vous pouvez le sélectionner dans le menu déroulant pour y ajouter des ressources Firebase.

2. (Facultatif) Si vous créez un projet, vous pouvez modifier son ID de projet.

Firebase attribue automatiquement un identifiant unique à votre projet Firebase. Consultez la page "Comprendre les projets Firebase" pour savoir comment Firebase utilise l'ID de projet.

Remarque:Une fois que Firebase a provisionné des ressources pour votre projet Firebase, vous ne pouvez plus modifier l'ID de ce projet. Pour utiliser un identifiant spécifique, vous devez modifier l'ID de votre projet au cours de cette étape de configuration.

3. Cliquez sur Continuer.
4. Configurez Google Analytics pour votre projet afin de bénéficier d'une expérience optimale avec l'un des produits Firebase suivants:

• Firebase Crashlytics
• Firebase Predictions
• Firebase Cloud Messaging
• Messagerie dans l'application Firebase
• Firebase Remote Config
• Firebase A/B Testing

Lorsque vous y êtes invité, choisissez d'utiliser un compte Google Analytics existant ou d'en créer un. Si vous choisissez de créer un compte, sélectionnez l'emplacement de vos rapports Analytics, puis acceptez les paramètres de partage des données et les conditions d'utilisation de Google Analytics pour votre projet.

5. Cliquez sur Créer un projet (ou sur Ajouter Firebase si vous utilisez un projet GCP existant).

Firebase provisionne automatiquement des ressources pour votre projet Firebase. Une fois le processus terminé, vous êtes redirigé vers la page de présentation de votre projet Firebase dans la console Firebase.

Enregistrer votre application auprès de Firebase

Une fois que vous avez créé un projet Firebase, vous pouvez y ajouter votre application iOS.

Consultez la page Comprendre les projets Firebase pour en savoir plus sur les bonnes pratiques et les éléments à prendre en compte concernant l'ajout d'applications à un projet Firebase, y compris sur la gestion de plusieurs variantes de compilation.

1. Accédez à la console Firebase.
2. Au centre de la page de présentation du projet, cliquez sur l'icône iOS pour lancer le processus de configuration.

Si vous avez déjà ajouté une application à votre projet Firebase, cliquez sur "Ajouter une application" pour afficher les options de la plate-forme.

3. Saisissez l'ID du bundle de votre application dans le champ ID du bundle iOS.
4. (Facultatif) Saisissez d'autres informations sur l'application: Pseudo de l'application et ID App Store.
5. Cliquez sur Enregistrer l'application.

Ajouter un fichier de configuration Firebase

1. Cliquez sur Download GoogleService-Info.plist (Télécharger GoogleService-Info.plist) pour obtenir votre fichier de configuration iOS Firebase (GoogleService-Info.plist).
2. Déplacez votre fichier de configuration à la racine de votre projet Xcode. Si vous y êtes invité, sélectionnez cette option pour ajouter le fichier de configuration à toutes les cibles.

Si votre projet comporte plusieurs ID de bundle, vous devez associer chacun d'eux à une application enregistrée dans la console Firebase afin que chaque application puisse avoir son propre fichier GoogleService-Info.plist.

Fermez XCode.

Ajouter les SDK Firebase à votre application

Nous vous recommandons d'utiliser CocoaPods pour installer les bibliothèques Firebase. Toutefois, si vous préférez ne pas utiliser CocoaPods, vous pouvez intégrer directement les frameworks du SDK ou utiliser la version bêta de Swift Package Manager.

1. Créez un Podfile si vous n'en avez pas déjà un. Si vous utilisez l'exemple de démarrage rapide, le projet Xcode et le fichier Podfile (avec des pods) sont déjà présents.

$ cd MessagingExample
$ pod init

2. Dans votre fichier Podfile, ajoutez les pods Firebase que vous souhaitez utiliser dans votre application.

Vous pouvez ajouter n'importe quel produit Firebase compatible à votre application iOS.

Dans l'exemple de démarrage rapide, les SDK Google Analytics et Firebase Cloud Messaging ont été ajoutés.

# Add the Firebase pod for Google Analytics
pod 'Firebase/Analytics'

# Add the pod for Firebase Cloud Messaging
pod 'Firebase/Messaging'

3. Installez les pods, puis ouvrez votre fichier .xcworkspace pour voir le projet dans Xcode:

$ pod install

4. Ouvrez MessagingExample.xcworkspace, puis cliquez sur Suivant dans la console Firebase.

Initialiser Firebase dans votre application

Vous devez ajouter le code d'initialisation Firebase à votre application.

Importez le module Firebase et configurez une instance partagée (dans l'exemple de démarrage rapide, le module Firebase est déjà importé).

1. Importez le module Firebase dans UIApplicationDelegate :

AppDelegate.swift

import UIKit
import Firebase // Add this line

2. Configurez une instance partagée FirebaseApp, généralement dans la méthode application:didFinishLaunchingWithOptions: de votre application:

AppDelegate.swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
  FirebaseApp.configure() // Add this line
  return true
}

3. Cliquez sur Suivant dans la console Firebase.
4. Les SDK Firebase sont ajoutés à votre application. Cliquez sur Accéder à la console.

5. Configurer le client FCM

Importer votre clé d'authentification APNs

Importez votre clé d'authentification APNs dans Firebase.

1. Dans la console Firebase, dans votre projet, sélectionnez l'icône en forme de roue dentée, Paramètres du projet, puis l'onglet Cloud Messaging.
2. Dans Clé d'authentification APNs, sous Configuration de l'application iOS, cliquez sur le bouton Importer.
3. Accédez à l'emplacement où vous avez enregistré votre clé, sélectionnez-la et cliquez sur Ouvrir. Ajoutez l'ID de la clé (disponible dans la section Certificats, identifiants et profils de l'Apple Developer Member Center), puis cliquez sur Importer.

S'inscrire pour recevoir des notifications à distance

Enregistrez votre application pour recevoir des notifications à distance, soit au démarrage, soit au moment souhaité dans le flux de votre application.

Dans l'exemple du guide de démarrage rapide, registerForRemoteNotifications a déjà été ajouté.

AppDelegate.swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
  FirebaseApp.configure()
  // [START register for remote notifications]
  if #available(iOS 10.0, *) {
    // For iOS 10 display notification (sent via APNS)
    UNUserNotificationCenter.current().delegate = self
        
    let authOptions: UNAuthorizationOptions = [.alert, .badge, .sound]
    UNUserNotificationCenter.current().requestAuthorization(options: authOptions, completionHandler: {_, _ in })
  } else {
    let settings: UIUserNotificationSettings = UIUserNotificationSettings(types: [.alert, .badge, .sound], categories: nil)
    application.registerUserNotificationSettings(settings)
  }

  application.registerForRemoteNotifications()
  // [END register for remote notifications]
  return true
}

Attribuez la propriété déléguée de UNUserNotificationCenter en ajoutant ces lignes à la fin d'AppDelegate.swift.

AppDelegate.swift

@available(iOS 10, *)
extension AppDelegate : UNUserNotificationCenterDelegate {

  // Receive displayed notifications for iOS 10 devices.
  func userNotificationCenter(_ center: UNUserNotificationCenter,
                              willPresent notification: UNNotification,
    withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
    let userInfo = notification.request.content.userInfo

    // Print full message.
    print(userInfo)

    // Change this to your preferred presentation option
    completionHandler([[.alert, .sound]])
  }

  func userNotificationCenter(_ center: UNUserNotificationCenter,
                              didReceive response: UNNotificationResponse,
                              withCompletionHandler completionHandler: @escaping () -> Void) {
    let userInfo = response.notification.request.content.userInfo

    // Print full message.
    print(userInfo)

    completionHandler()
  }
}

Définir le délégué de messagerie

Pour recevoir des jetons d'enregistrement, implémentez le protocole de délégation de messagerie et définissez la propriété delegate de FIRMessaging après avoir appelé [FIRApp configure]. Par exemple, si le délégué de votre application est conforme au protocole de délégation de messagerie, vous pouvez définir le délégué sur application:didFinishLaunchingWithOptions: sur lui-même (dans l'exemple du guide de démarrage rapide, il est déjà défini).

AppDelegate.swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
  FirebaseApp.configure()
  Messaging.messaging().delegate = self // Add this line
  // [START register for remote notifications]
  if #available(iOS 10.0, *) {
    // For iOS 10 display notification (sent via APNS)
    UNUserNotificationCenter.current().delegate = self
        
    let authOptions: UNAuthorizationOptions = [.alert, .badge, .sound]
    UNUserNotificationCenter.current().requestAuthorization(options: authOptions, completionHandler: {_, _ in })
  } else {
    let settings: UIUserNotificationSettings = UIUserNotificationSettings(types: [.alert, .badge, .sound], categories: nil)
    application.registerUserNotificationSettings(settings)
  }

  application.registerForRemoteNotifications()
  // [END register for remote notifications]
  return true
}

Attribuez la propriété déléguée de FIRMessaging en ajoutant ces lignes à la fin d'AppDelegate.swift.

AppDelegate.swift

extension AppDelegate : MessagingDelegate {
  func messaging(_ messaging: Messaging, didReceiveRegistrationToken fcmToken: String?) {
    print("Firebase registration token: \(String(describing: fcmToken))")
    
    let dataDict:[String: String] = ["token": fcmToken ?? ""]
    NotificationCenter.default.post(name: Notification.Name("FCMToken"), object: nil, userInfo: dataDict)
  }
}

Ajouter des fonctionnalités

Vous avez ajouté la fonctionnalité de notifications push dans la section "Créer un ID d'application", mais vous devez également l'ajouter à XCode en procédant comme suit (les étapes ci-dessous sont dans XCode 12.3):

1. Cliquez sur le nom du projet dans la zone de navigation.
2. Cliquez sur Signature et fonctionnalités.
3. Cliquez sur + Capacité.

4. Double-cliquez sur Modes d'arrière-plan.
5. Cliquez à nouveau sur + Capacité.
6. Double-cliquez sur Notifications push.
7. Cochez Notifications à distance dans la section Modes arrière-plan.

6. Envoyer un message de notification

Pour envoyer un message de test, procédez comme suit:

1. Installez et exécutez l'application sur l'appareil cible. Vous devrez accepter la demande d'autorisation pour recevoir les notifications à distance.
2. Récupérez le jeton d'enregistrement dans le journal XCode.

3. Assurez-vous que l'application est exécutée en arrière-plan sur l'appareil.
4. Ouvrez l'outil de création de notifications, puis sélectionnez Nouvelle notification.
5. Saisissez le texte du message.
6. Sélectionnez Envoyer un message de test.
7. Dans le champ Ajouter un jeton d'enregistrement FCM, saisissez le jeton d'enregistrement obtenu à l'étape 2.
8. Cliquez sur Tester.

Une fois que vous avez cliqué sur Tester, l'appareil client ciblé (avec l'application en arrière-plan) devrait recevoir la notification dans le centre de notifications.

Pour en savoir plus sur la distribution des messages dans votre application, consultez le tableau de bord des rapports FCM, qui enregistre le nombre de messages envoyés et ouverts sur les appareils iOS et Android.

7. Félicitations

Félicitations, vous avez envoyé un message de test.

Il existe de nombreuses autres fonctions et configurations dans FCM, telles que l'abonnement à un sujet.

Si cela vous intéresse, consultez le document officiel destiné aux développeurs.

Et ensuite ?

Découvrez quelques-uns de ces ateliers de programmation.

• Fonctionnalités avancées d'Android en Kotlin 01.2:Android Firebase Cloud Messaging

Complément d'informations

• Document officiel de Firebase Cloud Messaging