Миграция Google Firebase Cloud Messaging с помощью пакетов SDK Azure

Статья
05/09/2024

Google отрекнет устаревший API Firebase Cloud Messaging (FCM) к июля 2024 года. Вы можете начать миграцию с устаревшего протокола HTTP на FCM версии 1 1 марта 2024 г. К июню 2024 г. необходимо завершить миграцию. В этом разделе описаны шаги по миграции из устаревшей версии FCM в FCM версии 1 с помощью пакетов SDK Azure.

Внимание

По состоянию на июнь 2024 года устаревшие API FCM больше не будут поддерживаться и будут прекращены. Чтобы избежать сбоев в службе push-уведомлений, необходимо как можно скорее перейти к протоколу FCM версии 1.

Необходимые компоненты

Убедитесь, что API Firebase Cloud Messaging (V1) включен в параметре проекта Firebase в разделе Cloud Messaging.
Убедитесь, что учетные данные FCM обновлены. Выполните шаг 1 в руководстве по REST API.

Пакет SDK для Android

Обновите версию 2.0.0 пакета SDK до файла build.gradle приложения. Например:

// This is not a complete build.gradle file; it only highlights the portions you need to update. 

dependencies { 
    // Ensure the following line is updated in your app/library's "dependencies" section.
implementation 'com.microsoft.azure:notification-hubs-android-sdk:2.0.0' 
    // optionally, use the fcm optimized SKU instead: 
    // implementation 'com.microsoft.azure:notification-hubs-android-sdk-fcm:2.0.0' 
}

Обновите шаблон полезных данных. Если вы не используете шаблоны, этот шаг можно пропустить.

См. справочник по REST FCM для структуры полезных данных FCM версии 1. Сведения о миграции из устаревшей полезных данных FCM в полезные данные FCM версии 1 см. в разделе "Обновление полезных данных отправки запросов".

Например, если вы используете регистрации:
```
NotificationHub hub = new NotificationHub(BuildConfig.hubName, BuildConfig.hubListenConnectionString, context);
String template = "{\"message\":{\"android\":{\"data\":{\"message\":\"{'Notification Hub test notification: ' + $(myTextProp)}\"}}}}";
hub.registerTemplate(token, "template-name", template);
```
Если вы используете установки:
```
InstallationTemplate testTemplate = new InstallationTemplate(); 
testTemplate.setBody("{\"message\":{\"android\":{\"data\":{\"message\":\"{'Notification Hub test notification: ' + $(myTextProp)}\"}}}}");  
NotificationHub.setTemplate("testTemplate", testTemplate);
```

Пакеты SDK для сервера (плоскость данных)

Обновите пакет SDK до последней версии (4.2.0):

Имя пакета SDK GitHub	Имя пакета SDK	Версия
azure-notificationhubs-dotnet	Microsoft.Azure.NotificationHubs	4.2.0
azure-notificationhubs-java-backend	com.windowsazure.Notification-Hubs-java-sdk	1.1.0
azure-sdk-for-js	@azure/notification-hubs	1.1.0

Например, в CSPROJ-файле :

<PackageReference Include="Microsoft.Azure.NotificationHubs" Version="4.2.0" />

Добавьте его в FcmV1Credential центр уведомлений. Выполнить этот шаг достаточно один раз. Если у вас нет большого количества центров и вы хотите автоматизировать этот шаг, можно использовать REST API или портал Azure для добавления учетных данных FCM версии 1:

// Create new notification hub with FCM v1 credentials
var hub = new NotificationHubDescription("hubname"); 
hub.FcmV1Credential = new FcmV1Credential("private-key", "project-id", "client-email"); 
hub = await namespaceManager.CreateNotificationHubAsync(hub); 

// Update existing notification hub with FCM v1 credentials 
var hub = await namespaceManager.GetNotificationHubAsync("hubname", CancellationToken.None); 
hub.FcmV1Credential = new FcmV1Credential("private-key", "project-id", "client-email"); 
hub = await namespaceManager.UpdateNotificationHubAsync(hub, CancellationToken.None);

// Create new notification hub with FCM V1 credentials
NamespaceManager namespaceManager = new NamespaceManager(namespaceConnectionString);
NotificationHubDescription hub = new NotificationHubDescription("hubname");
hub.setFcmV1Credential(new FcmV1Credential("private-key", "project-id", "client-email"));
hub = namespaceManager.createNotificationHub(hub);

