Erste Schritte mit Firebase Cloud Messaging in Web-Apps

Plattform auswählen: iOS+ Android Web Flutter Unity C++


In diesem Leitfaden wird beschrieben, wie Sie Firebase Cloud Messaging in Ihren Webclient-Apps einrichten, damit Sie Nachrichten zuverlässig senden können.

Mit der FCM JavaScript API können Sie Benachrichtigungen in Web-Apps empfangen, die in Browsern ausgeführt werden, die die Push API unterstützen. Dazu gehören die in dieser Unterstützungsmatrix aufgeführten Browserversionen und Chrome-Erweiterungen, die die Push API verwenden.

Das FCM SDK wird nur auf Seiten unterstützt, die über HTTPS bereitgestellt werden. Das liegt daran, dass Service Worker verwendet werden, die nur auf HTTPS-Websites verfügbar sind. Wenn Sie einen Anbieter benötigen, Firebase App Hosting ist empfehlenswert. Dort gibt es ein kostenloses Abo für HTTPS-Hosting auf Ihrer eigenen Domain.

Wenn Sie die FCM JavaScript API verwenden möchten, müssen Sie Firebase Ihrer Web-App hinzufügen und Logik für den Zugriff auf Firebase-Installations-IDs hinzufügen. So können Sie den Empfänger für Ihre Benachrichtigungen festlegen.

FCM SDK hinzufügen und initialisieren

  1. Falls noch nicht geschehen, installieren Sie das Firebase JS SDK und initialisieren Sie Firebase.

  2. Fügen Sie das Firebase Cloud Messaging JS SDK hinzu und initialisieren Sie Firebase Cloud Messaging:

Web 

import { initializeApp } from "firebase/app";
import { getMessaging } from "firebase/messaging";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
const app = initializeApp(firebaseConfig);


// Initialize Firebase Cloud Messaging and get a reference to the service
const messaging = getMessaging(app);

Web 

import firebase from "firebase/compat/app";
import "firebase/compat/messaging";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
firebase.initializeApp(firebaseConfig);


// Initialize Firebase Cloud Messaging and get a reference to the service
const messaging = firebase.messaging();

Wenn Sie FCM für das Web verwenden und ein Upgrade auf SDK 6.7.0 oder höher durchführen möchten, müssen Sie die FCM Registration API für Ihr Projekt in der Google Cloud-Konsole aktivieren. Achten Sie beim Aktivieren der API darauf, dass Sie mit demselben Google-Konto in der Google Cloud-Konsole angemeldet sind, das Sie für Firebase verwenden, und dass Sie das richtige Projekt auswählen. Bei neuen Projekten, in denen das FCM SDK hinzugefügt wird, ist diese API standardmäßig aktiviert.

Webanmeldedaten mit FCM konfigurieren

Die FCM-Weboberfläche verwendet Webanmeldedaten namens „Voluntary Application Server Identification“ oder VAPID-Schlüssel, um Sendeanfragen an unterstützte Web-Push-Dienste zu autorisieren. Wenn Sie Ihre App für Push-Benachrichtigungen registrieren möchten, müssen Sie ein Schlüsselpaar mit Ihrem Firebase-Projekt verknüpfen. Sie können entweder ein neues Schlüsselpaar generieren oder Ihr vorhandenes Schlüsselpaar über die Firebase-Konsole importieren.

Neues Schlüsselpaar generieren

  1. Rufen Sie in der Firebase Console Einstellungen > Allgemein auf. Klicken Sie dann auf den Tab Cloud Messaging.

  2. Rufen Sie den Abschnitt Webkonfiguration auf.

  3. Klicken Sie auf dem Tab Web-Push-Zertifikate auf Schlüsselpaar generieren.

    In der Console wird eine Benachrichtigung angezeigt, dass das Schlüsselpaar generiert wurde, sowie der öffentliche Schlüsselstring und das Datum, an dem der Schlüssel hinzugefügt wurde.

Vorhandenes Schlüsselpaar importieren

