Настройка клиентского приложения Firebase Cloud Messaging с помощью C++

Чтобы написать кроссплатформенное клиентское приложение Firebase Cloud Messaging на C++, используйте API Firebase Cloud Messaging . C++ SDK работает как для платформ Android, так и для Apple, с некоторыми дополнительными настройками, необходимыми для каждой платформы.

Настройте Firebase и FCM SDK

андроид

  1. Если вы еще этого не сделали, добавьте Firebase в свой проект C++ .

    • В связанных инструкциях по настройке ознакомьтесь с требованиями к устройствам и приложениям для использования Firebase C++ SDK, включая рекомендацию использовать CMake для сборки вашего приложения.

    • В файле build.gradle на уровне проекта обязательно включите репозиторий Maven от Google в разделы buildscript и allprojects .

  2. Создайте объект Firebase App, передав среду JNI и Activity:

    app = ::firebase::App::Create(::firebase::AppOptions(), jni_env, activity);

  3. Определите класс, реализующий интерфейс firebase::messaging::Listener .

  4. Инициализируем FCM , передав приложение и созданный прослушиватель:

    ::firebase::messaging::Initialize(app, listener);

  5. Приложения, которые полагаются на Google Play services SDK, должны проверить устройство на наличие совместимого Google Play services APK перед доступом к функциям. Чтобы узнать больше, см. Проверка наличия Google Play services APK .

iOS+

  1. Если вы еще этого не сделали, добавьте Firebase в свой проект C++ . Затем, чтобы настроить свой проект для FCM :
    1. В Podfile вашего проекта добавьте зависимость FCM:
      pod 'FirebaseMessaging'
    2. Перетащите фреймворки firebase.framework и firebase_messaging.framework в свой проект Xcode из Firebase C++ SDK .
  2. Загрузите свой ключ аутентификации APNs в Firebase. Если у вас еще нет ключа аутентификации APNs, обязательно создайте его в Apple Developer Member Center .

    1. Внутри вашего проекта в консоли Firebase выберите значок шестеренки, выберите Параметры проекта , а затем выберите вкладку Облачные сообщения .

    2. В разделе «Ключ аутентификации APNs» в разделе «Конфигурация приложения iOS» нажмите кнопку «Загрузить» .

    3. Перейдите к месту, где вы сохранили свой ключ, выберите его и нажмите «Открыть» . Добавьте идентификатор ключа (доступен в Apple Developer Member Center ) и нажмите «Загрузить» .

  3. Настройте свой проект Xcode для включения Push-уведомлений:

    1. Выберите проект в области навигатора .
    2. Выберите цель проекта в области редактора .
    3. Выберите вкладку «Общие» в области «Редактор» .

      1. Прокрутите страницу вниз до раздела Связанные фреймворки и библиотеки , затем нажмите кнопку + , чтобы добавить фреймворки.
      2. В появившемся окне прокрутите до UserNotifications.framework , щелкните по этой записи, затем щелкните Добавить .

        Этот фреймворк появляется только в Xcode v8 и более поздних версиях и требуется для этой библиотеки.

    4. Выберите вкладку «Возможности» в области «Редактор» .

      1. Включите Push-уведомления .
      2. Прокрутите вниз до пункта Фоновые режимы , затем переключите его в положение Вкл .
      3. Выберите Удаленные уведомления в разделе Фоновые режимы .
  4. Создайте объект приложения Firebase:

    app = ::firebase::App::Create(::firebase::AppOptions());

  5. Определите класс, реализующий интерфейс firebase::messaging::Listener .

  6. Инициализируйте Firebase Cloud Messaging, передав приложение и созданный прослушиватель:

    ::firebase::messaging::Initialize(app, listener);

Доступ к токену регистрации устройства

При инициализации библиотеки Firebase Cloud Messaging запрашивается регистрационный токен для экземпляра клиентского приложения. Приложение получит токен с помощью обратного вызова OnTokenReceived , который должен быть определен в классе, реализующем firebase::messaging::Listener .

Если вы хотите нацелиться на это конкретное устройство, вам понадобится доступ к этому токену.

