Tutorial: Envío de notificaciones push a aplicaciones React Native mediante Azure Notification Hubs a través de un servicio back-end

  • Artículo

Descargar ejemplo Descarga del ejemplo

En este tutorial, usará Azure Notification Hubs para enviar notificaciones push a una aplicación de React Native destinada a Android e iOS.

Se usa un back-end de API web de ASP.NET Core para controlar el registro de dispositivos para el cliente mediante el enfoque de instalación más reciente y mejor. El servicio también enviará notificaciones push de forma multiplataforma.

Estas operaciones se controlan mediante el SDK de Notification Hubs para las operaciones de back-end. Se proporciona más información sobre el enfoque general en la documentación registro desde el back-end de la aplicación .

Este tutorial le guía por los pasos siguientes:

Prerrequisitos

Para continuar, necesita lo siguiente:

  • Una suscripción de Azure donde puede crear y administrar recursos.
  • Un equipo Mac con Visual Studio para Mac instalado (o un equipo que ejecute Visual Studio 2019 con la carga de trabajo Desarrollo móvil con .NET).
  • La capacidad de ejecutar la aplicación en Android (dispositivos físicos o emuladores) o en iOS (solo dispositivos físicos).

Para Android, debe tener:

  • Un dispositivo físico desbloqueado por el desarrollador o un emulador (que ejecuta la API 26 y versiones posteriores con Google Play Services instalado).

Para iOS, debe tener:

Nota:

El simulador de iOS no admite notificaciones remotas, por lo que se requiere un dispositivo físico al explorar este ejemplo en iOS. Sin embargo, no es necesario ejecutar la aplicación tanto en Android como en iOS para completar este tutorial.

Puede seguir los pasos descritos en este ejemplo de primeros principios sin experiencia previa. Sin embargo, se beneficiará de estar familiarizado con los siguientes aspectos.

Los pasos proporcionados son para Visual Studio para Mac y Visual Studio Code, pero es posible seguirlos con Visual Studio 2019.

Configuración de Servicios de notificaciones push y Centro de notificaciones de Azure

En esta sección, configurará Firebase Cloud Messaging (FCM) y Apple Push Notification Services (APNS). Después, cree y configure un centro de notificaciones para que funcione con esos servicios.

Creación de un proyecto de Firebase y habilitación de Firebase Cloud Messaging para Android

  1. Inicie sesión en la consola de Firebase. Cree un nuevo proyecto de Firebase que escriba PushDemo como nombre del proyecto.

    Nota:

    Se generará un nombre único automáticamente. De forma predeterminada, se compone de una variante en minúsculas del nombre que proporcionó más un número generado separado por un guión. Puede cambiar esto si desea que siga siendo único globalmente.

  2. Después de crear el proyecto, seleccione Agregar Firebase a la aplicación Android.

    Adición de Firebase a la aplicación Android

  3. En la página Add Firebase to your Android app (Agregar Firebase a la aplicación android ), siga estos pasos.

    1. Para el nombre del paquete de Android, escriba un nombre para el paquete. Por ejemplo: com.<organization_identifier>.<package_name>.

      Especificar el nombre del paquete

    2. Seleccione Registrar aplicación.

    3. Seleccione Descargar google-services.json. A continuación, guarde el archivo en una carpeta local para usarlo más adelante y seleccione Siguiente.

      Descargar google-services.json

    4. Seleccione Siguiente.

    5. Seleccione Continue to console (Continuar hasta la consola).

      Nota:

      Si el botón Continuar a la consola no está habilitado, debido a la comprobación de instalación de comprobación , elija Omitir este paso.

  4. En la consola de Firebase, seleccione el engranaje del proyecto. A continuación, seleccione Configuración del proyecto.

    Seleccione Configuración del proyecto.

    Nota:

    Si no ha descargado el archivo google-services.json , puede descargarlo en esta página.

  5. Cambie a la pestaña Cloud Messaging (Mensajería en la nube) en la parte superior. Copie y guarde la clave del servidor para su uso posterior. Este valor se usa para configurar el centro de notificaciones.

    Copia de la clave del servidor

Registro de la aplicación iOS para notificaciones push

Para enviar notificaciones push a una aplicación iOS, registre la aplicación con Apple y también regístrese para las notificaciones push.

  1. Si aún no ha registrado la aplicación, vaya al portal de aprovisionamiento de iOS en el Centro para desarrolladores de Apple. Inicie sesión en el portal con el identificador de Apple, vaya a Certificados, Identificadores & Perfiles y seleccione Identificadores. Haga clic + para registrar una nueva aplicación.

    Página De identificadores de aplicación del portal de aprovisionamiento de iOS

  2. En la pantalla Registrar un nuevo identificador , seleccione el botón de radio Id. de aplicación . A continuación, seleccione Continuar.

    Página registrar un nuevo identificador en el portal de aprovisionamiento de iOS

  3. Actualice los tres valores siguientes para la nueva aplicación y, a continuación, seleccione Continuar:

    • Descripción: escriba un nombre descriptivo para la aplicación.

    • Id. de lote: escriba un identificador de lote con el formato com.organization_identifier<>.<>product_name como se mencionó en la Guía de distribución de aplicaciones. En la captura de pantalla siguiente, el mobcat valor se usa como identificador de organización y el valor PushDemo se usa como nombre del producto.

      Página registro del identificador de aplicación del portal de aprovisionamiento de iOS

    • Notificaciones push: active la opción Notificaciones push en la sección Funcionalidades .

      Formulario para registrar un nuevo identificador de aplicación

      Esta acción genera el identificador de la aplicación y solicita que confirme la información. Seleccione Continuar y, a continuación, seleccione Registrar para confirmar el nuevo identificador de aplicación.

      Confirmación del nuevo identificador de aplicación

      Después de seleccionar Registrar, verá el nuevo identificador de aplicación como un elemento de línea en la página Certificados, Identificadores & Perfiles .

  4. En la página Certificados, Identificadores & perfiles , en Identificadores, busque el elemento de línea Id. de aplicación que creó. A continuación, seleccione su fila para mostrar la pantalla Editar la configuración del id. de aplicación .

Creación de un certificado para Notification Hubs