// Updating existing Notification Hub with FCM V1 Credentials
NotificationHubDescription hub = namespaceManager.getNotificationHub("hubname");
hub.setFcmV1Credential(new FcmV1Credential("private-key", "project-id", "client-email"));
hub = namespaceManager.updateNotificationHub(hub);

Управление регистрацией и установками. Для регистрации используется FcmV1RegistrationDescription для регистрации устройств FCM версии 1. Например:

// Create new Registration
var deviceToken = "device-token"; 
var tags = new HashSet<string> { "tag1", "tag2" }; 
FcmV1RegistrationDescription registration = await hub. CreateFcmV1NativeRegistrationAsync(deviceToken, tags);

Для Java используйте FcmV1Registration для регистрации устройств FCMv1:

// Create new registration
NotificationHub client = new NotificationHub(connectionString, hubName);
FcmV1Registration registration =  client.createRegistration(new FcmV1Registration("fcm-device-token"));

Для JavaScript используется createFcmV1RegistrationDescription для регистрации устройств FCMv1:

// Create FCM V1 registration
const context = createClientContext(connectionString, hubName);
const registration = createFcmV1RegistrationDescription({
  fcmV1RegistrationId: "device-token",
});
const registrationResponse = await createRegistration(context, registration);

Для установок используйте NotificationPlatform.FcmV1 платформу в Installationкачестве платформы или FcmV1Installation создайте установки FCM версии 1:

// Create new installation
var installation = new Installation 
{ 
    InstallationId = "installation-id", 
    PushChannel = "device-token", 
    Platform = NotificationPlatform.FcmV1 
}; 
await hubClient.CreateOrUpdateInstallationAsync(installation); 

// Alternatively, you can use the FcmV1Installation class directly 
var installation = new FcmV1Installation("installation-id", "device-token"); 
await hubClient.CreateOrUpdateInstallationAsync(installation);

Для Java используйте NotificationPlatform.FcmV1 в качестве платформы:

// Create new installation
NotificationHub client = new NotificationHub(connectionString, hubName);
client.createOrUpdateInstallation(new Installation("installation-id", NotificationPlatform.FcmV1, "device-token"));

Для JavaScript используется createFcmV1Installation для создания установки FCMv1:

// Create FCM V1 installation
const context = createClientContext(connectionString, hubName);
const installation = createFcmV1Installation({
  installationId: "installation-id",
  pushChannel: "device-token",
});
const result = await createOrUpdateInstallation(context, installation);

Обратите внимание на следующие моменты:

Если регистрация устройства происходит в клиентском приложении, сначала обновите клиентское приложение, чтобы зарегистрировать его на платформе FCMv1.
Если регистрация устройства происходит на сервере, вы можете получить все регистрации и установки и обновить их до FCMv1 на сервере.

Отправьте уведомление в FCMv1. Используйте FcmV1Notification при отправке уведомлений, предназначенных для FCMv1. Например:

// Send FCM v1 notification
var jsonBody = "{\"message\":{\"android\":{\"data\":{\"message\":\"Notification Hub test notification\"}}}}"; 
var n = new FcmV1Notification(jsonBody); 
NotificationOutcome outcome = await hub.SendNotificationAsync(n, "tag");

// Send FCM V1 Notification 
NotificationHub client = new NotificationHub(connectionString, hubName);
NotificationOutcome outcome = client.sendNotification(new FcmV1Notification("{\"message\":{\"android\":{\"data\":{\"message\":\"Notification Hub test notification\"}}}}"));

// Send FCM V1 Notification
const context = createClientContext(connectionString, hubName);
const messageBody = `{
  "message": {
      "android": {
          "data": {
              "message": "Notification Hub test notification"
          }
      }
  }
}`;

const notification = createFcmV1Notification({
  body: messageBody,
});
const result = await sendNotification(context, notification);

Следующие шаги

Миграция Firebase Cloud Messaging с помощью REST API

Поделиться через

Миграция Google Firebase Cloud Messaging с помощью пакетов SDK Azure

Необходимые компоненты

Пакет SDK для Android

Пакеты SDK для сервера (плоскость данных)

Следующие шаги

Обратная связь

Дополнительные ресурсы