Tutoriel : Envoyer des notifications Push aux applications React Native à l’aide d’Azure Notification Hubs via un service back-end
Télécharger l’exempleDans ce tutoriel, vous utilisez Azure Notification Hubs pour envoyer des notifications push à une application React Native ciblant Android et iOS.
Un back-end d’API web ASP.NET Core est utilisé pour gérer l’inscription des appareils pour le client à l’aide de l’approche d’installation la plus récente et la meilleure. Le service envoie également des notifications Push de manière multiplateforme.
Ces opérations sont gérées à l’aide du Kit de développement logiciel (SDK) Notification Hubs pour les opérations back-end. Pour plus d’informations sur l’approche globale, consultez la documentation Inscription à partir de votre back-end d’application .
Ce tutoriel vous guide tout au long des étapes suivantes :
- Configurez Push Notification Services et Azure Notification Hubs.
- Créez une application principale d’API web ASP.NET Core.
- Créez une application React Native multiplateforme.
- Configurez le projet Android natif pour les notifications Push.
- Configurez le projet iOS natif pour les notifications Push.
- Testez la solution.
Prérequis
Pour suivre, vous avez besoin des éléments suivants :
- Un abonnement Azure dans lequel vous pouvez créer et gérer des ressources.
- Un Mac avec Visual Studio pour Mac installé (ou un PC exécutant Visual Studio 2019 avec la charge de travail Développement mobile avec .NET).
- Possibilité d’exécuter l’application sur Android (appareils physiques ou émulateurs) ou iOS (appareils physiques uniquement).
Pour Android, vous devez disposer des éléments suivants :
- Un développeur a déverrouillé un appareil physique ou un émulateur (exécutant l’API 26 et ultérieure avec google Play Services installés).
Pour iOS, vous devez disposer des éléments suivants :
- Un compte de développeur Apple actif.
- Un appareil iOS physique inscrit à votre compte de développeur(exécutant iOS 13.0 et versions ultérieures).
- Un certificat de développement.p12 installé dans votre keychain vous permettant d’exécuter une application sur un appareil physique.
Notes
Le simulateur iOS ne prend pas en charge les notifications à distance. Par conséquent, un appareil physique est requis lors de l’exploration de cet exemple sur iOS. Toutefois, vous n’avez pas besoin d’exécuter l’application sur Android et iOS pour suivre ce tutoriel.
Vous pouvez suivre les étapes de cet exemple de premier principe sans expérience préalable. Toutefois, vous aurez avantage à vous familiariser avec les aspects suivants.
- Portail des développeurs Apple
- ASP.NET Core
- Google Firebase Console
- Microsoft Azure et Envoyer des notifications Push aux applications iOS à l’aide d’Azure Notification Hubs.
- React Native.
Les étapes fournies concernent Visual Studio pour Mac et Visual Studio Code, mais il est possible de suivre à l’aide de Visual Studio 2019.
Configurer Push Notification Services et Azure Notification Hub
Dans cette section, vous allez configurer Firebase Cloud Messaging (FCM) et Apple Push Notification Services (APNS). Vous créez et configurez ensuite un hub de notification pour qu’il fonctionne avec ces services.
Créer un projet Firebase et activer Firebase Cloud Messaging pour Android
Connectez-vous à la console Firebase. Créez un projet Firebase en entrant PushDemo comme nom du projet.
Notes
Un nom unique sera généré pour vous. Par défaut, il s’agit d’une variante en minuscules du nom que vous avez fourni et d’un nombre généré séparé par un tiret. Vous pouvez le modifier si vous le souhaitez, à condition qu’il reste globalement unique.
Après avoir créé votre projet, sélectionnez Ajouter Firebase à votre application Android.
Dans la page Ajouter Firebase à votre application Android , effectuez les étapes suivantes.
Pour le nom du package Android, entrez un nom pour votre package. Par exemple :
com.<organization_identifier>.<package_name>.
Sélectionnez Inscrire une application.
Sélectionnez Télécharger google-services.json. Enregistrez ensuite le fichier dans un dossier local pour une utilisation ultérieure, puis sélectionnez Suivant.
Sélectionnez Suivant.
Sélectionnez Continuer vers la console
Notes
Si le bouton Continuer vers la console n’est pas activé, en raison de l’case activée vérifier l’installation, choisissez Ignorer cette étape.
Dans la console Firebase, sélectionnez l’engrenage de votre projet. Sélectionnez ensuite Paramètres du projet.
Notes
Si vous n’avez pas téléchargé le fichier google-services.json , vous pouvez le télécharger sur cette page.
Basculez vers l’onglet Cloud Messaging en haut. Copiez et enregistrez la clé de serveur pour une utilisation ultérieure. Vous utilisez cette valeur pour configurer votre hub de notification.
Inscrire votre application iOS pour les notifications Push
Pour envoyer des notifications Push à une application iOS, inscrivez votre application auprès d’Apple et inscrivez-vous également aux notifications Push.
Si vous n’avez pas encore inscrit votre application, accédez au portail d’approvisionnement iOS dans le Centre de développement Apple. Connectez-vous au portail avec votre ID Apple, accédez à Certificats, Identificateurs & Profils, puis sélectionnez Identificateurs. Cliquez + pour inscrire une nouvelle application.
Dans l’écran Inscrire un nouvel identificateur , sélectionnez la case d’option ID d’application . Sélectionnez ensuite Continuer.
Mettez à jour les trois valeurs suivantes pour votre nouvelle application, puis sélectionnez Continuer :
Description : tapez un nom descriptif pour votre application.
ID de bundle : entrez un ID d’offre groupée au format com.organization_identifier<>.<>product_name comme indiqué dans le Guide de distribution des applications. Dans la capture d’écran suivante, la
mobcatvaleur est utilisée comme identificateur de organization et la valeur PushDemo est utilisée comme nom de produit.
Notifications Push : cochez l’option Notifications Push dans la section Fonctionnalités .
Cette action génère votre ID d’application et vous demande de confirmer les informations. Sélectionnez Continuer, puis s’inscrire pour confirmer le nouvel ID d’application.
Après avoir sélectionné Inscrire, vous voyez le nouvel ID d’application comme élément de ligne dans la page Certificats, identificateurs & profils .
Dans la page Certificats, identificateurs & profils , sous Identificateurs, recherchez l’élément de ligne ID d’application que vous avez créé. Sélectionnez ensuite sa ligne pour afficher l’écran Modifier la configuration de votre ID d’application .
Création d’un certificat pour Notification Hubs
Un certificat est requis pour permettre au hub de notification de fonctionner avec Apple Push Notification Services (APNS) et peut être fourni de l’une des deux manières suivantes :
Création d’un certificat push p12 qui peut être chargé directement sur Notification Hub (approche d’origine)
Création d’un certificat p8 qui peut être utilisé pour l’authentification basée sur des jetons (approche plus récente et recommandée)
Cette approche plus récente présente un certain nombre d’avantages, comme indiqué dans l’authentification basée sur des jetons (HTTP/2) pour APNS. Moins d’étapes sont requises, mais sont également obligatoires pour des scénarios spécifiques. Toutefois, des étapes ont été fournies pour les deux approches, car l’une ou l’autre fonctionne dans le cadre de ce didacticiel.
OPTION 1 : Création d’un certificat Push p12 qui peut être chargé directement sur Notification Hub
Sur votre Mac, exécutez l’outil d’accès au trousseau. Il peut être ouvert à partir du dossier Utilitaires ou du dossier Autre du Launchpad.
Sélectionnez Accès au trousseau, développez Assistant Certificat, puis sélectionnez Demander un certificat auprès d’une autorité de certification.
Notes
Par défaut, Keychain Access sélectionne le premier élément de la liste. Cela peut être un problème si vous êtes dans la catégorie Certificats et que l’autorité de certification Apple Worldwide Developer Relations n’est pas le premier élément de la liste. Vérifiez que vous disposez d’un élément non clé ou que la clé d’autorité de certification Apple Worldwide Developer Relations est sélectionnée avant de générer la demande de signature de certificat (CSR).
Sélectionnez votre adresse de Email d’utilisateur, entrez votre valeur Nom commun, assurez-vous que vous spécifiez Enregistré sur le disque, puis sélectionnez Continuer. Laissez l’adresse Email de l’autorité de certification vide, car elle n’est pas nécessaire.
Entrez un nom pour le fichier demande de signature de certificat (CSR) dans Enregistrer sous, sélectionnez l’emplacement dans Où, puis sélectionnez Enregistrer.
Cette action enregistre le fichier CSR à l’emplacement sélectionné. L’emplacement par défaut est Desktop. N’oubliez pas l’emplacement choisi pour le fichier.
Dans la page Certificats, identificateurs & profils du portail d’approvisionnement iOS, faites défiler jusqu’à l’option Notifications Push cochée, puis sélectionnez Configurer pour créer le certificat.
La fenêtre Certificats TLS/SSL du service de notification Push Apple s’affiche. Sélectionnez le bouton Créer un certificat sous la section Certificat TLS/SSL de développement .
L’écran Créer un certificat s’affiche.
Notes
Ce tutoriel utilise un certificat de développement. Le même processus est utilisé lors de l’inscription d’un certificat de production. Veillez simplement à utiliser le même type de certificat lors de l’envoi de notifications.
Sélectionnez Choisir un fichier, accédez à l’emplacement où vous avez enregistré le fichier CSR, puis double-cliquez sur le nom du certificat pour le charger. Sélectionnez ensuite Continuer.
Une fois que le portail a créé le certificat, sélectionnez le bouton Télécharger . Enregistrez le certificat et mémorisez l’emplacement où il est enregistré.
Le certificat est téléchargé et enregistré sur votre ordinateur dans votre dossier Téléchargements .
Notes
Par défaut, le certificat de développement téléchargé est nommé aps_development.cer.
Double-cliquez sur le certificat Push téléchargé aps_development.cer. Cette action installe le nouveau certificat dans le trousseau, comme illustré dans l’image suivante :
Notes
Bien que le nom de votre certificat puisse être différent, le nom est préfixé par Apple Development iOS Push Services et l’identificateur de bundle approprié est associé.
Dans Accès au trousseau, Contrôle + Cliquez sur le nouveau certificat push que vous avez créé dans la catégorie Certificats . Sélectionnez Exporter, nommez le fichier, sélectionnez le format p12 , puis sélectionnez Enregistrer.
Vous pouvez choisir de protéger le certificat avec un mot de passe, mais un mot de passe est facultatif. Cliquez sur OK si vous souhaitez ignorer la création du mot de passe. Notez le nom de fichier et l’emplacement du certificat p12 exporté. Ils sont utilisés pour activer l’authentification avec les APN.
Notes
Le nom et l’emplacement de votre fichier p12 peuvent être différents de ce qui est illustré dans ce tutoriel.
OPTION 2 : Création d’un certificat p8 qui peut être utilisé pour l’authentification basée sur les jetons
Notez les détails suivants :
- Préfixe d’ID d’application (ID d’équipe)
- ID d’offre groupée
De retour dans Certificats, identificateurs & profils, cliquez sur Clés.
Notes
Si vous avez déjà configuré une clé pour APNS, vous pouvez réutiliser le certificat p8 que vous avez téléchargé juste après sa création. Dans ce cas, vous pouvez ignorer les étapes 3 à 5.
Cliquez sur le + bouton (ou sur le bouton Créer une clé ) pour créer une nouvelle clé.
Fournissez une valeur de nom de clé appropriée, puis case activée l’option APNS (Apple Push Notifications Service), puis cliquez sur Continuer, puis sur Inscrire sur l’écran suivant.
Cliquez sur Télécharger , puis déplacez le fichier p8 (préfixé par AuthKey_) vers un répertoire local sécurisé, puis cliquez sur Terminé.
Notes
Veillez à conserver votre fichier p8 dans un endroit sécurisé (et à enregistrer une sauvegarde). Après avoir téléchargé votre clé, elle ne peut pas être téléchargée à nouveau, car la copie du serveur est supprimée.
Sur Clés, cliquez sur la clé que vous avez créée (ou sur une clé existante si vous avez choisi de l’utiliser à la place).
Notez la valeur de l’ID de clé .
Ouvrez votre certificat p8 dans une application appropriée de votre choix, telle que Visual Studio Code. Notez la valeur de la clé (entre -----BEGIN PRIVATE KEY----- et -----END PRIVATE KEY-----).
-----BEGIN PRIVATE KEY-----
<key_value>
-----END PRIVATE KEY-----Notes
Il s’agit de la valeur de jeton qui sera utilisée ultérieurement pour configurer Notification Hub.
À la fin de ces étapes, vous devez disposer des informations suivantes pour une utilisation ultérieure dans Configurer votre hub de notification avec les informations APNS :
- ID d’équipe (voir l’étape 1)
- ID de bundle (voir étape 1)
- ID de clé (voir l’étape 7)
- Valeur de jeton (valeur de clé p8 obtenue à l’étape 8)
Créer un profil d’approvisionnement pour l’application
Revenez au portail d’approvisionnement iOS, sélectionnez Certificats, Identificateurs & Profils, Sélectionnez Profils dans le menu de gauche, puis sélectionnez + pour créer un profil. L’écran Inscrire un nouveau profil d’approvisionnement s’affiche.
Sélectionnez Développement d’applications iOS sous Développement comme type de profil d’approvisionnement, puis sélectionnez Continuer.
Ensuite, sélectionnez l’ID d’application que vous avez créé dans la liste déroulante ID d’application , puis sélectionnez Continuer.
Dans la fenêtre Sélectionner des certificats , sélectionnez le certificat de développement que vous utilisez pour la signature de code, puis sélectionnez Continuer.
Notes
Ce certificat n’est pas le certificat push que vous avez créé à l’étape précédente. Il s’agit de votre certificat de développement. S’il n’en existe pas, vous devez le créer, car il s’agit d’un prérequis pour ce didacticiel. Les certificats de développeur peuvent être créés dans le portail des développeurs Apple, via Xcode ou dans Visual Studio.
Revenez à la page Certificats, Identificateurs & Profils , sélectionnez Profils dans le menu de gauche, puis sélectionnez + pour créer un profil. L’écran Inscrire un nouveau profil d’approvisionnement s’affiche.
Dans la fenêtre Sélectionner des certificats , sélectionnez le certificat de développement que vous avez créé. Sélectionnez ensuite Continuer.
Ensuite, sélectionnez les appareils à utiliser pour les tests, puis sélectionnez Continuer.
Enfin, choisissez un nom pour le profil dans Nom du profil d’approvisionnement, puis sélectionnez Générer.
Lorsque le nouveau profil d’approvisionnement est créé, sélectionnez Télécharger. N’oubliez pas l’emplacement dans lequel il est enregistré.
Accédez à l’emplacement du profil d’approvisionnement, puis double-cliquez dessus pour l’installer sur votre ordinateur de développement.
Créer un hub de notification
Dans cette section, vous allez créer un hub de notification et configurer l’authentification avec APNS. Vous pouvez utiliser un certificat push p12 ou une authentification basée sur des jetons. Si vous souhaitez utiliser un hub de notification que vous avez déjà créé, vous pouvez passer à l’étape 5.
Connectez-vous à Azure.
Cliquez sur Créer une ressource, recherchez et choisissez Notification Hub, puis cliquez sur Créer.
Mettez à jour les champs suivants, puis cliquez sur Créer :
DÉTAILS DE BASE
Abonnement: Choisissez l’abonnement cible dans la liste déroulante
Groupe de ressources : Créer un groupe de ressources (ou en choisir un existant)DÉTAILS DE L’ESPACE DE NOMS
Espace de noms Du hub de notification : Entrez un nom global unique pour l’espace de noms Notification Hub
Notes
Vérifiez que l’option Créer un nouveau est sélectionnée pour ce champ.
DÉTAILS DU HUB DE NOTIFICATION
Hub de notification : Entrez un nom pour le hub de notification
Emplacement: Choisir un emplacement approprié dans la liste déroulante
Niveau tarifaire : Conserver l’option Gratuit par défautNotes
Sauf si vous avez atteint le nombre maximal de hubs sur le niveau gratuit.
Une fois que le hub de notification a été provisionné, accédez à cette ressource.
Accédez à votre nouveau hub de notification.
Sélectionnez Stratégies d’accès dans la liste (sous GÉRER).
Notez les valeurs Nom de la stratégie ainsi que leurs valeurs de chaîne de connexion correspondantes .
Configurer votre hub de notification avec les informations APNS
Sous Notification Services, sélectionnez Apple , puis suivez les étapes appropriées en fonction de l’approche que vous avez choisie précédemment dans la section Création d’un certificat pour Notification Hubs .
Notes
Utilisez le mode Production pour application uniquement si vous souhaitez envoyer des notifications Push aux utilisateurs qui ont acheté votre application à partir du Store.
OPTION 1 : Utilisation d’un certificat push .p12
Sélectionnez Certificat.
Sélectionnez l’icône de fichier.
Sélectionnez le fichier .p12 que vous avez exporté précédemment, puis sélectionnez Ouvrir.
Si nécessaire, spécifiez le mot de passe correct.
Sélectionnez Mode bac à sable .
Sélectionnez Enregistrer.
OPTION 2 : Utilisation de l’authentification basée sur les jetons
Sélectionnez Jeton.
Entrez les valeurs suivantes que vous avez acquises précédemment :
- ID de clé
- ID d’offre groupée
- ID d’équipe
- Jeton
Choisissez Bac à sable.
Sélectionnez Enregistrer.
Configurer votre hub de notification avec des informations FCM
- Sélectionnez Google (GCM/FCM) dans la section Paramètres du menu de gauche.
- Entrez la clé de serveur que vous avez notée à partir de la console Google Firebase.
- Sélectionnez Enregistrer dans la barre d’outils.
Créer une application principale d’API web ASP.NET Core
Dans cette section, vous allez créer le back-end d’API web ASP.NET Core pour gérer l’inscription de l’appareil et l’envoi de notifications à l’application mobile React Native.
Créer un projet web
Dans Visual Studio, sélectionnez Fichier>Nouvelle solution.
SélectionnezApplication>.NET Core>ASP.NET Core>API>Suivant.
Dans la boîte de dialogue Configurer votre nouvelle API web ASP.NET Core, sélectionnez Framework cible de .NET Core 3.1.
Entrez PushDemoApi comme nom du projet , puis sélectionnez Créer.
Démarrez le débogage (Entrée de commande + ) pour tester l’application modèle.
Notes
L’application modèle est configurée pour utiliser WeatherForecastController comme launchUrl. Cette valeur est définie dans Propriétés>launchSettings.json.
Si vous êtes invité à fournir un certificat de développement non valide, message trouvé :
Cliquez sur Oui pour accepter d’exécuter l’outil « dotnet dev-certs https » pour résoudre ce problème. L’outil « dotnet dev-certs https » vous invite ensuite à entrer un mot de passe pour le certificat et le mot de passe de votre trousseau.
Cliquez sur Oui lorsque vous êtes invité à installer et à approuver le nouveau certificat, puis entrez le mot de passe de votre trousseau.
Développez le dossier Contrôleurs , puis supprimez WeatherForecastController.cs.
Supprimez WeatherForecast.cs.
Configurez des valeurs de configuration locales à l’aide de l’outil Gestionnaire de secrets. Le découplage des secrets de la solution garantit qu’ils ne se retrouvent pas dans le contrôle de code source. Ouvrez Terminal , puis accédez au répertoire du fichier projet et exécutez les commandes suivantes :
dotnet user-secrets init dotnet user-secrets set "NotificationHub:Name" <value> dotnet user-secrets set "NotificationHub:ConnectionString" <value>Remplacez les valeurs d’espace réservé par votre propre nom de hub de notification et chaîne de connexion valeurs. Vous en avez pris note dans la section Créer un hub de notification . Sinon, vous pouvez les rechercher dans Azure.
NotificationHub :Name :
Consultez Nom dans le résumé Essentials en haut de Vue d’ensemble.NotificationHub :ConnectionString :
Consultez DefaultFullSharedAccessSignature dans stratégies d’accèsNotes
Pour les scénarios de production, vous pouvez examiner des options telles qu’Azure KeyVault pour stocker de manière sécurisée les chaîne de connexion. Par souci de simplicité, les secrets seront ajoutés aux paramètres de l’application Azure App Service.
Authentifier les clients à l’aide d’une clé API (facultatif)
Les clés API ne sont pas aussi sécurisées que les jetons, mais elles suffisent pour les besoins de ce didacticiel. Une clé API peut être configurée facilement via l’intergiciel ASP.NET.
Ajoutez la clé API aux valeurs de configuration locales.
dotnet user-secrets set "Authentication:ApiKey" <value>Notes
Vous devez remplacer la valeur de l’espace réservé par la vôtre et en prendre note.
Contrôle + Cliquez sur le projet PushDemoApi , choisissez Nouveau dossier dans le menu Ajouter , puis cliquez sur Ajouter à l’aide de l’authentification comme nom de dossier.
Contrôle + Cliquez sur le dossier Authentification , puis choisissez Nouveau fichier... dans le menu Ajouter .
Sélectionnez Classe vide générale>, entrez ApiKeyAuthOptions.cs pour le nom, puis cliquez sur Nouveau en ajoutant l’implémentation suivante.
using Microsoft.AspNetCore.Authentication; namespace PushDemoApi.Authentication { public class ApiKeyAuthOptions : AuthenticationSchemeOptions { public const string DefaultScheme = "ApiKey"; public string Scheme => DefaultScheme; public string ApiKey { get; set; } } }Ajoutez une autre classe vide au dossier d’authentification appelé ApiKeyAuthHandler.cs, puis ajoutez l’implémentation suivante.
using System; using System.Collections.Generic; using System.Linq; using System.Security.Claims; using System.Text.Encodings.Web; using System.Threading.Tasks; using Microsoft.AspNetCore.Authentication; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; namespace PushDemoApi.Authentication { public class ApiKeyAuthHandler : AuthenticationHandler<ApiKeyAuthOptions> { const string ApiKeyIdentifier = "apikey"; public ApiKeyAuthHandler( IOptionsMonitor<ApiKeyAuthOptions> options, ILoggerFactory logger, UrlEncoder encoder, ISystemClock clock) : base(options, logger, encoder, clock) {} protected override Task<AuthenticateResult> HandleAuthenticateAsync() { string key = string.Empty; if (Request.Headers[ApiKeyIdentifier].Any()) { key = Request.Headers[ApiKeyIdentifier].FirstOrDefault(); } else if (Request.Query.ContainsKey(ApiKeyIdentifier)) { if (Request.Query.TryGetValue(ApiKeyIdentifier, out var queryKey)) key = queryKey; } if (string.IsNullOrWhiteSpace(key)) return Task.FromResult(AuthenticateResult.Fail("No api key provided")); if (!string.Equals(key, Options.ApiKey, StringComparison.Ordinal)) return Task.FromResult(AuthenticateResult.Fail("Invalid api key.")); var identities = new List<ClaimsIdentity> { new ClaimsIdentity("ApiKeyIdentity") }; var ticket = new AuthenticationTicket( new ClaimsPrincipal(identities), Options.Scheme); return Task.FromResult(AuthenticateResult.Success(ticket)); } } }Notes
Un gestionnaire d’authentification est un type qui implémente le comportement d’un schéma, dans ce cas un schéma de clé API personnalisé.
Ajoutez une autre classe vide au dossier d’authentification appelé ApiKeyAuthenticationBuilderExtensions.cs, puis ajoutez l’implémentation suivante.
using System; using Microsoft.AspNetCore.Authentication; namespace PushDemoApi.Authentication { public static class AuthenticationBuilderExtensions { public static AuthenticationBuilder AddApiKeyAuth( this AuthenticationBuilder builder, Action<ApiKeyAuthOptions> configureOptions) { return builder .AddScheme<ApiKeyAuthOptions, ApiKeyAuthHandler>( ApiKeyAuthOptions.DefaultScheme, configureOptions); } } }Notes
Cette méthode d’extension simplifie le code de configuration du middleware dans Startup.cs le rendant plus lisible et généralement plus facile à suivre.
Dans Startup.cs, mettez à jour la méthode ConfigureServices pour configurer l’authentification par clé API sous l’appel aux services. Méthode AddControllers .
using PushDemoApi.Authentication; using PushDemoApi.Models; using PushDemoApi.Services; public void ConfigureServices(IServiceCollection services) { services.AddControllers(); services.AddAuthentication(options => { options.DefaultAuthenticateScheme = ApiKeyAuthOptions.DefaultScheme; options.DefaultChallengeScheme = ApiKeyAuthOptions.DefaultScheme; }).AddApiKeyAuth(Configuration.GetSection("Authentication").Bind); }Toujours dans Startup.cs, mettez à jour la méthode Configure pour appeler les méthodes d’extension UseAuthentication et UseAuthorization sur IApplicationBuilder de l’application. Assurez-vous que ces méthodes sont appelées après UseRouting et avant l’application. UtilisezEndpoints.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { if (env.IsDevelopment()) { app.UseDeveloperExceptionPage(); } app.UseHttpsRedirection(); app.UseRouting(); app.UseAuthentication(); app.UseAuthorization(); app.UseEndpoints(endpoints => { endpoints.MapControllers(); }); }Notes
L’appel de UseAuthentication inscrit l’intergiciel qui utilise les schémas d’authentification précédemment inscrits (à partir de ConfigureServices). Cela doit être appelé avant tout intergiciel qui dépend de l’authentification des utilisateurs.
Ajouter des dépendances et configurer des services
ASP.NET Core prend en charge le modèle de conception de logiciel d’injection de dépendances (DI), qui est une technique permettant d’obtenir l’inversion de contrôle (IoC) entre les classes et leurs dépendances.
L’utilisation du hub de notification et du Kit de développement logiciel (SDK) Notification Hubs pour les opérations back-end est encapsulée dans un service. Le service est inscrit et mis à disposition via une abstraction appropriée.
Contrôle + Cliquez sur le dossier Dépendances , puis choisissez Gérer les packages NuGet....
Recherchez Microsoft.Azure.NotificationHubs et vérifiez qu’il est vérifié.
Cliquez sur Ajouter des packages, puis sur Accepter lorsque vous êtes invité à accepter les termes du contrat de licence.
Contrôle + Cliquez sur le projet PushDemoApi , choisissez Nouveau dossier dans le menu Ajouter , puis cliquez sur Ajouter à l’aide de modèles comme nom du dossier.
Contrôle + Cliquez sur le dossier Models , puis choisissez Nouveau fichier... dans le menu Ajouter .
Sélectionnez Général>Classe vide, entrez PushTemplates.cs pour le Nom, puis cliquez sur Nouveau en ajoutant l’implémentation suivante.
namespace PushDemoApi.Models { public class PushTemplates { public class Generic { public const string Android = "{ \"notification\": { \"title\" : \"PushDemo\", \"body\" : \"$(alertMessage)\"}, \"data\" : { \"action\" : \"$(alertAction)\" } }"; public const string iOS = "{ \"aps\" : {\"alert\" : \"$(alertMessage)\"}, \"action\" : \"$(alertAction)\" }"; } public class Silent { public const string Android = "{ \"data\" : {\"message\" : \"$(alertMessage)\", \"action\" : \"$(alertAction)\"} }"; public const string iOS = "{ \"aps\" : {\"content-available\" : 1, \"apns-priority\": 5, \"sound\" : \"\", \"badge\" : 0}, \"message\" : \"$(alertMessage)\", \"action\" : \"$(alertAction)\" }"; } } }Notes
Cette classe contient les charges utiles de notification avec jetons pour les notifications génériques et silencieuses requises par ce scénario. Les charges utiles sont définies en dehors de l’installation pour permettre l’expérimentation sans avoir à mettre à jour les installations existantes via le service. La gestion des modifications apportées aux installations de cette façon est hors de portée pour ce tutoriel. Pour la production, envisagez des modèles personnalisés.
Ajoutez une autre classe vide au dossier Models appelée DeviceInstallation.cs, puis ajoutez l’implémentation suivante.
using System.Collections.Generic; using System.ComponentModel.DataAnnotations; namespace PushDemoApi.Models { public class DeviceInstallation { [Required] public string InstallationId { get; set; } [Required] public string Platform { get; set; } [Required] public string PushChannel { get; set; } public IList<string> Tags { get; set; } = Array.Empty<string>(); } }Ajoutez une autre classe vide au dossier Models appelée NotificationRequest.cs, puis ajoutez l’implémentation suivante.
using System; namespace PushDemoApi.Models { public class NotificationRequest { public string Text { get; set; } public string Action { get; set; } public string[] Tags { get; set; } = Array.Empty<string>(); public bool Silent { get; set; } } }Ajoutez une autre classe vide au dossier Models appelée NotificationHubOptions.cs, puis ajoutez l’implémentation suivante.
using System.ComponentModel.DataAnnotations; namespace PushDemoApi.Models { public class NotificationHubOptions { [Required] public string Name { get; set; } [Required] public string ConnectionString { get; set; } } }Ajoutez un nouveau dossier au projet PushDemoApi appelé Services.
Ajoutez une interface vide au dossier Services appelée INotificationService.cs, puis ajoutez l’implémentation suivante.
using System.Threading; using System.Threading.Tasks; using PushDemoApi.Models; namespace PushDemoApi.Services { public interface INotificationService { Task<bool> CreateOrUpdateInstallationAsync(DeviceInstallation deviceInstallation, CancellationToken token); Task<bool> DeleteInstallationByIdAsync(string installationId, CancellationToken token); Task<bool> RequestNotificationAsync(NotificationRequest notificationRequest, CancellationToken token); } }Ajoutez une classe vide au dossier Services appelée NotificationHubsService.cs, puis ajoutez le code suivant pour implémenter l’interface INotificationService :
using System; using System.Collections.Generic; using System.Linq; using System.Threading; using System.Threading.Tasks; using Microsoft.Azure.NotificationHubs; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; using PushDemoApi.Models; namespace PushDemoApi.Services { public class NotificationHubService : INotificationService { readonly NotificationHubClient _hub; readonly Dictionary<string, NotificationPlatform> _installationPlatform; readonly ILogger<NotificationHubService> _logger; public NotificationHubService(IOptions<NotificationHubOptions> options, ILogger<NotificationHubService> logger) { _logger = logger; _hub = NotificationHubClient.CreateClientFromConnectionString( options.Value.ConnectionString, options.Value.Name); _installationPlatform = new Dictionary<string, NotificationPlatform> { { nameof(NotificationPlatform.Apns).ToLower(), NotificationPlatform.Apns }, { nameof(NotificationPlatform.Fcm).ToLower(), NotificationPlatform.Fcm } }; } public async Task<bool> CreateOrUpdateInstallationAsync(DeviceInstallation deviceInstallation, CancellationToken token) { if (string.IsNullOrWhiteSpace(deviceInstallation?.InstallationId) || string.IsNullOrWhiteSpace(deviceInstallation?.Platform) || string.IsNullOrWhiteSpace(deviceInstallation?.PushChannel)) return false; var installation = new Installation() { InstallationId = deviceInstallation.InstallationId, PushChannel = deviceInstallation.PushChannel, Tags = deviceInstallation.Tags }; if (_installationPlatform.TryGetValue(deviceInstallation.Platform, out var platform)) installation.Platform = platform; else return false; try { await _hub.CreateOrUpdateInstallationAsync(installation, token); } catch { return false; } return true; } public async Task<bool> DeleteInstallationByIdAsync(string installationId, CancellationToken token) { if (string.IsNullOrWhiteSpace(installationId)) return false; try { await _hub.DeleteInstallationAsync(installationId, token); } catch { return false; } return true; } public async Task<bool> RequestNotificationAsync(NotificationRequest notificationRequest, CancellationToken token) { if ((notificationRequest.Silent && string.IsNullOrWhiteSpace(notificationRequest?.Action)) || (!notificationRequest.Silent && (string.IsNullOrWhiteSpace(notificationRequest?.Text)) || string.IsNullOrWhiteSpace(notificationRequest?.Action))) return false; var androidPushTemplate = notificationRequest.Silent ? PushTemplates.Silent.Android : PushTemplates.Generic.Android; var iOSPushTemplate = notificationRequest.Silent ? PushTemplates.Silent.iOS : PushTemplates.Generic.iOS; var androidPayload = PrepareNotificationPayload( androidPushTemplate, notificationRequest.Text, notificationRequest.Action); var iOSPayload = PrepareNotificationPayload( iOSPushTemplate, notificationRequest.Text, notificationRequest.Action); try { if (notificationRequest.Tags.Length == 0) { // This will broadcast to all users registered in the notification hub await SendPlatformNotificationsAsync(androidPayload, iOSPayload, token); } else if (notificationRequest.Tags.Length <= 20) { await SendPlatformNotificationsAsync(androidPayload, iOSPayload, notificationRequest.Tags, token); } else { var notificationTasks = notificationRequest.Tags .Select((value, index) => (value, index)) .GroupBy(g => g.index / 20, i => i.value) .Select(tags => SendPlatformNotificationsAsync(androidPayload, iOSPayload, tags, token)); await Task.WhenAll(notificationTasks); } return true; } catch (Exception e) { _logger.LogError(e, "Unexpected error sending notification"); return false; } } string PrepareNotificationPayload(string template, string text, string action) => template .Replace("$(alertMessage)", text, StringComparison.InvariantCulture) .Replace("$(alertAction)", action, StringComparison.InvariantCulture); Task SendPlatformNotificationsAsync(string androidPayload, string iOSPayload, CancellationToken token) { var sendTasks = new Task[] { _hub.SendFcmNativeNotificationAsync(androidPayload, token), _hub.SendAppleNativeNotificationAsync(iOSPayload, token) }; return Task.WhenAll(sendTasks); } Task SendPlatformNotificationsAsync(string androidPayload, string iOSPayload, IEnumerable<string> tags, CancellationToken token) { var sendTasks = new Task[] { _hub.SendFcmNativeNotificationAsync(androidPayload, tags, token), _hub.SendAppleNativeNotificationAsync(iOSPayload, tags, token) }; return Task.WhenAll(sendTasks); } } }Notes
L’expression de balise fournie à SendTemplateNotificationAsync est limitée à 20 balises. Elle est limitée à 6 pour la plupart des opérateurs, mais l’expression contient uniquement des OR (||) dans ce cas. S’il y a plus de 20 balises dans la demande, elles doivent être divisées en plusieurs requêtes. Pour plus d’informations, consultez la documentation routage et expressions de balise.
Dans Startup.cs, mettez à jour la méthode ConfigureServices pour ajouter NotificationHubsService en tant qu’implémentation singleton d’INotificationService.
using PushDemoApi.Models; using PushDemoApi.Services; public void ConfigureServices(IServiceCollection services) { ... services.AddSingleton<INotificationService, NotificationHubService>(); services.AddOptions<NotificationHubOptions>() .Configure(Configuration.GetSection("NotificationHub").Bind) .ValidateDataAnnotations(); }
Créer l’API de notifications
Contrôle + Cliquez sur le dossier Contrôleurs , puis choisissez Nouveau fichier... dans le menu Ajouter .
Sélectionnez ASP.NET Core>Classe de contrôleur d’API Web, entrez NotificationsContrôleur comme Nom, puis cliquez sur Nouveau.
Notes
Si vous suivez avec Visual Studio 2019, choisissez le modèle Contrôleur d’API avec des actions de lecture/écriture .
Ajoutez les espaces de noms suivants en haut du fichier.
using System.ComponentModel.DataAnnotations; using System.Net; using System.Threading; using System.Threading.Tasks; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using PushDemoApi.Models; using PushDemoApi.Services;Mettez à jour le contrôleur basé sur un modèle afin qu’il dérive de ControllerBase et soit décoré avec l’attribut ApiController .
[ApiController] [Route("api/[controller]")] public class NotificationsController : ControllerBase { // Templated methods here }Notes
La classe de base Controller prend en charge les vues, mais cela n’est pas nécessaire dans ce cas et controllerBase peut donc être utilisé à la place. Si vous suivez avec Visual Studio 2019, vous pouvez ignorer cette étape.
Si vous avez choisi de terminer la section Authentifier les clients à l’aide d’une clé API , vous devez également décorer notificationsController avec l’attribut Authorize .
[Authorize]Mettez à jour le constructeur pour accepter le instance inscrit de INotificationService en tant qu’argument et l’affecter à un membre readonly.
readonly INotificationService _notificationService; public NotificationsController(INotificationService notificationService) { _notificationService = notificationService; }Dans launchSettings.json (dans le dossier Propriétés ), remplacez launchUrl par
weatherforecastapi/notifications pour qu’il corresponde à l’URL spécifiée dans l’attribut RegistrationsControllerRoute .Démarrez le débogage (Entrée de commande + ) pour vérifier que l’application fonctionne avec le nouveau NotificationsController et retourne une status non autorisée 401.
Notes
Visual Studio peut ne pas lancer automatiquement l’application dans le navigateur. Vous allez utiliser Postman pour tester l’API à partir de ce point.
Dans un nouvel onglet Postman , définissez la requête sur GET. Entrez l’adresse ci-dessous en remplaçant l’espace réservé <applicationUrl> par l’applicationUrl https trouvée dans Propriétés>launchSettings.json.
<applicationUrl>/api/notificationsNotes
ApplicationUrl doit être «https://localhost:5001 » pour le profil par défaut. Si vous utilisez IIS (valeur par défaut dans Visual Studio 2019 sur Windows), vous devez utiliser l’applicationUrl spécifié dans l’élément iisSettings à la place. Vous recevrez une réponse 404 si l’adresse est incorrecte.
Si vous avez choisi de terminer la section Authentifier les clients à l’aide d’une clé API , veillez à configurer les en-têtes de requête pour inclure votre valeur apikey .
Clé Valeur apikey <your_api_key> Cliquez sur le bouton Envoyer .
Notes
Vous devez recevoir un status 200 OK avec du contenu JSON.
Si vous recevez un avertissement de vérification de certificat SSL , vous pouvez désactiver le paramètre Postman de demande de vérification du certificat SSL dans paramètres.
Remplacez les méthodes de classe modèles dans NotificationsController.cs par le code suivant.
[HttpPut] [Route("installations")] [ProducesResponseType((int)HttpStatusCode.OK)] [ProducesResponseType((int)HttpStatusCode.BadRequest)] [ProducesResponseType((int)HttpStatusCode.UnprocessableEntity)] public async Task<IActionResult> UpdateInstallation( [Required]DeviceInstallation deviceInstallation) { var success = await _notificationService .CreateOrUpdateInstallationAsync(deviceInstallation, HttpContext.RequestAborted); if (!success) return new UnprocessableEntityResult(); return new OkResult(); } [HttpDelete()] [Route("installations/{installationId}")] [ProducesResponseType((int)HttpStatusCode.OK)] [ProducesResponseType((int)HttpStatusCode.BadRequest)] [ProducesResponseType((int)HttpStatusCode.UnprocessableEntity)] public async Task<ActionResult> DeleteInstallation( [Required][FromRoute]string installationId) { var success = await _notificationService .DeleteInstallationByIdAsync(installationId, CancellationToken.None); if (!success) return new UnprocessableEntityResult(); return new OkResult(); } [HttpPost] [Route("requests")] [ProducesResponseType((int)HttpStatusCode.OK)] [ProducesResponseType((int)HttpStatusCode.BadRequest)] [ProducesResponseType((int)HttpStatusCode.UnprocessableEntity)] public async Task<IActionResult> RequestPush( [Required]NotificationRequest notificationRequest) { if ((notificationRequest.Silent && string.IsNullOrWhiteSpace(notificationRequest?.Action)) || (!notificationRequest.Silent && string.IsNullOrWhiteSpace(notificationRequest?.Text))) return new BadRequestResult(); var success = await _notificationService .RequestNotificationAsync(notificationRequest, HttpContext.RequestAborted); if (!success) return new UnprocessableEntityResult(); return new OkResult(); }
Créer l’application API
Vous créez maintenant une application API dans Azure App Service pour héberger le service back-end.
Connectez-vous au portail Azure.
Cliquez sur Créer une ressource, recherchez et choisissez Application API, puis cliquez sur Créer.
Mettez à jour les champs suivants, puis cliquez sur Créer.
Nom de l’application :
Entrez un nom global unique pour l’application APIAbonnement:
Choisissez l’abonnement cible dans lequel vous avez créé le hub de notification.Groupe de ressources :
Choisissez le groupe de ressources dans lequel vous avez créé le hub de notification.plan/emplacement App Service :
Créer un plan App ServiceNotes
Passez de l’option par défaut à un plan qui inclut la prise en charge SSL . Sinon, vous devez prendre les mesures appropriées lorsque vous utilisez l’application mobile pour empêcher le blocage des requêtes HTTP .
Application Insights :
Conservez l’option suggérée (une nouvelle ressource sera créée à l’aide de ce nom) ou choisissez une ressource existante.Une fois l’application API approvisionnée, accédez à cette ressource.
Notez la propriété URL dans le résumé Essentials en haut de la vue d’ensemble. Cette URL est votre point de terminaison principal qui sera utilisé plus loin dans ce tutoriel.
Notes
L’URL utilise le nom de l’application API que vous avez spécifié précédemment, avec le format
https://<app_name>.azurewebsites.net.Sélectionnez Configuration dans la liste (sous Paramètres).
Pour chacun des paramètres ci-dessous, cliquez sur Nouveau paramètre d’application pour entrer le Nom et une Valeur, puis cliquez sur OK.
Nom Valeur Authentication:ApiKey<api_key_value> NotificationHub:Name<hub_name_value> NotificationHub:ConnectionString<hub_connection_string_value> Notes
Il s’agit des mêmes paramètres que vous avez définis précédemment dans les paramètres utilisateur. Vous devriez pouvoir les copier. Le paramètre Authentication :ApiKey est requis uniquement si vous avez choisi d’effectuer la section Authentifier les clients à l’aide d’une clé API . Pour les scénarios de production, vous pouvez examiner des options telles qu’Azure KeyVault. Ceux-ci ont été ajoutés en tant que paramètres d’application par souci de simplicité dans ce cas.
Une fois que tous les paramètres d’application ont été ajoutés, cliquez sur Enregistrer, puis sur Continuer.
Publier le service back-end
Ensuite, vous déployez l’application sur l’application API pour la rendre accessible à partir de tous les appareils.
Notes
Les étapes suivantes sont spécifiques à Visual Studio pour Mac. Si vous suivez avec Visual Studio 2019 sur Windows, le flux de publication sera différent. Consultez Publier sur Azure App Service sur Windows.
Si vous ne l’avez pas déjà fait, modifiez votre configuration de Debug à Release .
Contrôle + Cliquez sur le projet PushDemoApi , puis choisissez Publier sur Azure... dans le menu Publier .
Suivez le flux d’authentification si vous y êtes invité. Utilisez le compte que vous avez utilisé dans la section créer l’application API précédente.
Sélectionnez l’application API Azure App Service que vous avez créée précédemment dans la liste comme cible de publication, puis cliquez sur Publier.
Une fois l’Assistant terminé, il publie l’application sur Azure, puis ouvre l’application. Notez l’URL si vous ne l’avez pas déjà fait. Cette URL est votre point de terminaison principal qui est utilisé plus loin dans ce tutoriel.
Validation de l’API publiée
Dans Postman , ouvrez un nouvel onglet, définissez la requête sur PUT et entrez l’adresse ci-dessous. Remplacez l’espace réservé par l’adresse de base que vous avez notée dans la section précédente publier le service back-end .
https://<app_name>.azurewebsites.net/api/notifications/installationsNotes
L’adresse de base doit être au format
https://<app_name>.azurewebsites.net/Si vous avez choisi de terminer la section Authentifier les clients à l’aide d’une clé API , veillez à configurer les en-têtes de requête pour inclure votre valeur apikey .
Clé Valeur apikey <your_api_key> Choisissez l’option brutepour corps, choisissez JSON dans la liste des options de format, puis incluez du contenu JSON d’espace réservé :
{}Cliquez sur Envoyer.
Notes
Vous devez recevoir un status UnprocessableEntity 422 du service.
Effectuez à nouveau les étapes 1 à 4, mais cette fois en spécifiant le point de terminaison des demandes pour valider, vous recevez une réponse 400 demande incorrecte .
https://<app_name>.azurewebsites.net/api/notifications/requests
Notes
Il n’est pas encore possible de tester l’API à l’aide de données de requête valides, car cela nécessite des informations spécifiques à la plateforme de l’application mobile cliente.
Créer une application React Native multiplateforme
Dans cette section, vous allez créer une application mobile React Native implémentant des notifications Push de manière multiplateforme.
Il vous permet de vous inscrire et de vous désinscrire à partir d’un hub de notification via le service back-end que vous avez créé.
Une alerte s’affiche lorsqu’une action est spécifiée et que l’application se trouve au premier plan. Sinon, les notifications s’affichent dans le centre de notifications.
Notes
Vous effectuez généralement les actions d’inscription (et de désinscription) pendant le point approprié du cycle de vie de l’application (ou dans le cadre de votre expérience de première exécution peut-être) sans entrées d’inscription/désinscription explicites de l’utilisateur. Toutefois, cet exemple nécessite une entrée explicite de l’utilisateur pour permettre à cette fonctionnalité d’être explorée et testée plus facilement.
Créer la solution React Native
Dans
Terminal, mettez à jour vos outils d’environnement, requis pour utiliser React Native à l’aide des commandes suivantes :# install node brew install node # or update brew update node # install watchman brew install watchman # or update brew upgrade watchman # install cocoapods sudo gem install cocoapodsDans
Terminal, exécutez la commande suivante, si l’interface CLI estReact Nativeinstallée pour la désinstaller. Utiliseznpxpour accéder automatiquement à la dernière version React Native CLI disponible :npm uninstall -g react-native-cliNotes
React Native dispose d’une interface de ligne de commande intégrée. Au lieu d’installer et de gérer globalement une version spécifique de l’interface CLI, nous vous recommandons d’accéder à la version actuelle au moment de l’exécution à l’aide
npxde , qui est fournie avec Node.js. Avecnpx react-native <command>, la version stable actuelle de l’interface CLI est téléchargée et exécutée au moment de l’exécution de la commande.Accédez au dossier de vos projets dans lequel vous souhaitez créer la nouvelle application. Utilisez le modèle basé sur Typescript en spécifiant le
--templateparamètre :# init new project with npx npx react-native init PushDemo --template react-native-template-typescriptExécutez le serveur metro, qui génère des bundles JavaScript et surveille toutes les mises à jour de code pour actualiser les bundles en temps réel :
cd PushDemo npx react-native startExécutez l’application iOS pour vérifier l’installation. Vérifiez que vous avez démarré un simulateur iOS ou connecté un appareil iOS avant d’exécuter la commande suivante :
npx react-native run-iosExécutez l’application Android pour vérifier l’installation. Il nécessite quelques étapes supplémentaires pour configurer un émulateur ou un appareil Android afin de pouvoir accéder au serveur React Native metro. Les commandes suivantes génèrent un bundle JavaScript initial pour Android et le placent dans le dossier assets.
# create assets folder for the bundle mkdir android/app/scr/main/assets # build the bundle npx react-native bundle --platform android --dev true --entry-file index.js --bundle-output android/app/src/main/assets/index.android.bundle --assets-dest android/app/src/main/res # enable ability for sim to access the localhost adb reverse tcp:8081 tcp:8081Ce script sera prédéployé avec la version initiale de l’application. Une fois le déploiement effectué, configurez votre émulateur ou votre appareil pour accéder au serveur metro en spécifiant l’adresse IP du serveur. Exécutez la commande suivante pour générer et exécuter l’application Android :
npx react-native run-androidUne fois dans l’application, appuyez sur
CMD+M(émulateur) ou secouez l’appareil pour remplir les paramètres du développeur, accédez àChange Bundle LocationSettings> et spécifiez l’adresse IP du serveur metro avec le port par défaut : .<metro-server-ip-address>:8081Dans le
App.tsxfichier, appliquez toute modification à la mise en page, enregistrez-la et la modification est automatiquement répercutée dans les applications iOS et Android.Notes
Le guide de configuration détaillé de l’environnement de développement est disponible dans la documentation officielle
Installer les packages requis
Vous avez besoin des trois packages suivants pour que cet exemple fonctionne :
React Native Notifications PushsurGitHub du projet iOS -
Ce package a été créé lorsque pushNotificationIOS a été fractionné du cœur de React Native. Le package implémente en mode natif les notifications Push pour iOS et fournit React Native interface pour y accéder. Exécutez la commande suivante pour installer le package :
yarn add @react-native-community/push-notification-iosnotifications Push React Native multiplateforme
Ce package implémente les notifications locales et à distance sur iOS et Android de manière multiplateforme. Exécutez la commande suivante pour installer le package :
yarn add react-native-push-notificationPackage d’informations sur l’appareil Le package fournit des informations sur un appareil en cours d’exécution. Utilisez-le pour définir un identificateur d’appareil, qui est utilisé pour s’inscrire à la notification Push. Exécutez la commande suivante pour installer le package :
yarn add react-native-device-info
Implémenter les composants multiplateformes
Créez et implémentez
DemoNotificationHandler:import PushNotification from 'react-native-push-notification'; class DemoNotificationHandler { private _onRegister: any; private _onNotification: any; onNotification(notification: any) { console.log('NotificationHandler:', notification); if (typeof this._onNotification === 'function') { this._onNotification(notification); } } onRegister(token: any) { console.log('NotificationHandler:', token); if (typeof this._onRegister === 'function') { this._onRegister(token); } } attachTokenReceived(handler: any) { this._onRegister = handler; } attachNotificationReceived(handler: any) { this._onNotification = handler; } } const handler = new DemoNotificationHandler(); PushNotification.configure({ onRegister: handler.onRegister.bind(handler), onNotification: handler.onNotification.bind(handler), permissions: { alert: true, badge: true, sound: true, }, popInitialNotification: true, requestPermissions: true, }); export default handler;Créez et implémentez
DemoNotificationService:import PushNotification from 'react-native-push-notification'; import DemoNotificationHandler from './DemoNotificationHandler'; export default class DemoNotificationService { constructor(onTokenReceived: any, onNotificationReceived: any) { DemoNotificationHandler.attachTokenReceived(onTokenReceived); DemoNotificationHandler.attachNotificationReceived(onNotificationReceived); PushNotification.getApplicationIconBadgeNumber(function(number: number) { if(number > 0) { PushNotification.setApplicationIconBadgeNumber(0); } }); } checkPermissions(cbk: any) { return PushNotification.checkPermissions(cbk); } requestPermissions() { return PushNotification.requestPermissions(); } cancelNotifications() { PushNotification.cancelLocalNotifications(); } cancelAll() { PushNotification.cancelAllLocalNotifications(); } abandonPermissions() { PushNotification.abandonPermissions(); } }Créez et implémentez
DemoNotificationRegistrationService:export default class DemoNotificationService { constructor( readonly apiUrl: string, readonly apiKey: string) { } async registerAsync(request: any): Promise<Response> { const method = 'PUT'; const registerApiUrl = `${this.apiUrl}/notifications/installations`; const result = await fetch(registerApiUrl, { method: method, headers: { Accept: 'application/json', 'Content-Type': 'application/json', 'apiKey': this.apiKey }, body: JSON.stringify(request) }); this.validateResponse(registerApiUrl, method, request, result); return result; } async deregisterAsync(deviceId: string): Promise<Response> { const method = 'DELETE'; const deregisterApiUrl = `${this.apiUrl}/notifications/installations/${deviceId}`; const result = await fetch(deregisterApiUrl, { method: method, headers: { Accept: 'application/json', 'Content-Type': 'application/json', 'apiKey': this.apiKey } }); this.validateResponse(deregisterApiUrl, method, null, result); return result; } private validateResponse(requestUrl: string, method: string, requestPayload: any, response: Response) { console.log(`Request: ${method} ${requestUrl} => ${JSON.stringify(requestPayload)}\nResponse: ${response.status}`); if (!response || response.status != 200) { throw `HTTP error ${response.status}: ${response.statusText}`; } } }Configurez l’application. Ouvrez
package.jsonet ajoutez la définition de script suivante :"configure": "cp .app.config.tsx src/config/AppConfig.tsx"Ensuite, exécutez ce script, qui copie la configuration par défaut dans le
configdossier .yarn configureLa dernière étape consiste à mettre à jour le fichier de configuration copié à l’étape précédente avec les informations d’accès à l’API. Spécifiez
apiKeyles paramètres etapiUrl:module.exports = { appName: "PushDemo", env: "production", apiUrl: "https://<azure-push-notifications-api-url>/api/", apiKey: "<api-auth-key>", };
Implémenter l’interface utilisateur multiplateforme
Définir la mise en page
<View style={styles.container}> {this.state.isBusy && <ActivityIndicator></ActivityIndicator> } <View style={styles.button}> <Button title="Register" onPress={this.onRegisterButtonPress.bind(this)} disabled={this.state.isBusy} /> </View> <View style={styles.button}> <Button title="Deregister" onPress={this.onDeregisterButtonPress.bind(this)} disabled={this.state.isBusy} /> </View> </View>Appliquer des styles
const styles = StyleSheet.create({ container: { flex: 1, alignItems: "center", justifyContent: 'flex-end', margin: 50, }, button: { margin: 5, width: "100%", } });Initialiser le composant de page
state: IState; notificationService: DemoNotificationService; notificationRegistrationService: DemoNotificationRegistrationService; deviceId: string; constructor(props: any) { super(props); this.deviceId = DeviceInfo.getUniqueId(); this.state = { status: "Push notifications registration status is unknown", registeredOS: "", registeredToken: "", isRegistered: false, isBusy: false, }; this.notificationService = new DemoNotificationService( this.onTokenReceived.bind(this), this.onNotificationReceived.bind(this), ); this.notificationRegistrationService = new DemoNotificationRegistrationService( Config.apiUrl, Config.apiKey, ); }Définir des gestionnaires de clics de bouton
async onRegisterButtonPress() { if (!this.state.registeredToken || !this.state.registeredOS) { Alert.alert("The push notifications token wasn't received."); return; } let status: string = "Registering..."; let isRegistered = this.state.isRegistered; try { this.setState({ isBusy: true, status }); const pnPlatform = this.state.registeredOS == "ios" ? "apns" : "fcm"; const pnToken = this.state.registeredToken; const request = { installationId: this.deviceId, platform: pnPlatform, pushChannel: pnToken, tags: [] }; const response = await this.notificationRegistrationService.registerAsync(request); status = `Registered for ${this.state.registeredOS} push notifications`; isRegistered = true; } catch (e) { status = `Registration failed: ${e}`; } finally { this.setState({ isBusy: false, status, isRegistered }); } } async onDeregisterButtonPress() { if (!this.notificationService) return; let status: string = "Deregistering..."; let isRegistered = this.state.isRegistered; try { this.setState({ isBusy: true, status }); await this.notificationRegistrationService.deregisterAsync(this.deviceId); status = "Deregistered from push notifications"; isRegistered = false; } catch (e) { status = `Deregistration failed: ${e}`; } finally { this.setState({ isBusy: false, status, isRegistered }); } }Gérer les inscriptions de jetons reçus et les notifications Push
onTokenReceived(token: any) { console.log(`Received a notification token on ${token.os}`); this.setState({ registeredToken: token.token, registeredOS: token.os, status: `The push notifications token has been received.` }); if (this.state.isRegistered && this.state.registeredToken && this.state.registeredOS) { this.onRegisterButtonPress(); } } onNotificationReceived(notification: any) { console.log(`Received a push notification on ${this.state.registeredOS}`); this.setState({ status: `Received a push notification...` }); if (notification.data.message) { Alert.alert(AppConfig.appName, `${notification.data.action} action received`); } } };
Configurer le projet Android natif pour les notifications Push
Configurer les packages Android requis
Le package est automatiquement lié lors de la génération de l’application. Vous avez quelques étapes supplémentaires ci-dessous pour terminer le processus de configuration.
Configurer le manifeste Android
Dans votre « android/app/src/main/AndroidManifest.xml », vérifiez le nom du package, les autorisations et les services requis. Assurez-vous que vous avez inscrit RNPushNotificationPublisher et RNPushNotificationBootEventReceiver que vous recevez, et que vous avez inscrit le RNPushNotificationListenerService service. Les métadonnées des notifications peuvent être utilisées pour personnaliser l’apparence de vos notifications Push.
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="YOUR_PACKAGE_NAME">
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WAKE_LOCK" />
<uses-permission android:name="android.permission.VIBRATE" />
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
<application
android:name=".MainApplication"
android:label="@string/app_name"
android:usesCleartextTraffic="true"
android:icon="@mipmap/ic_launcher"
android:roundIcon="@mipmap/ic_launcher_round"
android:allowBackup="false"
android:theme="@style/AppTheme">
<meta-data android:name="com.dieam.reactnativepushnotification.notification_channel_name"
android:value="PushDemo Channel"/>
<meta-data android:name="com.dieam.reactnativepushnotification.notification_channel_description"
android:value="PushDemo Channel Description"/>
<meta-data android:name="com.dieam.reactnativepushnotification.notification_foreground"
android:value="true"/>
<meta-data android:name="com.dieam.reactnativepushnotification.notification_color"
android:resource="@android:color/white"/>
<receiver android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationPublisher" />
<receiver android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationBootEventReceiver">
<intent-filter>
<action android:name="android.intent.action.BOOT_COMPLETED" />
</intent-filter>
</receiver>
<service
android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationListenerService"
android:exported="false" >
<intent-filter>
<action android:name="com.google.firebase.MESSAGING_EVENT" />
</intent-filter>
</service>
<activity
android:name=".MainActivity"
android:label="@string/app_name"
android:configChanges="keyboard|keyboardHidden|orientation|screenSize|uiMode"
android:launchMode="singleTask"
android:windowSoftInputMode="adjustResize">
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity>
<activity android:name="com.facebook.react.devsupport.DevSettingsActivity" />
</application>
</manifest>
Configurer les services Google
Dans « android/app/build.gradle », inscrivez Google Services :
dependencies {
...
implementation 'com.google.firebase:firebase-analytics:17.3.0'
...
}
apply plugin: 'com.google.gms.google-services'
Copiez le fichier « google-services.json » que vous avez téléchargé pendant l’installation de FCM dans le dossier de projet « android/app/ ».
Gérer les notifications Push pour Android
Vous avez configuré le service existant RNPushNotificationListenerService pour gérer les notifications Push Android entrantes. Ce service a été inscrit précédemment dans le manifeste de l’application. Il traite les notifications entrantes et les proxy vers la partie React Native multiplateforme. Aucune étape supplémentaire n’est requise.
Configurer le projet iOS natif pour les notifications Push
Configurer les packages iOS requis
Le package est automatiquement lié lors de la génération de l’application. Il vous suffit d’installer les pods natifs :
npx pod-install
Configurer Info.plist et Entitlements.plist
Accédez à votre dossier « PushDemo/ios » et ouvrez l’espace de travail « PushDemo.xcworkspace », sélectionnez le projet supérieur « PushDemo », puis sélectionnez l’onglet « Signature & fonctionnalités ».
Mettez à jour l’identificateur de bundle pour qu’il corresponde à la valeur utilisée dans le profil d’approvisionnement.
Ajoutez deux nouvelles fonctionnalités à l’aide du bouton - « + » :
- Fonctionnalité mode en arrière-plan et cochez Notifications à distance.
- Fonctionnalité Notifications Push
Gérer les notifications Push pour iOS
Ouvrez « AppDelegate.h » et ajoutez l’importation suivante :
#import <UserNotifications/UNUserNotificationCenter.h>Mettre à jour la liste des protocoles, pris en charge par « AppDelegate », en ajoutant
UNUserNotificationCenterDelegate:@interface AppDelegate : UIResponder <UIApplicationDelegate, RCTBridgeDelegate, UNUserNotificationCenterDelegate>Ouvrez « AppDelegate.m » et configurez tous les rappels iOS requis :
#import <UserNotifications/UserNotifications.h> #import <RNCPushNotificationIOS.h> ... // Required to register for notifications - (void)application:(UIApplication *)application didRegisterUserNotificationSettings:(UIUserNotificationSettings *)notificationSettings { [RNCPushNotificationIOS didRegisterUserNotificationSettings:notificationSettings]; } // Required for the register event. - (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken { [RNCPushNotificationIOS didRegisterForRemoteNotificationsWithDeviceToken:deviceToken]; } // Required for the notification event. You must call the completion handler after handling the remote notification. - (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler { [RNCPushNotificationIOS didReceiveRemoteNotification:userInfo fetchCompletionHandler:completionHandler]; } // Required for the registrationError event. - (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error { [RNCPushNotificationIOS didFailToRegisterForRemoteNotificationsWithError:error]; } // IOS 10+ Required for localNotification event - (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)(void))completionHandler { [RNCPushNotificationIOS didReceiveNotificationResponse:response]; completionHandler(); } // IOS 4-10 Required for the localNotification event. - (void)application:(UIApplication *)application didReceiveLocalNotification:(UILocalNotification *)notification { [RNCPushNotificationIOS didReceiveLocalNotification:notification]; } //Called when a notification is delivered to a foreground app. -(void)userNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions options))completionHandler { completionHandler(UNAuthorizationOptionSound | UNAuthorizationOptionAlert | UNAuthorizationOptionBadge); }
Tester la solution
Vous pouvez maintenant tester l’envoi de notifications via le service back-end.
Envoyer une notification de test
Ouvrez un nouvel onglet dans Postman.
Définissez la demande sur POST, puis entrez l’adresse suivante :
https://<app_name>.azurewebsites.net/api/notifications/requestsSi vous avez choisi d’effectuer la section Authentifier les clients à l’aide d’une clé API , veillez à configurer les en-têtes de requête pour inclure votre valeur apikey .
Clé Valeur apikey <your_api_key> Choisissez l’option brute du Corps, puis choisissez JSON dans la liste des options de format, puis incluez du contenu JSON d’espace réservé :
{ "text": "Message from Postman!", "action": "action_a" }Sélectionnez le bouton Code , qui se trouve sous le bouton Enregistrer en haut à droite de la fenêtre. La demande doit ressembler à l’exemple suivant lorsqu’elle est affichée pour le code HTML (selon que vous avez inclus ou non un en-tête apikey ) :
POST /api/notifications/requests HTTP/1.1 Host: https://<app_name>.azurewebsites.net apikey: <your_api_key> Content-Type: application/json { "text": "Message from backend service", "action": "action_a" }Exécutez l’application PushDemo sur l’une ou les deux plateformes cibles (Android et iOS).
Notes
Si vous testez sur Android , assurez-vous que vous n’exécutez pas dans Déboguer, ou si l’application a été déployée en exécutant l’application, forcez la fermeture de l’application et redémarrez-la à partir du lanceur.
Dans l’application PushDemo , appuyez sur le bouton Inscrire .
De retour dans Postman, fermez la fenêtre Générer des extraits de code (si vous ne l’avez pas déjà fait), puis cliquez sur le bouton Envoyer .
Vérifiez que vous obtenez une réponse 200 OK dans Postman et que l’alerte s’affiche dans l’application montrant ActionA action reçue.
Fermez l’application PushDemo , puis cliquez à nouveau sur le bouton Envoyer dans Postman.
Vérifiez que vous obtenez à nouveau une réponse 200 OK dans Postman . Vérifiez qu’une notification s’affiche dans la zone de notification de l’application PushDemo avec le message correct.
Appuyez sur la notification pour confirmer qu’elle ouvre l’application et affiche l’alerte ActionA reçue .
De retour dans Postman, modifiez le corps de la demande précédente pour envoyer une notification silencieuse spécifiant action_b au lieu de action_a pour la valeur d’action .
{ "action": "action_b", "silent": true }L’application étant toujours ouverte, cliquez sur le bouton Envoyer dans Postman.
Vérifiez que vous obtenez une réponse 200 OK dans Postman et que l’alerte s’affiche dans l’application montrant l’action ActionB reçue au lieu de l’action ActionA reçue.
Fermez l’application PushDemo , puis cliquez à nouveau sur le bouton Envoyer dans Postman.
Vérifiez que vous obtenez une réponse 200 OK dans Postman et que la notification silencieuse n’apparaît pas dans la zone de notification.
Dépannage
Aucune réponse du service back-end
Lorsque vous testez localement, vérifiez que le service principal est en cours d’exécution et utilise le port approprié.
Si vous effectuez un test sur l’application API Azure, case activée le service est en cours d’exécution et a été déployé et a démarré sans erreur.
Veillez à case activée vous avez correctement spécifié l’adresse de base dans Postman ou dans la configuration de l’application mobile lors du test via le client. L’adresse de base doit être https://<api_name>.azurewebsites.net/https://localhost:5001/ ou à titre indicatif lors d’un test local.
Ne pas recevoir de notifications sur Android après le démarrage ou l’arrêt d’une session de débogage
Veillez à vous inscrire à nouveau après le démarrage ou l’arrêt d’une session de débogage. Le débogueur entraîne la génération d’un nouveau jeton Firebase . L’installation du hub de notification doit également être mise à jour.
Réception d’un code 401 status du service back-end
Vérifiez que vous définissez l’en-tête de requête apikey et que cette valeur correspond à celle que vous avez configurée pour le service back-end.
Si vous recevez cette erreur lors du test localement, vérifiez que la valeur de clé que vous avez définie dans la configuration du client correspond à la valeur du paramètre utilisateur Authentication :ApiKey utilisée par l’API.
Si vous testez avec une application API, vérifiez que la valeur de clé dans le fichier de configuration client correspond au paramètre d’application Authentication :ApiKey que vous utilisez dans l’application API.
Notes
Si vous avez créé ou modifié ce paramètre après avoir déployé le service back-end, vous devez redémarrer le service pour qu’il prenne effet.
Si vous avez choisi de ne pas terminer la section Authentifier les clients à l’aide d’une clé API , vérifiez que vous n’avez pas appliqué l’attribut Authorize à la classe NotificationsController .
Réception d’un code 404 status du service principal
Vérifiez que le point de terminaison et la méthode de requête HTTP sont corrects. Par exemple, les points de terminaison doivent être indicatifs :
- [PUT]
https://<api_name>.azurewebsites.net/api/notifications/installations - [DELETE]
https://<api_name>.azurewebsites.net/api/notifications/installations/<installation_id> - [POST]
https://<api_name>.azurewebsites.net/api/notifications/requests
Ou lors d’un test local :
- [PUT]
https://localhost:5001/api/notifications/installations - [DELETE]
https://localhost:5001/api/notifications/installations/<installation_id> - [POST]
https://localhost:5001/api/notifications/requests
Lorsque vous spécifiez l’adresse de base dans l’application cliente, vérifiez qu’elle se termine par un /. L’adresse de base doit être https://<api_name>.azurewebsites.net/https://localhost:5001/ ou à titre indicatif lors d’un test local.
Impossible de s’inscrire et un message d’erreur du hub de notification s’affiche
Vérifiez que l’appareil de test dispose d’une connectivité réseau. Ensuite, déterminez la réponse Http status code en définissant un point d’arrêt pour inspecter la valeur de la propriété StatusCode dans httpResponse.
Passez en revue les suggestions de résolution des problèmes précédentes, le cas échéant, en fonction du code status.
Définissez un point d’arrêt sur les lignes qui retournent ces codes status spécifiques pour l’API correspondante. Essayez ensuite d’appeler le service principal lors du débogage local.
Vérifiez que le service back-end fonctionne comme prévu via Postman à l’aide de la charge utile appropriée. Utilisez la charge utile réelle créée par le code client pour la plateforme en question.
Passez en revue les sections de configuration spécifiques à la plateforme pour vous assurer qu’aucune étape n’a été manquée. Vérifiez que les valeurs appropriées sont résolues pour installation id et token les variables pour la plateforme appropriée.
Impossible de résoudre un ID pour que le message d’erreur de l’appareil s’affiche
Passez en revue les sections de configuration spécifiques à la plateforme pour vous assurer qu’aucune étape n’a été manquée.
Liens connexes
- Vue d’ensemble d’Azure Notification Hubs
- Installation de Visual Studio pour Mac
- Installation de Visual Studio Code
- Configuration de l’environnement de développement React Native
- Kit de développement logiciel (SDK) Notification Hubs pour les opérations back-end
- Kit de développement logiciel (SDK) Notification Hubs sur GitHub
- S’inscrire auprès du back-end d’application
- Gestion des inscriptions
- Utilisation des balises
- Utilisation de modèles personnalisés
Étapes suivantes
Vous devez maintenant disposer d’une application React Native de base connectée à un hub de notification via un service back-end et pouvoir envoyer et recevoir des notifications.
Vous devrez probablement adapter l’exemple utilisé dans ce didacticiel pour l’adapter à votre propre scénario. L’implémentation d’une gestion des erreurs, d’une logique de nouvelle tentative et d’une journalisation plus robustes est également recommandée.
Visual Studio App Center peut être rapidement incorporé dans des applications mobiles fournissant des analyses et des diagnostics pour faciliter la résolution des problèmes.