Richten Sie eine Firebase Cloud Messaging-Client-App auf Android ein

FCM-Clients erfordern Geräte mit Android 4.4 oder höher, auf denen auch die Google Play Store-App installiert ist, oder einen Emulator mit Android 4.4 mit Google-APIs. Beachten Sie, dass Sie nicht darauf beschränkt sind, Ihre Android-Apps über den Google Play Store bereitzustellen.

Richten Sie das SDK ein

Dieser Abschnitt behandelt Aufgaben, die Sie möglicherweise abgeschlossen haben, wenn Sie bereits andere Firebase-Funktionen für Ihre App aktiviert haben. Fügen Sie Ihrem Android-Projekt Firebase hinzu, falls Sie dies noch nicht getan haben

Bearbeiten Sie Ihr App-Manifest

Fügen Sie dem Manifest Ihrer App Folgendes hinzu:

  • Ein Dienst, der FirebaseMessagingService erweitert. Dies ist erforderlich, wenn Sie Nachrichten verarbeiten möchten, die über den Empfang von Benachrichtigungen zu Apps im Hintergrund hinausgehen. Um Benachrichtigungen in Apps im Vordergrund zu erhalten, Datennutzlast zu empfangen, Upstream-Nachrichten zu senden usw. müssen Sie diesen Dienst erweitern.
  • <service
        android:name=".java.MyFirebaseMessagingService"
        android:exported="false">
        <intent-filter>
            <action android:name="com.google.firebase.MESSAGING_EVENT" />
        </intent-filter>
    </service>
  • (Optional) Innerhalb der Anwendungskomponente Metadatenelemente zum Festlegen eines Standardbenachrichtigungssymbols und einer Standardfarbe. Android verwendet diese Werte, wenn eingehende Nachrichten das Symbol oder die Farbe nicht explizit festlegen.
  • <!-- 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" />
  • (Optional) Ab Android 8.0 (API-Level 26) und höher werden Benachrichtigungskanäle unterstützt und empfohlen. FCM bietet einen Standard-Benachrichtigungskanal mit grundlegenden Einstellungen. Wenn Sie es vorziehen, Ihren eigenen Standardkanal zu erstellen und zu verwenden, setzen default_notification_channel_id wie gezeigt auf die ID Ihres Benachrichtigungskanalobjekts; FCM verwendet diesen Wert immer dann, wenn eingehende Nachrichten keinen Benachrichtigungskanal explizit festlegen. Weitere Informationen finden Sie unter Benachrichtigungskanäle verwalten .
  • <meta-data
        android:name="com.google.firebase.messaging.default_notification_channel_id"
        android:value="@string/default_notification_channel_id" />

Fordern Sie die Berechtigung für Laufzeitbenachrichtigungen auf Android 13+ an

Android 13 führt eine neue Laufzeitberechtigung zum Anzeigen von Benachrichtigungen ein. Dies betrifft alle Apps, die auf Android 13 oder höher ausgeführt werden und FCM-Benachrichtigungen verwenden.

Standardmäßig enthält das FCM SDK (Version 23.0.6 oder höher) die im Manifest definierte POST_NOTIFICATIONS Berechtigung. Ihre App muss jedoch auch die Laufzeitversion dieser Berechtigung über die Konstante android.permission.POST_NOTIFICATIONS . Ihre App darf keine Benachrichtigungen anzeigen, bis der Benutzer diese Berechtigung erteilt hat.

So fordern Sie die neue Laufzeitberechtigung an:

Java

private void askNotificationPermission() {
    if (ContextCompat.checkSelfPermission(this, Manifest.permission.POST_NOTIFICATIONS) ==
            PackageManager.PERMISSION_GRANTED) {
        // FCM SDK (and your app) can post notifications.
    } else if (shouldShowRequestPermissionRationale(Manifest.permission.POST_NOTIFICATIONS)) {
        // TODO: display an educational UI explaining to the user the features that will be enabled
        //       by them granting the POST_NOTIFICATION permission. This UI should provide the user
        //       "OK" and "No thanks" buttons. If the user selects "OK," directly request the permission.
        //       If the user selects "No thanks," allow the user to continue without notifications.
    } else {
        // Directly ask for the permission
        requestPermissions(new String[] { Manifest.permission.POST_NOTIFICATIONS }, NOTIFICATION_REQUEST_CODE);
    }
}