Примечание о доставке сообщений на Android

Когда приложение вообще не запущено, а пользователь нажимает на уведомление, сообщение по умолчанию не направляется через встроенные обратные вызовы FCM . В этом случае полезные данные сообщения принимаются через Intent , используемый для запуска приложения. Чтобы FCM пересылал эти входящие сообщения обратному вызову библиотеки C++, вам необходимо переопределить метод onNewIntent в вашей Activity и передать Intent в MessageForwardingService .

import com.google.firebase.messaging.MessageForwardingService;

class MyActivity extends Activity {
  private static final String TAG = "MyActvity";

  @Override
  protected void onNewIntent(Intent intent) {
    Log.d(TAG, "A message was sent to this app while it was in the background.");
    Intent message = new Intent(this, MessageForwardingService.class);
    message.setAction(MessageForwardingService.ACTION_REMOTE_INTENT);
    message.putExtras(intent);
    message.setData(intent.getData());
    // For older versions of Firebase C++ SDK (< 7.1.0), use `startService`.
    // startService(message);
    MessageForwardingService.enqueueWork(this, message);
  }
}

Сообщения, полученные, когда приложение находится в фоновом режиме, имеют содержимое поля уведомления, используемое для заполнения уведомления в системном трее, но содержимое этого уведомления не будет передано в FCM . То есть, Message::notification будет иметь значение null.

В итоге:

Состояние приложения Уведомление Данные Оба
Передний план OnMessageReceived OnMessageReceived OnMessageReceived
Фон Системный лоток OnMessageReceived Уведомление: системный трей
Данные: в дополнениях к намерению.

Пользовательская обработка сообщений на Android

По умолчанию уведомления, отправляемые в приложение, передаются в ::firebase::messaging::Listener::OnMessageReceived , но в некоторых случаях вам может потребоваться переопределить поведение по умолчанию. Чтобы сделать это на Android, вам нужно будет написать пользовательские классы, которые расширяют com.google.firebase.messaging.cpp.ListenerService , а также обновить AndroidManifest.xml вашего проекта.

Переопределить методы ListenerService .

ListenerService — это класс Java, который перехватывает входящие сообщения, отправленные приложению, и направляет их в библиотеку C++. Когда приложение находится на переднем плане (или когда приложение находится в фоновом режиме и получает полезную нагрузку только с данными), сообщения будут проходить через один из обратных вызовов, предоставленных в этом классе. Чтобы добавить пользовательское поведение к обработке сообщений, вам нужно будет расширить ListenerService FCM по умолчанию:

import com.google.firebase.messaging.cpp.ListenerService;