Wenn Sie bereits ein Schlüsselpaar haben, das Sie mit Ihrer Webanwendung verwenden, können Sie es in FCM importieren, damit Sie über FCM-APIs auf Ihre vorhandenen Webanwendungsinstanzen zugreifen können. Zum Importieren von Schlüsseln benötigen Sie Zugriff auf das Firebase-Projekt auf Inhaberebene. Importieren Sie Ihren vorhandenen öffentlichen und privaten Schlüssel in Base64-URL-sicherer codierter Form:

  1. Rufen Sie in der Firebase Console Einstellungen > Allgemein auf. Klicken Sie dann auf den Tab Cloud Messaging.

  2. Rufen Sie den Abschnitt Webkonfiguration auf.

  3. Suchen Sie auf dem Tab Web-Push-Zertifikate nach dem Linktext Vorhandenes Schlüsselpaar importieren und wählen Sie ihn aus.

  4. Geben Sie im Dialogfeld Schlüsselpaar importieren Ihren öffentlichen und privaten Schlüssel in die entsprechenden Felder ein und klicken Sie auf Importieren.

    In der Console werden der öffentliche Schlüsselstring und das Datum angezeigt, an dem er hinzugefügt wurde.

Eine Anleitung zum Hinzufügen des Schlüssels zu Ihrer App finden Sie unter Webanmeldedaten in Ihrer App konfigurieren. Weitere Informationen zum Format der Schlüssel und zum Generieren von Schlüsseln finden Sie unter Anwendungsserverschlüssel.

Webanmeldedaten in Ihrer App konfigurieren

Mit der Methode register(): Promise<void> kann FCM das VAPID-Schlüssel-Anmeldedaten verwenden, wenn Nachrichtenanfragen an verschiedene Push-Dienste gesendet werden. Fügen Sie den Schlüssel, den Sie gemäß der Anleitung unter Web-Anmeldedaten mit FCM konfigurieren generiert oder importiert haben, in Ihren Code ein, nachdem das Messaging-Objekt abgerufen wurde:

import { getMessaging, register } from "firebase/messaging";

const messaging = getMessaging();
// Add the public key generated from the Firebase console here.
register(messaging, {vapidKey: "BKagOny0KF_2pCJQ3m....moL0ewzQ8rZu"});

Berechtigung zum Senden von Benachrichtigungen anfordern und Service Worker konfigurieren

Wenn Sie eine App-Instanz mit FCM ausrichten möchten, fordern Sie zuerst mit Notification.requestPermission() Benachrichtigungsberechtigungen vom Nutzer an. Wenn die Funktion wie gezeigt aufgerufen wird, wird der Berechtigungsstatus zurückgegeben, sofern die Berechtigung erteilt wurde:

function requestPermission() {
  console.log('Requesting permission...');
  Notification.requestPermission().then((permission) => {
    if (permission === 'granted') {
      console.log('Notification permission granted.');
    }
  });
}

Für FCM ist eine firebase-messaging-sw.js-Datei erforderlich. Wenn Sie noch keine firebase-messaging-sw.js-Datei haben, erstellen Sie eine leere Datei mit diesem Namen und legen Sie sie vor der Registrierung im Stammverzeichnis Ihrer Domain ab. Sie können der Datei später im Rahmen der Client-Einrichtung aussagekräftige Inhalte hinzufügen.

Auf die Firebase-Installations-ID zugreifen

So registrieren Sie die App-Instanz und rufen die Firebase-Installations-ID (FID) für das Ausrichten von Nachrichten ab: 

import { getMessaging, onRegistered, register } from "firebase/messaging";

const messaging = getMessaging();

// 1. Implement callback to receive the Firebase installation ID upon registration.
// This is triggered every time a manual register() finishes, a FID change
// is detected, or a pushsubscriptionchange event is fired.
onRegistered(messaging, (installationId) => {
  console.log('Registered installation ID:', installationId);

  // Send the Firebase Installation ID to your app server and update the UI if needed.
  sendRegistrationToServer(installationId);
});