Se requiere un certificado para permitir que el centro de notificaciones funcione con Apple Push Notification Services (APNS) y se puede proporcionar de una de estas dos maneras:

  1. Creación de un certificado push p12 que se puede cargar directamente en el Centro de notificaciones (el enfoque original)

  2. Creación de un certificado p8 que se puede usar para la autenticación basada en tokens (el enfoque más reciente y recomendado)

El enfoque más reciente tiene una serie de ventajas, tal como se documenta en autenticación basada en tokens (HTTP/2) para APNS. Se requieren menos pasos, pero también se exige para escenarios específicos. Sin embargo, se han proporcionado pasos para ambos enfoques, ya que cualquiera funcionará con los fines de este tutorial.

OPCIÓN 1: Creación de un certificado push p12 que se puede cargar directamente en el Centro de notificaciones

  1. En el equipo Mac, ejecute la herramienta Acceso a llaves. Se puede abrir desde la carpeta Utilidades o la carpeta Other del Launchpad.

  2. Seleccione Acceso a cadena de claves, expanda Asistente para certificados y, a continuación, seleccione Solicitar un certificado desde una entidad de certificación.

    Uso del acceso a llaves para solicitar un nuevo certificado

    Nota:

    De forma predeterminada, Keychain Access selecciona el primer elemento de la lista. Esto puede ser un problema si está en la categoría Certificados y apple Worldwide Developer Relations Certification Authority no es el primer elemento de la lista. Asegúrese de que tiene un elemento que no es clave o de que está seleccionada la clave de entidad de certificación de relaciones para desarrolladores mundiales de Apple antes de generar la CSR (solicitud de firma de certificado).

  3. Seleccione el usuario Email Dirección, escriba el valor de Nombre común, asegúrese de especificar Guardado en disco y, a continuación, seleccione Continuar. Deje ca Email Dirección en blanco, ya que no es necesario.

    Información esperada del certificado

  4. Escriba un nombre para el archivo solicitud de firma de certificado (CSR) en Guardar como, seleccione la ubicación en Where (Dónde) y, a continuación, seleccione Guardar.

    Elegir un nombre de archivo para el certificado

    Esta acción guarda el archivo CSR en la ubicación seleccionada. La ubicación predeterminada es Escritorio. Recuerde la ubicación elegida para el archivo.

  5. De nuevo en la página Certificados, identificadores & perfiles del portal de aprovisionamiento de iOS, desplácese hacia abajo hasta la opción Notificaciones push activadas y, a continuación, seleccione Configurar para crear el certificado.

    Página Editar id. de aplicación

  6. Aparece la ventana Certificados TLS/SSL del servicio de notificaciones push de Apple . Seleccione el botón Create Certificate (Crear certificado ) en la sección Development TLS/SSL Certificate (Certificado TLS/SSL de desarrollo ).

    Botón Crear certificado para el identificador de aplicación

    Se muestra la pantalla Crear un nuevo certificado .

    Nota:

    En este tutorial se usa un certificado de desarrollo. El mismo proceso se usa al registrar un certificado de producción. Asegúrese de usar el mismo tipo de certificado al enviar notificaciones.

  7. Seleccione Elegir archivo, vaya a la ubicación donde guardó el archivo CSR y, a continuación, haga doble clic en el nombre del certificado para cargarlo. A continuación, seleccione Continuar.

  8. Una vez que el portal cree el certificado, seleccione el botón Descargar . Guarde el certificado y recuerde la ubicación en la que se guarda.

    Página de descarga de certificados generada

    El certificado se descarga y guarda en el equipo en la carpeta Descargas .

    Busque el archivo de certificado en la carpeta Descargas.

    Nota:

    De forma predeterminada, el certificado de desarrollo descargado se denomina aps_development.cer.

  9. Haga doble clic en el certificado push descargado aps_development.cer. Esta acción instala el nuevo certificado en la cadena de claves, como se muestra en la siguiente imagen:

    Lista de certificados de acceso de cadena de claves que muestra el nuevo certificado

    Nota:

    Aunque el nombre del certificado puede ser diferente, el nombre tendrá el prefijo Apple Development iOS Push Services y tendrá el identificador de lote adecuado asociado.

  10. En Acceso a llaves, control + Haga clic en el nuevo certificado de inserción que creó en la categoría Certificados . Seleccione Exportar, asigne un nombre al archivo, seleccione el formato p12 y, a continuación, seleccione Guardar.

    Exportación del certificado como formato p12

    Puede optar por proteger el certificado con una contraseña, pero una contraseña es opcional. Haga clic en Aceptar si desea omitir la creación de contraseñas. Anote el nombre de archivo y la ubicación del certificado p12 exportado. Se usan para habilitar la autenticación con APN.

    Nota:

    El nombre y la ubicación del archivo p12 pueden ser diferentes de los que se muestran en este tutorial.

OPCIÓN 2: Creación de un certificado p8 que se puede usar para la autenticación basada en tokens

  1. Anote los detalles siguientes:

    • Prefijo de id. de aplicación (id. de equipo)
    • Id. de lote

  2. De nuevo en Certificados, Identificadores & Perfiles, haga clic en Claves.

    Nota:

    Si ya tiene una clave configurada para APNS, puede volver a usar el certificado p8 que descargó justo después de crearlo. Si es así, puede omitir los pasos del 3 al 5.

  3. Haga clic en el + botón (o en el botón Crear una tecla ) para crear una nueva clave.

  4. Proporcione un valor de Nombre de clave adecuado, active la opción Apple Push Notifications service (APNS) y, a continuación, haga clic en Continuar, seguido de Registrar en la pantalla siguiente.

  5. Haga clic en Descargar y, a continuación, mueva el archivo p8 (con el prefijo AuthKey_) a un directorio local seguro y, a continuación, haga clic en Listo.

    Nota:

    Asegúrese de mantener el archivo p8 en un lugar seguro (y guarde una copia de seguridad). Después de descargar la clave, no se puede volver a descargar a medida que se quita la copia del servidor.

  6. En Claves, haga clic en la clave que ha creado (o una clave existente si ha elegido usarla en su lugar).

  7. Anote el valor de Id. de clave .

  8. Abra el certificado p8 en una aplicación adecuada de su elección, como Visual Studio Code. Anote el valor de clave (entre -----BEGIN PRIVATE KEY----- y -----END PRIVATE KEY-----).

    -----BEGIN PRIVATE KEY-----
    <key_value>
    -----END PRIVATE KEY-----

    Nota:

    Este es el valor del token que se usará más adelante para configurar el Centro de notificaciones.

