Odbieranie wiadomości za pomocą Komunikacji w chmurze Firebase

Z tego przewodnika dowiesz się, jak skonfigurować Firebase Cloud Messaging w aplikacjach klienckich na urządzenia mobilne i w internecie, aby niezawodnie odbierać wiadomości.

Aby otrzymywać wiadomości, użyj usługi, która rozszerza FirebaseMessagingService. Usługa powinna zastępować wywołania zwrotne onMessageReceived i onDeletedMessages.

onMessageReceived jest dostępny w przypadku większości typów wiadomości, z wyjątkiem:

• Wiadomości z powiadomieniami dostarczane, gdy aplikacja działa w tle. W takim przypadku powiadomienie jest dostarczane do obszaru powiadomień urządzenia. Gdy użytkownik kliknie powiadomienie, domyślnie otworzy się menu z aplikacjami.

• Wiadomości z powiadomieniem i ładunkiem danych, gdy są odbierane w tle. W takim przypadku powiadomienie jest dostarczane do zasobnika systemowego urządzenia, a ładunek danych jest dostarczany w dodatkach intencji aktywności programu uruchamiającego.

W skrócie:

Więcej informacji o typach wiadomości znajdziesz w artykule Powiadomienia i wiadomości z danymi.

Wywołanie zwrotne onMessageReceived ma limity czasu, które umożliwiają wysłanie powiadomienia, ale nie są przeznaczone do tego, aby aplikacja mogła uzyskać dostęp do sieci lub wykonać dodatkowe działania. Jeśli Twoja aplikacja wykonuje bardziej złożone działania, musisz wykonać dodatkowe czynności, aby zapewnić jej prawidłowe działanie.

Jeśli uważasz, że obsługa wiadomości przez aplikację może trwać blisko 10 sekund, zaplanuj zadanie WorkManager lub postępuj zgodnie z poniższymi wskazówkami dotyczącymi WakeLock. W niektórych przypadkach czas na obsługę wiadomości może być krótszy niż 10 sekund, w zależności od opóźnień przed wywołaniem onMessageReceived, w tym opóźnień systemu operacyjnego, czasu uruchamiania aplikacji, zablokowania wątku głównego przez inne operacje lub zbyt długiego czasu trwania poprzednich wywołań onMessageReceived. Po upływie tego czasu aplikacja może podlegać zakończeniu procesu lub ograniczeniom dotyczącym działania w tle. Pamiętaj, że opóźnienia w przypadku transakcji sieciowych i uruchamiania aplikacji mogą być znaczne, więc w razie wątpliwości zaplanuj długotrwałe przetwarzanie wiadomości, jeśli występują zależności asynchroniczne, takie jak dostęp do sieci lub wymagania dotyczące intensywnego wczytywania danych.

Edytowanie pliku manifestu aplikacji

Aby korzystać z FirebaseMessagingService, musisz dodać do pliku manifestu aplikacji te elementy:

<service
    android:name=".java.MyFirebaseMessagingService"
    android:exported="false">
    <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT" />
    </intent-filter>
</service>
AndroidManifest.xml

Zalecamy też ustawienie wartości domyślnych, aby dostosować wygląd powiadomień. Możesz określić niestandardową ikonę domyślną i niestandardowy kolor domyślny, które będą stosowane, gdy w ładunku powiadomienia nie będą ustawione równoważne wartości.

Aby ustawić niestandardową ikonę domyślną i kolor niestandardowy, dodaj te wiersze w tagu application:

<!-- Set custom default icon. This is used when no icon is set for incoming notification messages.
     See README(https://goo.gl/l4GJaQ) for more. -->
<meta-data
    android:name="com.google.firebase.messaging.default_notification_icon"
    android:resource="@drawable/ic_stat_ic_notification" />
<!-- Set color used with incoming notification messages. This is used when no color is set for the incoming
     notification message. See README(https://goo.gl/6BKBk7) for more. -->
<meta-data
    android:name="com.google.firebase.messaging.default_notification_color"
    android:resource="@color/colorAccent" />
AndroidManifest.xml

Android wyświetla i używa niestandardowej ikony domyślnej w przypadku

• Wszystkie wiadomości z powiadomieniami wysyłane z edytora powiadomień.
• Każda wiadomość z powiadomieniem, która nie zawiera ikony w ładunku powiadomienia.

Jeśli nie ustawiono niestandardowej ikony domyślnej ani ikony w ładunku powiadomienia, Android wyświetla ikonę aplikacji w kolorze białym.

Zastąp onMessageReceived

Zastępując metodę FirebaseMessagingService.onMessageReceived, możesz wykonywać działania na podstawie otrzymanego obiektu RemoteMessage i pobierać dane wiadomości:

override fun onMessageReceived(remoteMessage: RemoteMessage) {
    // TODO(developer): Handle FCM messages here.
    // Not getting messages here? See why this may be: https://goo.gl/39bRNJ
    Log.d(TAG, "From: ${remoteMessage.from}")

    // Check if message contains a data payload.
    if (remoteMessage.data.isNotEmpty()) {
        Log.d(TAG, "Message data payload: ${remoteMessage.data}")

        // Check if data needs to be processed by long running job
        if (needsToBeScheduled()) {
            // For long-running tasks (10 seconds or more) use WorkManager.
            scheduleJob()
        } else {
            // Handle message within 10 seconds
            handleNow()
        }
    }

    // Check if message contains a notification payload.
    remoteMessage.notification?.let {
        Log.d(TAG, "Message Notification Body: ${it.body}")
    }

    // Also if you intend on generating your own notifications as a result of a received FCM
    // message, here is where that should be initiated. See sendNotification method below.
}
MyFirebaseMessagingService.kt

@Override
public void onMessageReceived(RemoteMessage remoteMessage) {
    // TODO(developer): Handle FCM messages here.
    // Not getting messages here? See why this may be: https://goo.gl/39bRNJ
    Log.d(TAG, "From: " + remoteMessage.getFrom());

    // Check if message contains a data payload.
    if (remoteMessage.getData().size() > 0) {
        Log.d(TAG, "Message data payload: " + remoteMessage.getData());

        if (/* Check if data needs to be processed by long running job */ true) {
            // For long-running tasks (10 seconds or more) use WorkManager.
            scheduleJob();
        } else {
            // Handle message within 10 seconds
            handleNow();
        }

    }

    // Check if message contains a notification payload.
    if (remoteMessage.getNotification() != null) {
        Log.d(TAG, "Message Notification Body: " + remoteMessage.getNotification().getBody());
    }

    // Also if you intend on generating your own notifications as a result of a received FCM
    // message, here is where that should be initiated. See sendNotification method below.
}
MyFirebaseMessagingService.java

Nie pozwala uśpić urządzenia podczas obsługi wiadomości FCM

Jeśli aplikacja musi utrzymywać urządzenie w stanie aktywności podczas przetwarzania wiadomości FCM, musi w tym czasie utrzymywać blokadę WakeLock lub utworzyć zadanie WorkManager. Blokady WakeLock sprawdzają się w przypadku krótkich działań przetwarzania, które mogą przekraczać domyślne limity czasu onMessageReceived. W przypadku rozbudowanych przepływów pracy, takich jak wysyłanie do serwerów wielu szeregowych wywołań RPC, lepszym rozwiązaniem niż WakeLock jest użycie zadania WorkManager. W tej sekcji skupimy się na tym, jak używać blokad wybudzania. A WakeLock zapobiega przejściu urządzenia w stan uśpienia podczas działania aplikacji, co może zwiększyć zużycie baterii. Dlatego WakeLock należy używać tylko w przypadkach, gdy aplikacja nie powinna być wstrzymywana podczas obsługi wiadomości, np.:

• Powiadomienia dla użytkownika, które są pilne.
• Interakcje z elementami poza urządzeniem, których nie należy przerywać (np. przesyłanie danych w sieci lub komunikacja z innym urządzeniem, takim jak sparowany zegarek).

Najpierw musisz się upewnić, że Twoja aplikacja żąda uprawnienia WakeLock (pakiet SDK FCM zawiera je domyślnie, więc zwykle nie trzeba niczego dodawać).

<uses-permission android:name="android.permission.WAKE_LOCK" />

Następnie aplikacja musi uzyskać blokadę WakeLock na początku wywołania zwrotnego FirebaseMessagingService.onMessageReceived() i zwolnić ją na końcu wywołania zwrotnego.

Niestandardowy FirebaseMessagingService aplikacji:

@Override
public void onMessageReceived(final RemoteMessage message) {
  // If this is a message that is time sensitive or shouldn't be interrupted
  WakeLock wakeLock = getSystemService(PowerManager.class).newWakeLock(PARTIAL_WAKE_LOCK, "myApp:messageReceived");
  try {
    wakeLock.acquire(TIMEOUT_MS);
    // handle message
    ...
  finally {
    wakeLock.release();
  }
}

Zastąp onDeletedMessages

W niektórych sytuacjach usługa FCM może nie dostarczyć wiadomości. Dzieje się tak, gdy w momencie połączenia na urządzeniu jest zbyt wiele oczekujących wiadomości (ponad 100) dla Twojej aplikacji lub gdy urządzenie nie łączyło się z FCM od ponad miesiąca. W takich przypadkach możesz otrzymać telefon zwrotny na numer FirebaseMessagingService.onDeletedMessages(). Gdy instancja aplikacji otrzyma to wywołanie zwrotne, powinna przeprowadzić pełną synchronizację z serwerem aplikacji. Jeśli w ciągu ostatnich 4 tygodni nie wysłano wiadomości do aplikacji na tym urządzeniu, FCMnie zadzwonionDeletedMessages().

Obsługa wiadomości z powiadomieniami w aplikacji działającej w tle

Gdy aplikacja działa w tle, Android kieruje wiadomości z powiadomieniami do obszaru powiadomień. Gdy użytkownik kliknie powiadomienie, domyślnie otworzy się menu z aplikacjami.

Obejmuje to wiadomości zawierające zarówno powiadomienie, jak i ładunek danych (oraz wszystkie wiadomości wysyłane z konsoli Powiadomienia). W takich przypadkach powiadomienie jest dostarczane do zasobnika systemowego urządzenia, a ładunek danych jest dostarczany w dodatkach intencji aktywności programu uruchamiającego.

Aby uzyskać wgląd w dostarczanie wiadomości do aplikacji, zapoznaj się z  FCM panelem raportowania, który rejestruje liczbę wysłanych i otwartych wiadomości na urządzeniach z Androidem i Apple, a także dane dotyczące „wyświetleń” (powiadomień widocznych dla użytkowników) w przypadku aplikacji na Androida.