Kotlin+KTX

private fun askNotificationPermission() {
    if (ContextCompat.checkSelfPermission(this, Manifest.permission.POST_NOTIFICATIONS) ==
        PackageManager.PERMISSION_GRANTED
    ) {
        // FCM SDK (and your app) can post notifications.
    } else if (shouldShowRequestPermissionRationale(Manifest.permission.POST_NOTIFICATIONS)) {
        // TODO: display an educational UI explaining to the user the features that will be enabled
        //       by them granting the POST_NOTIFICATION permission. This UI should provide the user
        //       "OK" and "No thanks" buttons. If the user selects "OK," directly request the permission.
        //       If the user selects "No thanks," allow the user to continue without notifications.
    } else {
        // Directly ask for the permission
        requestPermissions(arrayOf(Manifest.permission.POST_NOTIFICATIONS), NOTIFICATION_REQUEST_CODE)
    }
}

Im Allgemeinen sollten Sie eine Benutzeroberfläche anzeigen, die dem Benutzer die Funktionen erklärt, die aktiviert werden, wenn er der App Berechtigungen zum Posten von Benachrichtigungen erteilt. Diese Benutzeroberfläche sollte dem Benutzer Optionen zum Zustimmen oder Ablehnen bieten, wie z. B. die Schaltflächen „OK“ und „ Nein, danke “. Wenn der Benutzer OK auswählt, fordern Sie die Berechtigung direkt an. Wenn der Benutzer Nein danke auswählt, erlauben Sie dem Benutzer, ohne Benachrichtigungen fortzufahren.

Java

@Override
public void onRequestPermissionsResult(int requestCode, String[] permissions,
                                       int[] grantResults) {
    super.onRequestPermissionsResult(requestCode, permissions, grantResults);
    switch (requestCode) {
        case NOTIFICATION_REQUEST_CODE:
            // If request is cancelled, the result arrays are empty.
            if (grantResults.length > 0 &&
                    grantResults[0] == PackageManager.PERMISSION_GRANTED) {
                // FCM SDK (and your app) can post notifications.
            } else {
                // TODO: Inform user that that your app will not show notifications.
            }
            return;
    }
}

Kotlin+KTX

override fun onRequestPermissionsResult(requestCode: Int, permissions: Array<out String>, grantResults: IntArray) {
    super.onRequestPermissionsResult(requestCode, permissions, grantResults)
    when (requestCode) {
        NOTIFICATION_REQUEST_CODE -> {
            // If request is cancelled, the result arrays are empty.
            if (grantResults.isNotEmpty() && grantResults[0] == PackageManager.PERMISSION_GRANTED) {
                // FCM SDK (and your app) can post notifications.
            } else {
                // TODO: Inform user that that your app will not show notifications.
            }
            return
        }
    }
}

Weitere Best Practices dazu, wann Ihre App die POST_NOTIFICATIONS vom Benutzer anfordern sollte, finden Sie unter Laufzeitberechtigung für Benachrichtigungen .

Benachrichtigungsberechtigungen für Apps, die auf Android 12L (API-Ebene 32) oder niedriger abzielen

Android fragt den Benutzer automatisch um Erlaubnis, wenn Ihre App zum ersten Mal einen Benachrichtigungskanal erstellt, solange sich die App im Vordergrund befindet. Es gibt jedoch wichtige Vorbehalte bezüglich des Zeitpunkts der Kanalerstellung und der Genehmigungsanfragen:

  • Wenn Ihre App ihren ersten Benachrichtigungskanal erstellt, wenn sie im Hintergrund ausgeführt wird (was das FCM-SDK beim Empfang einer FCM-Benachrichtigung tut), lässt Android die Anzeige der Benachrichtigung nicht zu und fordert den Benutzer erst beim nächsten Mal zur Benachrichtigungsberechtigung auf wann Ihre App geöffnet wird. Das bedeutet, dass alle Benachrichtigungen, die Sie erhalten, bevor Ihre App geöffnet wird und der Benutzer die Berechtigung akzeptiert, verloren gehen .
  • Wir empfehlen Ihnen dringend, Ihre App auf Android 13+ zu aktualisieren, um die Vorteile der APIs der Plattform zu nutzen, um eine Berechtigung anzufordern. Wenn dies nicht möglich ist, sollte Ihre App Benachrichtigungskanäle erstellen, bevor Sie Benachrichtigungen an die App senden, um den Benachrichtigungsberechtigungsdialog auszulösen und sicherzustellen, dass keine Benachrichtigungen verloren gehen. Weitere Informationen finden Sie unter Best Practices für Benachrichtigungsberechtigungen .

Optional: POST_NOTIFICATIONS Berechtigung entfernen

Standardmäßig enthält das FCM SDK die POST_NOTIFICATIONS Berechtigung. Wenn Ihre App keine Benachrichtigungsmeldungen verwendet (ob durch FCM-Benachrichtigungen, über ein anderes SDK oder direkt von Ihrer App gepostet) und Sie nicht möchten, dass Ihre App die Berechtigung enthält, können Sie sie mithilfe der Markierung zum Entfernen der Manifestzusammenführung remove . Denken Sie daran, dass das Entfernen dieser Berechtigung die Anzeige aller Benachrichtigungen verhindert, nicht nur der FCM-Benachrichtigungen. Fügen Sie der Manifestdatei Ihrer App Folgendes hinzu:

<uses-permission android:name="android.permission.POST_NOTIFICATIONS" tools:node="remove"/>

Greifen Sie auf das Geräteregistrierungstoken zu

Beim ersten Start Ihrer App generiert das FCM SDK ein Registrierungstoken für die Client-App-Instanz. Wenn Sie auf einzelne Geräte abzielen oder Gerätegruppen erstellen möchten, müssen Sie auf dieses Token zugreifen, indem Sie FirebaseMessagingService erweitern und onNewToken überschreiben.

In diesem Abschnitt wird beschrieben, wie Sie das Token abrufen und Änderungen am Token überwachen. Da das Token nach dem ersten Start rotiert werden kann, wird dringend empfohlen, das neueste aktualisierte Registrierungstoken abzurufen.

Das Registrierungstoken kann sich ändern, wenn:

  • Die App wird auf einem neuen Gerät wiederhergestellt
  • Der Benutzer deinstalliert/installiert die App neu
  • Der Benutzer löscht App-Daten.

Rufen Sie das aktuelle Registrierungstoken ab

Wenn Sie das aktuelle Token abrufen müssen, rufen Sie FirebaseMessaging.getInstance().getToken() :

Java

FirebaseMessaging.getInstance().getToken()
    .addOnCompleteListener(new OnCompleteListener<String>() {
        @Override
        public void onComplete(@NonNull Task<String> task) {
          if (!task.isSuccessful()) {
            Log.w(TAG, "Fetching FCM registration token failed", task.getException());
            return;
          }

          // Get new FCM registration token
          String token = task.getResult();

          // Log and toast
          String msg = getString(R.string.msg_token_fmt, token);
          Log.d(TAG, msg);
          Toast.makeText(MainActivity.this, msg, Toast.LENGTH_SHORT).show();
        }
    });

Kotlin+KTX

FirebaseMessaging.getInstance().token.addOnCompleteListener(OnCompleteListener { task ->
    if (!task.isSuccessful) {
        Log.w(TAG, "Fetching FCM registration token failed", task.exception)
        return@OnCompleteListener
    }

    // Get new FCM registration token
    val token = task.result

    // Log and toast
    val msg = getString(R.string.msg_token_fmt, token)
    Log.d(TAG, msg)
    Toast.makeText(baseContext, msg, Toast.LENGTH_SHORT).show()
})

Überwachen Sie die Token-Generierung

Der onNewToken Callback wird immer dann ausgelöst, wenn ein neues Token generiert wird.

Java

/**
 * There are two scenarios when onNewToken is called:
 * 1) When a new token is generated on initial app startup
 * 2) Whenever an existing token is changed
 * Under #2, there are three scenarios when the existing token is changed:
 * A) App is restored to a new device
 * B) User uninstalls/reinstalls the app
 * C) User clears app data
 */