Al final de estos pasos, debe tener la siguiente información para usarla más adelante en Configuración del centro de notificaciones con información de APNS:

  • Id. de equipo (consulte el paso 1)
  • Id. de agrupación (consulte el paso 1)
  • Id. de clave (consulte el paso 7)
  • Valor del token (valor de clave p8 obtenido en el paso 8)

Creación de un perfil de aprovisionamiento para la aplicación

  1. Vuelva al portal de aprovisionamiento de iOS, seleccione Certificados, Identificadores & Perfiles, seleccione Perfiles en el menú de la izquierda y, a continuación, seleccione + para crear un nuevo perfil. Aparece la pantalla Registrar un nuevo perfil de aprovisionamiento .

  2. Seleccione Desarrollo de aplicaciones de iOS en Desarrollo como tipo de perfil de aprovisionamiento y, a continuación, seleccione Continuar.

    Lista de perfiles de aprovisionamiento

  3. A continuación, seleccione el identificador de aplicación que creó en la lista desplegable Id . de aplicación y seleccione Continuar.

    Seleccione el identificador de la aplicación.

  4. En la ventana Seleccionar certificados , seleccione el certificado de desarrollo que usa para la firma de código y seleccione Continuar.

    Nota:

    Este certificado no es el certificado de inserción que creó en el paso anterior. Este es el certificado de desarrollo. Si no existe, debe crearlo, ya que se trata de un requisito previo para este tutorial. Los certificados de desarrollador se pueden crear en el Portal para desarrolladores de Apple, a través de Xcode o en Visual Studio.

  5. Vuelva a la página Certificados, Identificadores & Perfiles , seleccione Perfiles en el menú de la izquierda y, a continuación, seleccione + para crear un nuevo perfil. Aparece la pantalla Registrar un nuevo perfil de aprovisionamiento .

  6. En la ventana Seleccionar certificados , seleccione el certificado de desarrollo que ha creado. A continuación, seleccione Continuar.

  7. A continuación, seleccione los dispositivos que se van a usar para las pruebas y seleccione Continuar.

  8. Por último, elija un nombre para el perfil en Nombre del perfil de aprovisionamiento y seleccione Generar.

    Elección de un nombre de perfil de aprovisionamiento

  9. Cuando se cree el nuevo perfil de aprovisionamiento, seleccione Descargar. Recuerde la ubicación a la que se guarda.

  10. Vaya a la ubicación del perfil de aprovisionamiento y, a continuación, haga doble clic en él para instalarlo en el equipo de desarrollo.

Creación de un centro de notificaciones

En esta sección, creará un centro de notificaciones y configurará la autenticación con APNS. Puede usar un certificado push p12 o una autenticación basada en tokens. Si desea usar un centro de notificaciones que ya ha creado, puede ir directamente al paso 5.

  1. Inicie sesión en Azure.

  2. Haga clic en Crear un recurso, busque y elija Centro de notificaciones y, a continuación, haga clic en Crear.

  3. Actualice los campos siguientes y, a continuación, haga clic en Crear:

    DETALLES BÁSICOS

    Suscripción: Elija la suscripción de destino en la lista desplegable.
    Grupo de recursos: Crear un nuevo grupo de recursos (o elegir uno existente)

    DETALLES DEL ESPACIO DE NOMBRES

    Espacio de nombres del centro de notificaciones: Escriba un nombre único global para el espacio de nombres del Centro de notificaciones .

    Nota:

    Asegúrese de que la opción Crear nuevo está seleccionada para este campo.

    DETALLES DEL CENTRO DE NOTIFICACIONES

    Centro de notificaciones: Escriba un nombre para el Centro de notificaciones.
    Ubicación: Elegir una ubicación adecuada en la lista desplegable
    Plan de tarifa: Mantener la opción Gratis predeterminada

    Nota:

    A menos que haya alcanzado el número máximo de concentradores en el nivel gratis.

  4. Una vez que se ha aprovisionado el Centro de notificaciones, vaya a ese recurso.

  5. Vaya al nuevo Centro de notificaciones.

  6. Seleccione Directivas de acceso en la lista (en ADMINISTRAR).

  7. Anote los valores de Nombre de directiva junto con sus valores de cadena de conexión correspondientes.

Configuración del Centro de notificaciones con información de APNS

En Notification Services, seleccione Apple y siga los pasos adecuados según el enfoque que eligió anteriormente en la sección Creación de un certificado para Notification Hubs .

Nota:

Usa el modo de producción para aplicaciones solo si quieres enviar notificaciones push a los usuarios que compraron la aplicación desde la tienda.

OPCIÓN 1: Uso de un certificado de inserción .p12

  1. Seleccione Certificado.

  2. Seleccione el icono de archivo.

  3. Seleccione el archivo .p12 que exportó anteriormente y, a continuación, seleccione Abrir.

  4. Si es necesario, especifique la contraseña correcta.

  5. Seleccione Modo de espacio aislado .

  6. Seleccione Guardar.

OPCIÓN 2: Uso de la autenticación basada en tokens

  1. Seleccione Token.

  2. Escriba los valores siguientes que adquirió anteriormente:

    • Id. de clave
    • Identificador de lote
    • Id. de equipo
    • Token

  3. Elija Espacio aislado.

  4. Seleccione Guardar.

Configuración del centro de notificaciones con información de FCM

  1. Seleccione Google (GCM/FCM) en la sección Configuración del menú izquierdo.
  2. Escriba la clave de servidor que anotó en google Firebase Console.
  3. Seleccione Guardar en la barra de herramientas.

Creación de una aplicación back-end de api web de ASP.NET Core

En esta sección, creará el back-end de ASP.NET Core API web para controlar el registro de dispositivos y el envío de notificaciones a la aplicación móvil React Native.