class MyListenerService extends ListenerService {

Переопределив метод ListenerService.onMessageReceived , вы можете выполнять действия на основе полученного объекта RemoteMessage и получать данные сообщения:

@Override
public void onMessageReceived(RemoteMessage message) {
  Log.d(TAG, "A message has been received.");
  // Do additional logic...
  super.onMessageReceived(message);
}

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

@Override
public void onDeletedMessages() {
  Log.d(TAG, "Messages have been deleted on the server.");
  // Do additional logic...
  super.onDeletedMessages();
}

@Override
public void onMessageSent(String messageId) {
  Log.d(TAG, "An outgoing message has been sent.");
  // Do additional logic...
  super.onMessageSent(messageId);
}

@Override
public void onSendError(String messageId, Exception exception) {
  Log.d(TAG, "An outgoing message encountered an error.");
  // Do additional logic...
  super.onSendError(messageId, exception);
}

Обновить AndroidManifest.xml

После того, как ваши пользовательские классы будут написаны, их необходимо включить в AndroidManifest.xml , чтобы они вступили в силу. Убедитесь, что манифест включает инструменты слияния, объявив соответствующий атрибут внутри тега <manifest> , например:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.google.firebase.messaging.cpp.samples"
    xmlns:tools="http://schemas.android.com/tools">

В архиве firebase_messaging_cpp.aar есть файл AndroidManifest.xml , который объявляет FCM 's Default ListenerService . Этот манифест обычно объединяется с конкретным манифестом проекта, благодаря которому ListenerService может работать. Этот ListenerService необходимо заменить на пользовательский сервис слушателя. Это достигается путем удаления стандартного ListenerService и добавления пользовательского сервиса, что можно сделать с помощью следующих строк в файле AndroidManifest.xml вашего проекта:

<service android:name="com.google.firebase.messaging.cpp.ListenerService"
         tools:node="remove" />
<service android:name="com.google.firebase.messaging.cpp.samples.MyListenerService"
         android:exported="false">
  <intent-filter>
    <action android:name="com.google.firebase.MESSAGING_EVENT"/>
  </intent-filter>
</service>

В новых версиях Firebase C++ SDK (начиная с 7.1.0) используется JobIntentService , который требует дополнительных изменений в файле AndroidManifest.xml .

<service android:name="com.google.firebase.messaging.MessageForwardingService"
     android:permission="android.permission.BIND_JOB_SERVICE"
     android:exported="false" >
</service>

Запретить автоматическую инициализацию

FCM генерирует регистрационный токен для таргетинга устройств. Когда токен генерируется, библиотека загружает идентификатор и данные конфигурации в Firebase. Если вы хотите получить явное согласие перед использованием токена, вы можете предотвратить генерацию во время настройки, отключив FCM (а на Android — Analytics). Для этого добавьте значение метаданных в ваш Info.plist (не GoogleService-Info.plist ) на платформах Apple или в ваш AndroidManifest.xml на Android:

андроид

<?xml version="1.0" encoding="utf-8"?>
<application>
  <meta-data android:name="firebase_messaging_auto_init_enabled"
             android:value="false" />
  <meta-data android:name="firebase_analytics_collection_enabled"
             android:value="false" />
</application>

Быстрый

FirebaseMessagingAutoInitEnabled = NO

Чтобы повторно включить FCM, вы можете выполнить вызов во время выполнения:

::firebase::messaging::SetTokenRegistrationOnInitEnabled(true);

После установки это значение сохраняется при перезапуске приложения.

FCM позволяет отправлять сообщения, содержащие глубокую ссылку в ваше приложение. Чтобы получать сообщения, содержащие глубокую ссылку, необходимо добавить новый фильтр намерений в действие, которое обрабатывает глубокие ссылки для вашего приложения. Фильтр намерений должен улавливать глубокие ссылки вашего домена. Если ваши сообщения не содержат глубокую ссылку, эта конфигурация не нужна. В AndroidManifest.xml:

<intent-filter>
  <action android:name="android.intent.action.VIEW"/>
  <category android:name="android.intent.category.DEFAULT"/>
  <category android:name="android.intent.category.BROWSABLE"/>
  <data android:host="CHANGE_THIS_DOMAIN.example.com" android:scheme="http"/>
  <data android:host="CHANGE_THIS_DOMAIN.example.com" android:scheme="https"/>
</intent-filter>

Также можно указать подстановочный знак, чтобы сделать фильтр намерений более гибким. Например:

<intent-filter>
  <action android:name="android.intent.action.VIEW"/>
  <category android:name="android.intent.category.DEFAULT"/>
  <category android:name="android.intent.category.BROWSABLE"/>
  <data android:host="*.example.com" android:scheme="http"/>
  <data android:host="*.example.com" android:scheme="https"/>
</intent-filter>

Когда пользователи нажимают на уведомление, содержащее ссылку на указанную вами схему и хост, ваше приложение начинает действие с этим фильтром намерений для обработки ссылки.

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

После настройки клиентского приложения вы готовы отправлять сообщения по нисходящему потоку и по темам с помощью Firebase. Чтобы узнать больше, посмотрите эту функциональность, продемонстрированную в примере быстрого старта , который вы можете загрузить, запустить и просмотреть.

Чтобы добавить в свое приложение другие, более сложные функции, ознакомьтесь с руководствами по отправке сообщений с сервера приложений:

Помните, что для использования этих функций вам понадобится реализация сервера .