@Override
public void onNewToken(@NonNull String token) {
    Log.d(TAG, "Refreshed token: " + token);

    // If you want to send messages to this application instance or
    // manage this apps subscriptions on the server side, send the
    // FCM registration token to your app server.
    sendRegistrationToServer(token);
}

Kotlin+KTX

/**
 * Called if the FCM registration token is updated. This may occur if the security of
 * the previous token had been compromised. Note that this is called when the
 * FCM registration token is initially generated so this is where you would retrieve the token.
 */
override fun onNewToken(token: String) {
    Log.d(TAG, "Refreshed token: $token")

    // If you want to send messages to this application instance or
    // manage this apps subscriptions on the server side, send the
    // FCM registration token to your app server.
    sendRegistrationToServer(token)
}

Nachdem Sie das Token erhalten haben, können Sie es an Ihren App-Server senden und mit Ihrer bevorzugten Methode speichern.

Suchen Sie nach Google Play-Diensten

Apps, die auf das Play Services SDK angewiesen sind, sollten das Gerät immer auf ein kompatibles APK für Google Play-Dienste überprüfen, bevor sie auf die Funktionen der Google Play-Dienste zugreifen. Es wird empfohlen, dies an zwei Stellen zu tun: in der onCreate() -Methode der Hauptaktivität und in ihrer onResume() Methode. Der Check in onCreate() stellt sicher, dass die App ohne erfolgreiche Prüfung nicht verwendet werden kann. Die Überprüfung in onResume() stellt sicher, dass die Überprüfung dennoch durchgeführt wird, wenn der Benutzer auf andere Weise zur laufenden App zurückkehrt, z. B. über die Zurück-Schaltfläche.

Wenn das Gerät nicht über eine kompatible Version der Google Play-Dienste verfügt, kann Ihre App GoogleApiAvailability.makeGooglePlayServicesAvailable() aufrufen, um Benutzern das Herunterladen von Google Play-Diensten aus dem Play Store zu ermöglichen.

Automatische Initialisierung verhindern

Wenn ein FCM-Registrierungstoken generiert wird, lädt die Bibliothek die Kennung und die Konfigurationsdaten in Firebase hoch. Wenn Sie die automatische Tokengenerierung lieber verhindern möchten, deaktivieren Sie die Analytics-Erfassung und die automatische FCM-Initialisierung (Sie müssen beide deaktivieren), indem Sie diese Metadatenwerte zu Ihrer AndroidManifest.xml :

<meta-data
    android:name="firebase_messaging_auto_init_enabled"
    android:value="false" />
<meta-data
    android:name="firebase_analytics_collection_enabled"
    android:value="false" />

Um die automatische FCM-Initialisierung wieder zu aktivieren, führen Sie einen Laufzeitaufruf durch:

Java

FirebaseMessaging.getInstance().setAutoInitEnabled(true);

Kotlin+KTX

Firebase.messaging.isAutoInitEnabled = true

Um die Analytics-Erfassung wieder zu aktivieren, rufen Sie die setAnalyticsCollectionEnabled() Methode der FirebaseAnalytics -Klasse auf. Zum Beispiel:

setAnalyticsCollectionEnabled(true);

Diese Werte bleiben nach dem Festlegen über App-Neustarts hinweg bestehen.

Nächste Schritte

Nachdem die Client-App eingerichtet wurde, können Sie mit dem Senden von Downstream-Nachrichten mit dem Benachrichtigungs-Composer beginnen. Diese Funktionalität wird im Quickstart-Beispiel demonstriert, das Sie herunterladen, ausführen und überprüfen können.

Um Ihrer App ein anderes, erweitertes Verhalten hinzuzufügen, können Sie einen Absichtsfilter deklarieren und eine Aktivität implementieren, um auf eingehende Nachrichten zu reagieren. Einzelheiten finden Sie in den Anleitungen zum Senden von Nachrichten von einem App-Server:

Beachten Sie, dass Sie zur Nutzung dieser Funktionen eine Serverimplementierung und die Serverprotokolle (HTTP oder XMPP) oder eine Implementierung des Admin SDK benötigen.