Creación de un proyecto web

  1. En Visual Studio, seleccione Archivo>nueva solución.

  2. SeleccioneAplicación>.NET Core>ASP.NET Core>API>Siguiente.

  3. En el cuadro de diálogo Configurar la nueva API web de ASP.NET Core, seleccione Plataforma de destino de .NET Core 3.1.

  4. Escriba PushDemoApi como Nombre del proyecto y, a continuación, seleccione Crear.

  5. Inicie la depuración (Comando + Entrar) para probar la aplicación con plantilla.

    Nota:

    La aplicación con plantilla está configurada para usar WeatherForecastController como launchUrl. Esto se establece en Propiedades>launchSettings.json.

    Si se le pide un mensaje de confirmación de desarrollo no válido :

    1. Haga clic en Sí para aceptar ejecutar la herramienta "dotnet dev-certs https" para corregirlo. La herramienta "dotnet dev-certs https" le pedirá que escriba una contraseña para el certificado y la contraseña de la cadena de claves.

    2. Haga clic en Sí cuando se le pida que instale y confíe en el nuevo certificado y, a continuación, escriba la contraseña de la cadena de claves.

  6. Expanda la carpeta Controllers y, a continuación, elimine WeatherForecastController.cs.

  7. Elimine WeatherForecast.cs.

  8. Configure valores de configuración local mediante la herramienta Administrador de secretos. La desacoplación de los secretos de la solución garantiza que no terminan en el control de código fuente. Abra Terminal y, a continuación, vaya al directorio del archivo del proyecto y ejecute los siguientes comandos:

    dotnet user-secrets init
dotnet user-secrets set "NotificationHub:Name" <value>
dotnet user-secrets set "NotificationHub:ConnectionString" <value>

    Reemplace los valores de marcador de posición por su propio nombre del centro de notificaciones y cadena de conexión valores. Ha tomado nota de ellos en la sección Creación de un centro de notificaciones . De lo contrario, puede buscarlos en Azure.

    NotificationHub:Name:
    Consulte Nombre en el resumen de Essentials en la parte superior de Información general.

    NotificationHub:ConnectionString:
    Consulte DefaultFullSharedAccessSignature en Directivas de acceso.

    Nota:

    En escenarios de producción, puede ver opciones como Azure KeyVault para almacenar de forma segura el cadena de conexión. Por motivos de simplicidad, los secretos se agregarán a la configuración de la aplicación Azure App Service.

Autenticación de clientes mediante una clave de API (opcional)

Las claves de API no son tan seguras como tokens, pero bastarán con los fines de este tutorial. Una clave de API se puede configurar fácilmente a través del middleware de ASP.NET.

  1. Agregue la clave de API a los valores de configuración local.

    dotnet user-secrets set "Authentication:ApiKey" <value>

    Nota:

    Debe reemplazar el valor del marcador de posición por el suyo propio y anotarlo.

  2. Control + Haga clic en el proyecto PushDemoApi , elija Nueva carpeta en el menú Agregar y, a continuación, haga clic en Agregar con autenticación como nombre de carpeta.

  3. Control + Haga clic en la carpeta Autenticación y, a continuación, elija Nuevo archivo... en el menú Agregar .

  4. SeleccioneClase vacíageneral>, escriba ApiKeyAuthOptions.cs en Nombre y, a continuación, haga clic en Nuevo agregando la siguiente implementación.

    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; }
    }
}

  5. Agregue otra clase vacía a la carpeta Authentication denominada ApiKeyAuthHandler.cs y agregue la siguiente implementación.

    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));
        }
    }
}

    Nota:

    Un controlador de autenticación es un tipo que implementa el comportamiento de un esquema, en este caso un esquema de clave de API personalizado.

  6. Agregue otra clase vacía a la carpeta Authentication denominada ApiKeyAuthenticationBuilderExtensions.cs y agregue la siguiente implementación.

    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);
        }
    }
}

    Nota:

    Este método de extensión simplifica el código de configuración de middleware en Startup.cs lo que hace que sea más legible y generalmente más fácil de seguir.

  7. En Startup.cs, actualice el método ConfigureServices para configurar la autenticación de clave de API debajo de la llamada a los servicios. Método 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);
}

  8. Aún en Startup.cs, actualice el método Configure para llamar a los métodos de extensión UseAuthentication y UseAuthorization en IApplicationBuilder de la aplicación. Asegúrese de que se llama a esos métodos después de UseRouting y antes de la aplicación. UseEndpoints.

    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();
    });
}

    Nota:

    Al llamar a UseAuthentication , se registra el middleware que usa los esquemas de autenticación registrados anteriormente (de ConfigureServices). Se debe llamar a esto antes de cualquier middleware que dependa de los usuarios que se autentiquen.

Adición de dependencias y configuración de servicios

ASP.NET Core admite el patrón de diseño de software de inserción de dependencias (DI), que es una técnica para lograr la inversión de control (IoC) entre las clases y sus dependencias.

El uso del centro de notificaciones y el SDK de Notification Hubs para las operaciones de back-end se encapsula dentro de un servicio. El servicio se registra y se pone a disposición a través de una abstracción adecuada.

  1. Control + Haga clic en la carpeta Dependencias y, a continuación, elija Administrar paquetes NuGet... .

  2. Busque Microsoft.Azure.NotificationHubs y asegúrese de que está activado.

  3. Haga clic en Agregar paquetes y, a continuación, haga clic en Aceptar cuando se le pida que acepte los términos de licencia.

  4. Control + Haga clic en el proyecto PushDemoApi , elija Nueva carpeta en el menú Agregar y, a continuación, haga clic en Agregar con modelos como nombre de carpeta.

  5. Control + Haga clic en la carpeta Modelos y, a continuación, elija Nuevo archivo... en el menú Agregar .

  6. SeleccioneClase vacíageneral>, escriba PushTemplates.cs en Nombre y, a continuación, haga clic en Nuevo agregando la siguiente implementación.

    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)\" }";
        }
    }
}

    Nota:

    Esta clase contiene las cargas de notificación tokenizadas para las notificaciones genéricas y silenciosas requeridas por este escenario. Las cargas se definen fuera de la instalación para permitir la experimentación sin tener que actualizar las instalaciones existentes a través del servicio. El control de los cambios en las instalaciones de esta manera está fuera del ámbito de este tutorial. Para producción, considere la posibilidad de usar plantillas personalizadas.

  7. Agregue otra clase vacía a la carpeta Models denominada DeviceInstallation.cs y agregue la siguiente implementación.

    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>();
    }
}

  8. Agregue otra clase vacía a la carpeta Models denominada NotificationRequest.cs y agregue la siguiente implementación.

    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; }
    }
}

  9. Agregue otra clase vacía a la carpeta Models denominada NotificationHubOptions.cs y agregue la siguiente implementación.

    using System.ComponentModel.DataAnnotations;

namespace PushDemoApi.Models
{
    public class NotificationHubOptions
    {
        [Required]
        public string Name { get; set; }

        [Required]
        public string ConnectionString { get; set; }
    }
}

  10. Agregue una nueva carpeta al proyecto PushDemoApi denominado Services.

  11. Agregue una interfaz vacía a la carpeta Servicios denominada INotificationService.cs y agregue la siguiente implementación.

    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);
    }
}

  12. Agregue una clase vacía a la carpeta Servicios denominada NotificationHubsService.cs y agregue el código siguiente para implementar la interfaz 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);
        }
    }
}

    Nota:

    La expresión de etiqueta proporcionada a SendTemplateNotificationAsync está limitada a 20 etiquetas. Está limitado a 6 para la mayoría de los operadores, pero la expresión solo contiene solicitudes organizativas (||) en este caso. Si hay más de 20 etiquetas en la solicitud, deben dividirse en varias solicitudes. Consulte la documentación sobre expresiones de etiqueta y enrutamiento para obtener más detalles.

  13. En Startup.cs, actualice el método ConfigureServices para agregar NotificationHubsService como una implementación singleton de 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();
}

Creación de la API de notificaciones

  1. Control + Haga clic en la carpeta Controladores y, a continuación, elija Nuevo archivo... en el menú Agregar .

  2. Seleccione ASP.NET Core>Clase de controlador de APIweb, escriba NotificationsController como Nombre y, a continuación, haga clic en Nuevo.

    Nota:

    Si sigue con Visual Studio 2019, elija la plantilla Controlador de API con acciones de lectura y escritura .

  3. Agregue los siguientes espacios de nombres a la parte superior del archivo.

    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;

  4. Actualice el controlador con plantilla para que derive de ControllerBase y esté decorado con el atributo ApiController .

    [ApiController]
[Route("api/[controller]")]
public class NotificationsController : ControllerBase
{
    // Templated methods here
}

    Nota:

    La clase base Controller proporciona compatibilidad con las vistas, pero esto no es necesario en este caso, por lo que controllerBase se puede usar en su lugar. Si sigue con Visual Studio 2019, puede omitir este paso.

  5. Si eligió completar la sección Autenticar clientes mediante una clave de API , también debe decorar NotificationsController con el atributo Authorize .

    [Authorize]

  6. Actualice el constructor para aceptar la instancia registrada de INotificationService como argumento y asignarla a un miembro de solo lectura.

    readonly INotificationService _notificationService;

public NotificationsController(INotificationService notificationService)
{
    _notificationService = notificationService;
}

  7. En launchSettings.json (dentro de la carpeta Properties ), cambie launchUrl de weatherforecast a api/notifications para que coincida con la dirección URL especificada en el atributo RegistrationsControllerRoute .

  8. Inicie la depuración ( + Comando Entrar) para validar que la aplicación funciona con el nuevo NotificationsController y devuelve un estado 401 No autorizado .

    Nota:

    Es posible que Visual Studio no inicie automáticamente la aplicación en el explorador. Usará Postman para probar la API desde este momento.

  9. En una nueva pestaña de Postman , establezca la solicitud en GET. Escriba la dirección siguiente reemplazando el marcador de posición <applicationUrl por el valor de applicationUrl> https que se encuentra en Propiedades>launchSettings.json.

    <applicationUrl>/api/notifications

    Nota:

    ApplicationUrl debe ser "https://localhost:5001" para el perfil predeterminado. Si usa IIS (valor predeterminado en Visual Studio 2019 en Windows), debe usar applicationUrl especificado en el elemento iisSettings en su lugar. Recibirá una respuesta 404 si la dirección es incorrecta.

  10. Si eligió completar la sección Autenticar clientes mediante una clave de API , asegúrese de configurar los encabezados de solicitud para incluir el valor de apikey .

    Clave Valor
    apikey <your_api_key>

  11. Haga clic en el botón Enviar .

    Nota:

    Debe recibir un estado correcto de 200 con algún contenido JSON .

    Si recibe una advertencia de verificación de certificado SSL, puede cambiar la configuración de Postman de verificación de certificado SSL de solicitud en configuración.

  12. Reemplace los métodos de clase con plantilla en NotificationsController.cs por el código siguiente.

    [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();
}

Creación de la aplicación de API

Ahora creará una aplicación de API en Azure App Service para hospedar el servicio back-end.

  1. Inicie sesión en Azure Portal.

  2. Haga clic en Crear un recurso, busque y elija Aplicación de API y, a continuación, haga clic en Crear.

  3. Actualice los campos siguientes y, a continuación, haga clic en Crear.

    Nombre de la aplicación:
    Escriba un nombre único global para la aplicación de API.

    Suscripción:
    Elija la misma suscripción de destino en la que creó el centro de notificaciones.

    Grupo de recursos:
    Elija el mismo grupo de recursos en el que creó el centro de notificaciones.

    App Service Plan/Ubicación:
    Crear un nuevo plan de App Service

    Nota:

    Cambie de la opción predeterminada a un plan que incluya compatibilidad con SSL . De lo contrario, deberá realizar los pasos adecuados al trabajar con la aplicación móvil para evitar que las solicitudes HTTP se bloqueen.

    Application Insights:
    Mantenga la opción sugerida (se creará un nuevo recurso con ese nombre) o elija un recurso existente.

  4. Una vez aprovisionada la aplicación de API , vaya a ese recurso.

  5. Anote la propiedad URL en el resumen de Essentials en la parte superior de La información general. Esta dirección URL es el punto de conexión de back-end que se usará más adelante en este tutorial.

    Nota:

    La dirección URL usa el nombre de la aplicación de API que especificó anteriormente, con el formato https://<app_name>.azurewebsites.net.

  6. Seleccione Configuración en la lista (en Configuración).

  7. Para cada una de las opciones siguientes, haga clic en Nueva configuración de la aplicación para escribir el nombre y un valor y, a continuación, haga clic en Aceptar.

    Nombre Valor
    Authentication:ApiKey <api_key_value>
    NotificationHub:Name <hub_name_value>
    NotificationHub:ConnectionString <hub_connection_string_value>

    Nota:

    Se trata de la misma configuración que definió anteriormente en la configuración de usuario. Debería poder copiarlos. La configuración Authentication:ApiKey solo es necesaria si decide completar la sección Autenticación de clientes mediante una clave de API . En escenarios de producción, puede ver opciones como Azure KeyVault. Estos se han agregado como configuración de la aplicación para simplificar en este caso.

  8. Una vez agregada toda la configuración de la aplicación, haga clic en Guardar y, a continuación, en Continuar.