// 2. You can also manually trigger registration (recommended on app startup)
register(messaging, {
  vapidKey: '<YOUR_PUBLIC_VAPID_KEY_HERE>'
}).then(() => {
  // Success! The Firebase Installation ID can be used to target messages to this app
  // instance and will be delivered asynchronously to your onRegistered() callback.
}).catch((err) => {
  console.error('An error occurred while registering', err);
});

Der Callback onRegistered wird in drei Fällen ausgelöst:

  1. Jedes Mal, wenn ein manueller register()-Anruf beendet wird.
  2. Es wurde eine Änderung der Firebase-Installations-ID erkannt.
  3. Ein pushsubscriptionchange-Ereignis wird ausgelöst.

Nachdem Sie die Firebase-Installations-ID erhalten haben, senden Sie sie an Ihren App-Server und speichern Sie sie mit der von Ihnen bevorzugten Methode.

Auf das Registrierungstoken zugreifen (eingestellt)

So rufen Sie das aktuelle Token ab:

Web

import { getMessaging, getToken } from "firebase/messaging";

// Get registration token. Initially this makes a network call, once retrieved
// subsequent calls to getToken will return from cache.
const messaging = getMessaging();
getToken(messaging, { vapidKey: '<YOUR_PUBLIC_VAPID_KEY_HERE>' }).then((currentToken) => {
  if (currentToken) {
    // Send the token to your server and update the UI if necessary
    // ...
  } else {
    // Show permission request UI
    console.log('No registration token available. Request permission to generate one.');
    // ...
  }
}).catch((err) => {
  console.log('An error occurred while retrieving token. ', err);
  // ...
});

Web

// Get registration token. Initially this makes a network call, once retrieved
// subsequent calls to getToken will return from cache.
messaging.getToken({ vapidKey: '<YOUR_PUBLIC_VAPID_KEY_HERE>' }).then((currentToken) => {
  if (currentToken) {
    // Send the token to your server and update the UI if necessary
    // ...
  } else {
    // Show permission request UI
    console.log('No registration token available. Request permission to generate one.');
    // ...
  }
}).catch((err) => {
  console.log('An error occurred while retrieving token. ', err);
  // ...
});

Nachdem Sie das Token erhalten haben, senden Sie es an Ihren App-Server und speichern Sie es mit der gewünschten Methode.

Testbenachrichtigung senden

  1. Installieren Sie die App auf dem Zielgerät und führen Sie sie aus. Auf Apple-Geräten müssen Sie die Anfrage für die Berechtigung zum Empfangen von Remote-Benachrichtigungen annehmen.

  2. Prüfen Sie, ob die App auf dem Gerät im Hintergrund ausgeführt wird.

  3. Rufen Sie in der Firebase Console die Seite DevOps & Engagement > Messaging auf.

  4. Erstellen Sie eine Kampagne.

    • Wenn dies Ihre erste Nachricht ist:

      1. Wählen Sie Erste Kampagne erstellen aus.

      2. Wählen Sie Firebase-Benachrichtigungen und dann Erstellen aus.

    • Wenn Sie bereits Kampagnen erstellt haben:

      1. Wählen Sie auf dem Tab Kampagnen die Option Neue Kampagne aus.

      2. Klicke auf Benachrichtigungen.

  5. Geben Sie den Nachrichtentext ein.

  6. Wählen Sie im rechten Bereich Testnachricht senden aus.

  7. Geben Sie im Feld FCM-Registrierungstoken hinzufügen Ihr Registrierungstoken ein.

  8. Wählen Sie Testen aus.

Nachdem Sie Testen ausgewählt haben, sollte das Zielclientgerät die Benachrichtigung erhalten, während die App im Hintergrund ausgeführt wird.

Nächste Schritte

Nachdem Sie die Einrichtungsschritte abgeschlossen haben, haben Sie folgende Möglichkeiten, mit FCM für Web (JavaScript) fortzufahren: