Начните работу с Firebase Cloud Messaging

iOS+ Android Web Flutter Unity C++

В этом кратком руководстве описывается, как настроить Firebase Cloud Messaging в мобильных и веб-клиентских приложениях для надежной отправки сообщений. Сведения о серверных средах см. в разделе «Ваша серверная среда» и FCM .

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

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

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

Андроид

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

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

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

   Important: Make sure to add the firebase_messaging library to your CMakeLists.txt file.

2. Create a Firebase App object, passing in the JNI environment and Activity:

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

3. Define a class that implements the firebase::messaging::Listener interface.

4. Initialize FCM , passing in the App and a constructed Listener:

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

5. Apps that rely on the Google Play services SDK should check the device for a compatible Google Play services APK before accessing the features. To learn more, refer to Check for Google Play services APK .

iOS+

1. If you haven't already, add Firebase to your C++ project . Then, to set up your project for FCM :
   1. In your project's Podfile, add the FCM dependency:

      pod 'FirebaseMessaging'

   2. Drag the firebase.framework and firebase_messaging.framework frameworks into your Xcode project from the Firebase C++ SDK .

2. Загрузите свой ключ аутентификации APNs в Firebase. Если у вас ещё нет ключа аутентификации APNs, создайте его в Центре разработчиков Apple .

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

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

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

3. Configure your Xcode project to enable Push Notifications:

   1. Select the project from the Navigator area .
   2. Select the project target from the Editor area .

   3. Select the General tab from the Editor area .

      1. Scroll to Linked Frameworks and Libraries , then click the + button to add frameworks.

      2. In the window that appears, scroll to UserNotifications.framework , click the entry, then click Add .

         This framework only appears in Xcode v8 and later and is required by this library.

   4. Select the Capabilities tab from the Editor area .

      1. Switch Push Notifications to On .
      2. Scroll to Background Modes , then switch it to On .
      3. Select Remote notifications under Background Modes .

4. Create a Firebase App object:

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

5. Define a class that implements the firebase::messaging::Listener interface.

6. Initialize Firebase Cloud Messaging, passing in the App and a constructed Listener:

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

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

Upon initializing the Firebase Cloud Messaging library, a registration token is requested for the client app instance. The app will receive the token with the OnTokenReceived callback, which should be defined in the class that implements firebase::messaging::Listener .

If you want to target that specific device, you'll need access to this token.

Note about message delivery on Android

When the app is not running at all and a user taps on a notification, the message is not, by default, routed through FCM 's built in callbacks. In this case, message payloads are received through an Intent used to start the application. To have FCM forward these incoming messages to the C++ library callback, you need to override the method onNewIntent in your Activity and pass the Intent to the 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);
  }
}

Messages received while the app is in the background have the content of their notification field used to populate the system tray notification, but that notification content won't be communicated to FCM . That is, Message::notification will be a null.

В итоге:

Состояние приложения	Уведомление	Данные	Оба
Передний план	OnMessageReceived	OnMessageReceived	OnMessageReceived
Фон	Системный лоток	OnMessageReceived	Notification: system tray Data: in extras of the intent.

Custom message handling on Android

By default, notifications sent to the app are passed to ::firebase::messaging::Listener::OnMessageReceived , but in some cases you may want to override the default behavior. To do this on Android you will need to write custom classes that extend com.google.firebase.messaging.cpp.ListenerService as well as update your project's AndroidManifest.xml .

Override ListenerService methods

The ListenerService is the Java class that intercepts incoming messages sent to the app and routes them to the C++ library. When the app is in the foreground (or when the app is the background and it receives a data-only payload), messages will pass through one of the callbacks provided on this class. To add custom behavior to the message handling, you will need to extend FCM 's default ListenerService :

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

class MyListenerService extends ListenerService {

By overriding the method ListenerService.onMessageReceived , you can perform actions based on the received RemoteMessage object and get the message data:

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

ListenerService also has a few other methods that are used less frequently. These can be overridden as well, for more information see the FirebaseMessagingService reference.

@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

Once your custom classes have been written, they must be included in the AndroidManifest.xml to take effect. Make sure that the manifest includes the merge tools by declaring the appropriate attribute inside the <manifest> tag, like so:

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

In the firebase_messaging_cpp.aar archive there is an AndroidManifest.xml file which declares FCM 's default ListenerService . This manifest is normally merged with the project specific manifest which is how the ListenerService is able to run. This ListenerService needs to replaced with the custom listener service. That is accomplished by removing the default ListenerService and adding the custom Service, which can be done with the following lines your projects AndroidManifest.xml file:

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

New versions of Firebase C++ SDK (7.1.0 onwards) use JobIntentService which requires additional modifications in AndroidManifest.xml file.

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

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

FCM generates a registration token for device targeting. When a token is generated, the library uploads the identifier and configuration data to Firebase. If you want to get an explicit opt-in before using the token, you can prevent generation at configure time by disabling FCM (and on Android, Analytics). To do this, add a metadata value to your Info.plist (not your GoogleService-Info.plist ) on Apple platforms, or your AndroidManifest.xml on 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);

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

Messages with deep links on Android

FCM allows messages to be sent containing a deep link into your app. To receive messages that contain a deep link, you must add a new intent filter to the activity that handles deep links for your app. The intent filter should catch deep links of your domain. If your messages don't contain a deep link, this configuration is not necessary. In 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>

It is also possible to specify a wildcard to make the intent filter more flexible. For example:

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

When users tap a notification containing a link to the scheme and host you specify, your app will start the activity with this intent filter to handle the link.

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

After you have completed the setup steps, here are a few options for moving forward with FCM for C++:

• Отправка сообщений на устройства
• Receive messages in a C++ app
• Отправлять сообщения по темам