Publicación del servicio back-end

A continuación, implementará la aplicación en la aplicación de API para que sea accesible desde todos los dispositivos.

Nota:

Los pasos siguientes son específicos de Visual Studio para Mac. Si sigue con Visual Studio 2019 en Windows, el flujo de publicación será diferente. Consulte Publicar en Azure App Service en Windows.

  1. Cambie la configuración de Depuración a Versión si aún no lo ha hecho.

  2. Control + Haga clic en el proyecto PushDemoApi y, a continuación, elija Publicar en Azure... en el menú Publicar .

  3. Siga el flujo de autenticación si se le pide que lo haga. Use la cuenta que usó en la sección anterior creación de la aplicación de API .

  4. Seleccione la aplicación de API de Azure App Service que creó anteriormente en la lista como destino de publicación y, a continuación, haga clic en Publicar.

Una vez completado el asistente, publica la aplicación en Azure y, a continuación, abre la aplicación. Tome nota de la dirección URL si aún no lo ha hecho. Esta dirección URL es el punto de conexión de back-end que se usa más adelante en este tutorial.

Validación de la API publicada

  1. En Postman , abra una nueva pestaña, establezca la solicitud en PUT y escriba la dirección siguiente. Reemplace el marcador de posición por la dirección base que anotó en la sección anterior publicar el servicio back-end .

    https://<app_name>.azurewebsites.net/api/notifications/installations

    Nota:

    La dirección base debe tener el formato . https://<app_name>.azurewebsites.net/

  2. Si eligió completar la sección Autenticar clientes mediante una clave de API , asegúrese de configurar los encabezados de solicitud para incluir el valor de apikey .

    Clave Valor
    apikey <your_api_key>

  3. Elija la opción sin formato del cuerpo, elija JSON en la lista de opciones de formato y, a continuación, incluya algún contenido JSON de marcador de posición:

    {}

  4. Haga clic en Enviar.

    Nota:

    Debe recibir un estado 422 UnprocessableEntity del servicio.

  5. Vuelva a realizar los pasos del 1 al 4, pero esta vez especifique el punto de conexión de solicitudes para validar que recibe una respuesta de solicitud incorrecta 400 .

    https://<app_name>.azurewebsites.net/api/notifications/requests

Nota:

Todavía no es posible probar la API con datos de solicitud válidos, ya que esto requerirá información específica de la plataforma de la aplicación móvil cliente.

Creación de una aplicación de React Native multiplataforma

En esta sección, creará una aplicación móvil React Native que implementa notificaciones push de forma multiplataforma.

Permite registrar y anular el registro desde un centro de notificaciones a través del servicio back-end que ha creado.

Se muestra una alerta cuando se especifica una acción y la aplicación está en primer plano. De lo contrario, las notificaciones aparecen en el Centro de notificaciones.

Nota:

Normalmente, realizaría las acciones de registro (y desregistración) durante el punto adecuado del ciclo de vida de la aplicación (o como parte de la experiencia de primera ejecución quizás) sin entradas explícitas de registro o registro del usuario. Sin embargo, este ejemplo requerirá una entrada explícita del usuario para permitir que esta funcionalidad se explore y pruebe más fácilmente.

Creación de la solución React Native

  1. En Terminal, actualice las herramientas del entorno, necesarias para trabajar con React Native mediante los siguientes comandos:

    # 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 cocoapods

  2. En Terminal, ejecute el siguiente comando, si tiene React Native la CLI instalada para desinstalarla. Use npx para acceder automáticamente a la versión más reciente de la CLI de React Native disponible:

    npm uninstall -g react-native-cli

    Nota:

    React Native tiene una interfaz de línea de comandos integrada. En lugar de instalar y administrar una versión específica de la CLI globalmente, se recomienda acceder a la versión actual en tiempo de ejecución mediante npx, que se incluye con Node.js. Con npx react-native <command>, la versión estable actual de la CLI se descargará y ejecutará en el momento en que se ejecute el comando.

  3. Vaya a la carpeta de proyectos donde desea crear la nueva aplicación. Use la plantilla basada en Typescript especificando el --template parámetro :

    # init new project with npx
npx react-native init PushDemo --template react-native-template-typescript

  4. Ejecute el servidor metro, que compila agrupaciones de JavaScript y supervisa las actualizaciones de código para actualizar las agrupaciones en tiempo real:

    cd PushDemo
npx react-native start

  5. Ejecute la aplicación de iOS para comprobar la configuración. Asegúrese de iniciar un simulador de iOS o de conectar un dispositivo iOS antes de ejecutar el siguiente comando:

    npx react-native run-ios

  6. Ejecute la aplicación Android para comprobar la configuración. Requiere algunos pasos adicionales para configurar un emulador de Android o un dispositivo para poder acceder al servidor metro React Native. Los siguientes comandos generan la agrupación inicial de JavaScript para Android y la colocan en la carpeta 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:8081

    Este script se implementará previamente con la versión inicial de la aplicación. Una vez implementado, configure el emulador o el dispositivo para acceder al servidor metro especificando la dirección IP del servidor. Ejecute el siguiente comando para compilar y ejecutar la aplicación Android:

    npx react-native run-android

    Una vez en la aplicación, presione CMD+M (emulador) o agitar el dispositivo para rellenar la configuración del desarrollador, vaya aChange Bundle LocationSettings> y especifique la dirección IP del servidor metro con el puerto predeterminado: . <metro-server-ip-address>:8081

  7. En el App.tsx archivo, aplique cualquier cambio en el diseño de página, guárdelo y haga que el cambio se refleje automáticamente en aplicaciones iOS y Android.

    Nota:

    La guía de configuración detallada del entorno de desarrollo está disponible en la documentación oficial.

Instalación de paquetes necesarios

Necesita los tres paquetes siguientes para que este ejemplo funcione:

  1. React Native notificaciones push para el proyecto de iOS - de GitHub

    Este paquete se creó cuando PushNotificationIOS se dividió del núcleo de React Native. El paquete implementa de forma nativa notificaciones push para iOS y proporciona React Native interfaz para acceder a él. Ejecute el siguiente comando para instalar el paquete:

    yarn add @react-native-community/push-notification-ios

  2. Notificaciones push de React Native multiplataforma

    Este paquete implementa notificaciones locales y remotas en iOS y Android de forma multiplataforma. Ejecute el siguiente comando para instalar el paquete:

    yarn add react-native-push-notification

  3. Paquete de información de dispositivo El paquete proporciona información sobre un dispositivo en tiempo de ejecución. Úselo para definir un identificador de dispositivo, que se usa para registrarse para la notificación push. Ejecute el siguiente comando para instalar el paquete:

    yarn add react-native-device-info

Implementación de los componentes multiplataforma

  1. Cree e implemente 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;

  2. Cree e implemente 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();
  }
}

  3. Cree e implemente 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}`;
        }
    }
}

  4. Configure la aplicación. Abra package.json y agregue la siguiente definición de script:

    "configure": "cp .app.config.tsx src/config/AppConfig.tsx"

    A continuación, ejecute este script, que copiará la configuración predeterminada en la config carpeta.

    yarn configure

    El último paso consiste en actualizar el archivo de configuración copiado en el paso anterior con la información de acceso a la API. Especifique apiKey los parámetros y apiUrl :

    module.exports = {
    appName: "PushDemo",
    env: "production",
    apiUrl: "https://<azure-push-notifications-api-url>/api/",
    apiKey: "<api-auth-key>",
};

Implementación de la interfaz de usuario multiplataforma

  1. Definición del diseño de página

    <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>

  2. Aplicar estilos

    const styles = StyleSheet.create({
  container: {
    flex: 1,
    alignItems: "center",
    justifyContent: 'flex-end',
    margin: 50,
  },
  button: {
    margin: 5,
    width: "100%",
  }
});

  3. Inicialización del componente de página

      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,
    );
  }

  4. Definir controladores de clic de botón

      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 });
    }
  }

  5. Controlar los registros de tokens recibidos y las notificaciones 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`);
    }
  }
};

Configuración del proyecto nativo de Android para notificaciones push

Configuración de paquetes Android necesarios

El paquete se vincula automáticamente al compilar la aplicación. Tiene algunos pasos adicionales a continuación para completar el proceso de configuración.

Configuración del manifiesto de Android

En "android/app/src/main/AndroidManifest.xml", compruebe el nombre del paquete, los permisos y los servicios necesarios. Asegúrese de que registró y RNPushNotificationBootEventReceiver registró RNPushNotificationPublisher el RNPushNotificationListenerService servicio. Los metadatos de las notificaciones se pueden usar para personalizar la apariencia de las notificaciones 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>

Configurar servicios de Google

En "android/app/build.gradle", registre Google Services:

dependencies {
  ...
  implementation 'com.google.firebase:firebase-analytics:17.3.0'
  ...
}

apply plugin: 'com.google.gms.google-services'

Copie el archivo "google-services.json" que descargó durante la instalación de FCM en la carpeta del proyecto "android/app/".

Control de notificaciones push para Android

Ha configurado el servicio existente RNPushNotificationListenerService para controlar las notificaciones push entrantes de Android. Este servicio se registró anteriormente en el manifiesto de aplicación. Procesa las notificaciones entrantes y los servidores proxy en la parte React Native multiplataforma. No se requieren pasos adicionales.

Configuración del proyecto nativo de iOS para notificaciones push

Configuración de paquetes iOS necesarios

El paquete se vincula automáticamente al compilar la aplicación. Lo único que debe hacer es instalar los pods nativos:

npx pod-install

Configurar Info.plist y Entitlements.plist

  1. Vaya a la carpeta "PushDemo/ios" y abra el área de trabajo "PushDemo.xcworkspace", seleccione el proyecto superior "PushDemo" y seleccione la pestaña "Signing & Capabilities".

  2. Actualice el identificador de agrupación para que coincida con el valor usado en el perfil de aprovisionamiento.

  3. Agregue dos nuevas funcionalidades mediante el botón "+":

    • Funcionalidad modo en segundo plano y tic Notificaciones remotas.
    • Funcionalidad de notificaciones push

Control de notificaciones push para iOS

  1. Abra "AppDelegate.h" y agregue la siguiente importación:

    #import <UserNotifications/UNUserNotificationCenter.h>

  2. Actualice la lista de protocolos, compatible con "AppDelegate", agregando UNUserNotificationCenterDelegate:

    @interface AppDelegate : UIResponder <UIApplicationDelegate, RCTBridgeDelegate, UNUserNotificationCenterDelegate>

  3. Abra "AppDelegate.m" y configure todas las devoluciones de llamada de iOS necesarias:

    #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);
}

Prueba de la solución

Ahora puede probar el envío de notificaciones a través del servicio back-end.

Envío de una notificación de prueba

  1. Abra una nueva pestaña en Postman.

  2. Establezca la solicitud en POST y escriba la siguiente dirección:

    https://<app_name>.azurewebsites.net/api/notifications/requests

  3. Si eligió completar la sección Autenticar clientes mediante una clave de API , asegúrese de configurar los encabezados de solicitud para incluir el valor de apikey .

    Clave Valor
    apikey <your_api_key>

  4. Elija la opción sin formato del cuerpo, elija JSON en la lista de opciones de formato y, a continuación, incluya algún contenido JSON de marcador de posición:

    {
    "text": "Message from Postman!",
    "action": "action_a"
}

  5. Seleccione el botón Código , que está debajo del botón Guardar en la esquina superior derecha de la ventana. La solicitud debe ser similar al ejemplo siguiente cuando se muestra para HTML (dependiendo de si ha incluido un encabezado 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"
}

  6. Ejecute la aplicación PushDemo en una o ambas plataformas de destino (Android e iOS).

    Nota:

    Si está probando en Android , asegúrese de que no se está ejecutando en Depuración, o si la aplicación se ha implementado mediante la ejecución de la aplicación, fuerce a cerrar la aplicación e iniciarla de nuevo desde el iniciador.

  7. En la aplicación PushDemo , pulse en el botón Registrar .

  8. De nuevo en Postman, cierre la ventana Generar fragmentos de código (si aún no lo ha hecho) y haga clic en el botón Enviar .

  9. Compruebe que recibe una respuesta 200 OK en Postman y la alerta aparece en la aplicación que muestra la acción ActionA recibida.

  10. Cierre la aplicación PushDemo y, a continuación, haga clic en el botón Enviar de nuevo en Postman.

  11. Compruebe que recibe una respuesta 200 OK en Postman de nuevo. Compruebe que aparece una notificación en el área de notificación de la aplicación PushDemo con el mensaje correcto.

  12. Pulse en la notificación para confirmar que abre la aplicación y muestra la alerta recibida de la acción ActionA .

  13. De nuevo en Postman, modifique el cuerpo de la solicitud anterior para enviar una notificación silenciosa que especifique action_b en lugar de action_a para el valor de acción .

    {
    "action": "action_b",
    "silent": true
}

  14. Con la aplicación aún abierta, haga clic en el botón Enviar en Postman.

  15. Compruebe que obtiene una respuesta 200 OK en Postman y que la alerta aparece en la aplicación que muestra la acción ActionB recibida en lugar de acción ActionA recibida.

  16. Cierre la aplicación PushDemo y, a continuación, haga clic en el botón Enviar de nuevo en Postman.

  17. Compruebe que recibe una respuesta 200 OK en Postman y que la notificación silenciosa no aparece en el área de notificación.

Solución de problemas

No hay respuesta del servicio back-end

Al probar localmente, asegúrese de que el servicio back-end se está ejecutando y que usa el puerto correcto.

Si realiza pruebas en la aplicación de API de Azure, compruebe que el servicio se está ejecutando y se ha implementado y se ha iniciado sin errores.

Asegúrese de comprobar que ha especificado correctamente la dirección base en Postman o en la configuración de la aplicación móvil al probar a través del cliente. La dirección base debe ser https://<api_name>.azurewebsites.net/ o https://localhost:5001/ al realizar pruebas localmente.

No recibir notificaciones en Android después de iniciar o detener una sesión de depuración

Asegúrese de volver a registrarse después de iniciar o detener una sesión de depuración. El depurador hará que se genere un nuevo token de Firebase . La instalación del centro de notificaciones también debe actualizarse.

Recepción de un código de estado 401 del servicio back-end

Compruebe que está estableciendo el encabezado de solicitud apikey y que este valor coincide con el que ha configurado para el servicio back-end.

Si recibe este error al probar localmente, asegúrese de que el valor de clave definido en la configuración del cliente coincide con el valor de configuración de usuario Authentication:ApiKey que usa la API.

Si está probando con una aplicación de API, asegúrese de que el valor de clave del archivo de configuración del cliente coincide con la configuración de la aplicación Authentication:ApiKey que usa en la aplicación de API.

Nota:

Si ha creado o cambiado esta configuración después de haber implementado el servicio back-end, debe reiniciar el servicio para que surta efecto.

Si eligió no completar la sección Autenticar clientes mediante una clave de API , asegúrese de que no aplicó el atributo Authorize a la clase NotificationsController .

Recepción de un código de estado 404 del servicio back-end

Compruebe que el punto de conexión y el método de solicitud HTTP son correctos. Por ejemplo, los puntos de conexión deben ser:

  • [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

O al probar localmente:

  • [PUT]https://localhost:5001/api/notifications/installations
  • [DELETE]https://localhost:5001/api/notifications/installations/<installation_id>
  • [POST]https://localhost:5001/api/notifications/requests

Al especificar la dirección base en la aplicación cliente, asegúrese de que termina con ./ La dirección base debe ser https://<api_name>.azurewebsites.net/ o https://localhost:5001/ al realizar pruebas localmente.

No se puede registrar y se muestra un mensaje de error del centro de notificaciones

Compruebe que el dispositivo de prueba tiene conectividad de red. A continuación, determine el código de estado de respuesta Http estableciendo un punto de interrupción para inspeccionar el valor de la propiedad StatusCode en HttpResponse.

Revise las sugerencias de solución de problemas anteriores cuando corresponda en función del código de estado.

Establezca un punto de interrupción en las líneas que devuelven estos códigos de estado específicos para la API correspondiente. A continuación, intente llamar al servicio back-end al depurar localmente.

Valide que el servicio back-end funciona según lo previsto a través de Postman mediante la carga adecuada. Use la carga real creada por el código de cliente para la plataforma en cuestión.

Revise las secciones de configuración específicas de la plataforma para asegurarse de que no se han perdido los pasos. Compruebe que se resuelven los valores adecuados para installation id y token las variables de la plataforma adecuada.

No se puede resolver un identificador para el mensaje de error del dispositivo.

Revise las secciones de configuración específicas de la plataforma para asegurarse de que no se han perdido los pasos.

Pasos siguientes

Ahora debería tener una aplicación básica React Native conectada a un centro de notificaciones a través de un servicio back-end y puede enviar y recibir notificaciones.

Es probable que tenga que adaptar el ejemplo que se usa en este tutorial para adaptarse a su propio escenario. También se recomienda implementar un control de errores más sólido, la lógica de reintento y el registro.

Visual Studio App Center se puede incorporar rápidamente en aplicaciones móviles que proporcionan análisis y diagnósticos para ayudar en la solución de problemas.