Cloud Functions für Firebase

1. Übersicht

In diesem Codelab erfahren Sie, wie Sie das Firebase SDK für Google Cloud Functions verwenden, um eine Chat-Web-App zu verbessern, und wie Sie Cloud Functions verwenden, um Benachrichtigungen an Benutzer der Chat-App zu senden.

3b1284f5144b54f6.png

Was Sie lernen werden

  • Erstellen Sie Google Cloud Functions mit dem Firebase SDK.
  • Lösen Sie Cloud Functions basierend auf Auth-, Cloud Storage- und Cloud Firestore-Ereignissen aus.
  • Fügen Sie Ihrer Web-App Firebase Cloud Messaging-Unterstützung hinzu.

Was du brauchen wirst

  • Eine Kreditkarte. Cloud Functions for Firebase erfordert den Firebase Blaze-Plan, was bedeutet, dass Sie die Abrechnung für Ihr Firebase-Projekt mit einer Kreditkarte aktivieren müssen.
  • Der IDE / Text - Editor Ihrer Wahl wie WebStorm , Atom oder Sublime .
  • Ein Terminal zum Ausführen von Shell-Befehlen mit installiertem NodeJS v9.
  • Ein Browser wie Chrome.
  • Der Beispielcode. Siehe dazu den nächsten Schritt.

2. Holen Sie sich den Beispielcode

Klonen Sie die GitHub - Repository über die Befehlszeile:

git clone https://github.com/firebase/friendlychat

Importieren Sie die Starter-App

Öffnen oder importieren Sie mit Ihrer IDE die android_studio_folder.png cloud-functions-start - Verzeichnis aus dem Beispielcode - Verzeichnis. Dieses Verzeichnis enthält den Startcode für das Codelab, das aus einer voll funktionsfähigen Chat-Web-App besteht.

3. Erstellen Sie ein Firebase-Projekt und richten Sie Ihre App ein

Projekt erstellen

In Firebase Console , klicken Sie auf Projekt hinzufügen und nennen es FriendlyChat.

Klicken Sie auf Projekt erstellen.

Upgrade auf den Blaze-Plan

Um Cloud - Funktionen für die Firebase zu verwenden, werden Sie Ihre Firebase Projekt auf die upgade müssen Blaze Fakturierungsplan . Dazu müssen Sie Ihrem Google Cloud-Konto eine Kreditkarte oder ein anderes Abrechnungsinstrument hinzufügen.

Alle Firebase-Projekte, einschließlich derjenigen im Blaze-Plan, haben weiterhin Zugriff auf die kostenlosen Nutzungskontingente für Cloud Functions. Die in diesem Codelab beschriebenen Schritte fallen unter die Nutzungsbeschränkungen des kostenlosen Kontingents. Sie werden jedoch kleine Gebühren (siehe etwa $ 0,03 ) von Cloud Storage , die verwendet wird Ihre Cloud - Funktionen Build Bilder zu hosten.

Wenn Sie keinen Zugang zu einer Kreditkarte oder unbequem sind mit dem Blaze Plan fortfahren, sollten Sie die Verwendung von Firebase Emulator Suite , die es Ihnen erlaubt, Cloud - Funktionen kostenlos auf Ihrem lokalen Rechner zu emulieren.

Aktivieren Sie Google Auth

Damit sich Benutzer in der App anmelden können, verwenden wir die Google-Authentifizierung, die aktiviert sein muss.

In Firebase Console, öffnen Sie die Build - Bereich> Authentication> Log-in Verfahren Registerkarte (oder hier klicken , um dorthin zu gehen). Aktivieren Sie dann die Google - Sign-in Provider und klicken Sie auf Speichern. Dadurch können sich Benutzer mit ihren Google-Konten in der Web-App anmelden.

Auch fühlen sich frei , die öffentlich zugänglichen Namen der App im Friendly Chat zu setzen:

8290061806aacb46.png

Cloud-Speicher aktivieren

Die App verwendet Cloud Storage, um Bilder hochzuladen. Cloud Storage auf Ihrem Firebase - Projekt finden Sie auf den Speicherabschnitt und klicken Sie auf die Schaltfläche Ersten Schritte zu ermöglichen. Gehen Sie dort die Schritte durch, und für den Cloud-Speicherort gibt es einen zu verwendenden Standardwert. Klicken Sie danach auf Fertig.

Fügen Sie eine Web-App hinzu

Fügen Sie in der Firebase Console eine Web-App hinzu. Um dies zu tun, gehen Sie zu Projekteinstellungen und scrollen Sie zum Hinzufügen App. Wählen Sie Web als Plattform und das Kontrollkästchen für die Einrichtung Firebase Hosting, dann registrieren Sie die App und klicken Sie auf Weiter für den Rest der Schritte, schließlich klicken Sie auf Weiter zu trösten.

4. Installieren Sie die Firebase-Befehlszeilenschnittstelle

Mit der Firebase-Befehlszeilenschnittstelle (CLI) können Sie die Web-App lokal bereitstellen und Ihre Web-App und Cloud-Funktionen bereitstellen.

Um die CLI zu installieren oder zu aktualisieren, führen Sie den folgenden npm-Befehl aus:

npm -g install firebase-tools

Um zu überprüfen, ob die CLI korrekt installiert wurde, öffnen Sie eine Konsole und führen Sie Folgendes aus:

firebase --version

Stellen Sie sicher , dass die Version des Firebase CLI ist oben 4.0.0 , so dass sie alle hat die neueste Cloud - Funktionen erforderlichen Funktionen. Wenn nicht, laufen npm install -g firebase-tools zu aktualisieren , wie oben gezeigt.

Autorisieren Sie die Firebase CLI, indem Sie Folgendes ausführen:

firebase login

Stellen Sie sicher , dass Sie in der sind cloud-functions-start - Verzeichnis, dann die Firebase CLI einrichten, um Ihr Firebase - Projekt zu verwenden:

firebase use --add

Wählen Sie als Nächstes Ihre Projekt-ID aus und folgen Sie den Anweisungen. Wenn Sie gefragt werden , können Sie einen beliebigen Alias, wie wählen codelab .

5. Stellen Sie die Web-App bereit und führen Sie sie aus

Nachdem Sie Ihr Projekt importiert und konfiguriert haben, können Sie die Web-App zum ersten Mal ausführen! Öffnen Sie ein Terminal - Fenster, wechseln Sie zum cloud-functions-start - Ordner, und stellen Sie die Web - App auf Firebase Hosting mit:

firebase deploy --except functions

Dies ist die Konsolenausgabe, die Sie sehen sollten:

i deploying database, storage, hosting
✔  database: rules ready to deploy.
i  storage: checking rules for compilation errors...
✔  storage: rules file compiled successfully
i  hosting: preparing ./ directory for upload...
✔  hosting: ./ folder uploaded successfully
✔ storage: rules file compiled successfully
✔ hosting: 8 files uploaded successfully
i starting release process (may take several minutes)...

✔ Deploy complete!

Project Console: https://console.firebase.google.com/project/friendlychat-1234/overview
Hosting URL: https://friendlychat-1234.firebaseapp.com

Öffnen Sie die Web-App

Die letzte Zeile sollte die Hosting - URL angezeigt werden soll . Die Web-App sollte jetzt von dieser URL bereitgestellt werden, die das Format https://<Projekt-ID>.firebaseapp.com haben sollte. Öffne es. Sie sollten die funktionierende Benutzeroberfläche einer Chat-App sehen.

Melden Sie sich in der App unter Verwendung des SIGN-IN MIT GOOGLE - Taste und fühlen sich frei , einige Nachrichten und Post Bilder hinzufügen:

3b1284f5144b54f6.png

Wenn Sie sich zum ersten Mal in einem neuen Browser bei der App anmelden, vergewissern Sie sich, dass Sie Benachrichtigungen zulassen, wenn Sie dazu aufgefordert werden: 8b9d0c66dc36153d.png

Wir müssen Benachrichtigungen zu einem späteren Zeitpunkt aktivieren.

Wenn Sie aus Versehen angeklickt Sperren haben, können Sie diese Einstellung ändern , indem Sie auf den 🔒 Sichere Taste auf der linken Seite der URL in der Chrome Omnibar und die Bar neben Benachrichtigungen Makeln:

e926868b0546ed71.png

Jetzt fügen wir mithilfe des Firebase SDK for Cloud Functions einige Funktionen hinzu.

6. Das Funktionsverzeichnis

Mit Cloud Functions können Sie ganz einfach Code haben, der in der Cloud ausgeführt wird, ohne dass Sie einen Server einrichten müssen. Wir werden durchgehen, wie Funktionen erstellt werden, die auf Firebase Auth-, Cloud Storage- und Firebase Firestore-Datenbankereignisse reagieren. Beginnen wir mit Auth.

Wenn die Firebase SDK für Cloud - Funktionen verwenden, Code - Funktionen werden unter dem Live - functions Verzeichnis (Standard). Ihre Funktionen Code ist auch ein Node.js App und benötigt daher eine package.json , die einige Informationen über Ihre Anwendung und Listen Abhängigkeiten gibt.

Um es einfacher für Sie, haben wir bereits die erstellte functions/index.js Datei , in der Sie den Code gehen. Fühlen Sie sich frei, diese Datei zu überprüfen, bevor Sie fortfahren.

cd functions
ls

Wenn Sie nicht vertraut mit sind Node.js , mehr darüber zu lernen , bevor Sie den Code - Lab fort wäre hilfreich.

Die package.json Datei listet bereits zwei erforderlichen Abhängigkeiten: die Firebase SDK für Cloud - Funktionen und die Firebase Admin SDK . Um sie zu installieren lokal gehen, zu den functions Ordner und starten:

npm install

Lassen Sie uns jetzt einen Blick auf die haben index.js Datei:

index.js

/**
 * Copyright 2017 Google Inc. All Rights Reserved.
 * ...
 */

// TODO(DEVELOPER): Import the Cloud Functions for Firebase and the Firebase Admin modules here.

// TODO(DEVELOPER): Write the addWelcomeMessage Function here.

// TODO(DEVELOPER): Write the blurImages Function here.

// TODO(DEVELOPER): Write the sendNotification Function here.

Wir importieren die erforderlichen Module und schreiben dann drei Funktionen anstelle der TODOs. Beginnen wir mit dem Importieren der erforderlichen Node-Module.

7. Importieren Sie die Module Cloud Functions und Firebase Admin

Zwei Module werden während dieses Codelab erforderlich: firebase-functions ermöglichen das Schreiben Cloud - Funktionen Trigger und Protokolle während firebase-admin ermöglicht mit der Firebase - Plattform auf einem Server mit Admin - Zugang Aktionen zu tun, wie das Schreiben Cloud Firestor oder das Versenden von FCM - Benachrichtigungen.

In der index.js Datei, ersetzen Sie den ersten TODO mit folgendem:

index.js

/**
 * Copyright 2017 Google Inc. All Rights Reserved.
 * ...
 */

// Import the Firebase SDK for Google Cloud Functions.
const functions = require('firebase-functions');
// Import and initialize the Firebase Admin SDK.
const admin = require('firebase-admin');
admin.initializeApp();

// TODO(DEVELOPER): Write the addWelcomeMessage Function here.

// TODO(DEVELOPER): Write the blurImages Function here.

// TODO(DEVELOPER): Write the sendNotification Function here.

Das Firebase Admin SDK kann automatisch , wenn auf eine Cloud - Funktionen Umwelt oder andere Google Cloud Platform - Container, und dies geschieht im Einsatz konfiguriert werden , wenn wir nennen admin.initializeApp() ohne Argumente.

Lassen Sie uns nun eine Funktion hinzufügen, die ausgeführt wird, wenn sich ein Benutzer zum ersten Mal in der Chat-App anmeldet, und wir fügen eine Chatnachricht hinzu, um den Benutzer willkommen zu heißen.

8. Neue Benutzer willkommen heißen

Struktur von Chat-Nachrichten

Im FriendlyChat-Chat-Feed gepostete Nachrichten werden in Cloud Firestore gespeichert. Schauen wir uns die Datenstruktur an, die wir für eine Nachricht verwenden. Posten Sie dazu eine neue Nachricht im Chat mit der Aufschrift „Hello World“:

11f5a676fbb1a69a.png

Dies sollte folgendermaßen aussehen:

fe6d1c020d0744cf.png

In Firebase - Konsole klicken Sie auf Firestore - Datenbank unter dem Build - Abschnitt. Sie sollten die Nachrichtensammlung und ein Dokument mit der von Ihnen geschriebenen Nachricht sehen:

442c9c10b5e2b245.png

Wie Sie sehen können, werden Chat - Nachrichten in Cloud - Firestor als Dokument mit gespeicherten name , profilePicUrl , text und timestamp Attributen hinzugefügt , um die messages - Sammlung.

Begrüßungsnachrichten hinzufügen

Die erste Cloud - Funktion fügt eine Nachricht , die neuen Benutzer mit dem IRC begrüßt. Dazu können wir den Trigger verwenden functions.auth().onCreate , die die Funktion eines Benutzer-in zum ersten Mal in der Firebase App jedes Mal ausgeführt wird . Fügen Sie die addWelcomeMessages Funktion in Ihre index.js Datei:

index.js

// Adds a message that welcomes new users into the chat.
exports.addWelcomeMessages = functions.auth.user().onCreate(async (user) => {
  functions.logger.log('A new user signed in for the first time.');
  const fullName = user.displayName || 'Anonymous';

  // Saves the new welcome message into the database
  // which then displays it in the FriendlyChat clients.
  await admin.firestore().collection('messages').add({
    name: 'Firebase Bot',
    profilePicUrl: '/images/firebase-logo.png', // Firebase logo
    text: `${fullName} signed in for the first time! Welcome!`,
    timestamp: admin.firestore.FieldValue.serverTimestamp(),
  });
  functions.logger.log('Welcome message written to database.');
});

Addiert man diese Funktion auf die speziellen exports Objekt ist der Weg der Knoten machen die Funktion zugänglich außerhalb der aktuellen Datei und ist für Cloud - Funktionen erforderlich.

In der obigen Funktion fügen wir der Liste der Chatnachrichten eine neue Willkommensnachricht hinzu, die von „Firebase Bot“ gepostet wurde. Wir tun dies , indem die Verwendung von add - Methode auf der messages - Sammlung in Cloud - Firestor, das ist , wo die Meldungen des Chat gespeichert sind.

Da dies ein asynchroner Betrieb ist, müssen wir die Rückkehr Versprechen anzeigt , wann Wolke Firestor fertig geschrieben haben , so dass die Cloud - Funktionen nicht zu früh ausführen.

Cloud-Funktionen bereitstellen

Cloud Functions sind erst aktiv, nachdem Sie sie bereitgestellt haben. Führen Sie dazu dies in der Befehlszeile aus:

firebase deploy --only functions

Dies ist die Konsolenausgabe, die Sie sehen sollten:

i  deploying functions
i  functions: ensuring necessary APIs are enabled...
⚠  functions: missing necessary APIs. Enabling now...
i  env: ensuring necessary APIs are enabled...
⚠  env: missing necessary APIs. Enabling now...
i  functions: waiting for APIs to activate...
i  env: waiting for APIs to activate...
✔  env: all necessary APIs are enabled
✔  functions: all necessary APIs are enabled
i  functions: preparing functions directory for uploading...
i  functions: packaged functions (X.XX KB) for uploading
✔  functions: functions folder uploaded successfully
i  starting release process (may take several minutes)...
i  functions: creating function addWelcomeMessages...
✔  functions[addWelcomeMessages]: Successful create operation. 
✔  functions: all functions deployed successfully!

✔  Deploy complete!

Project Console: https://console.firebase.google.com/project/friendlypchat-1234/overview

Testen Sie die Funktion

Sobald die Funktion erfolgreich bereitgestellt wurde, benötigen Sie einen Benutzer, der sich zum ersten Mal anmeldet.

  1. Öffnen Sie Ihre App in Ihrem Browser die Hosting - URL (in Form von https://<project-id>.firebaseapp.com ).
  2. Mit einem neuen Benutzer, melden Sie sich zum ersten Mal in der App auf die Schaltfläche Anmelden verwenden.
  • Wenn Sie bereits in die unterzeichnet haben, App Sie öffnen können Firebase Console - Authentifizierung und Ihr Konto aus der Liste der Benutzer löschen. Melden Sie sich dann erneut an.

262535d1b1223c65.png

  1. Nachdem Sie sich angemeldet haben, sollte automatisch eine Willkommensnachricht angezeigt werden:

1c70e0d64b23525b.png

9. Bildmoderation

Benutzer können alle Arten von Bildern in den Chat hochladen, und es ist immer wichtig, anstößige Bilder zu moderieren, insbesondere auf öffentlichen sozialen Plattformen. In FriendlyChat, die Bilder , die mit dem IRC veröffentlicht werden, werden in gespeicherte Google Cloud Storage .

Mit Cloud - Funktionen, können Sie neues Bild - Uploads mit der Erkennung functions.storage().onFinalize Auslöser. Dies wird jedes Mal ausgeführt, wenn eine neue Datei in Cloud Storage hochgeladen oder geändert wird.

Um Bilder zu moderieren, durchlaufen wir den folgenden Prozess:

  1. Überprüfen Sie, ob das Bild als Erwachsener oder heftiger mit der gekennzeichnet ist Cloud - Vision - API .
  2. Wenn das Image gekennzeichnet wurde, laden Sie es auf die ausgeführte Functions-Instanz herunter.
  3. Blur das Bild unter Verwendung von ImageMagick .
  4. Laden Sie das unscharfe Bild in Cloud Storage hoch.

Aktivieren Sie die Cloud Vision-API

Da wir in dieser Funktion die Google Cloud Vision-API verwenden, müssen Sie die API in Ihrem Firebase-Projekt aktivieren. Folgen Sie diesem Link , dann wählen Sie Ihr Projekt Firebase und aktivieren Sie die API:

5c77fee51ec5de49.png

Abhängigkeiten installieren

Um moderate Bilder werden wir die Google Cloud Vision - Client - Bibliothek für Node.js, verwenden Sie @ google-Wolke / Vision , Bilder durch die Cloud - Vision - API ausführen , um unangebrachte Bilder zu erkennen.

Um dieses Paket in Ihre App Cloud - Funktionen zu installieren, führt nach der npm install --save Befehl. Stellen Sie sicher , dass Sie dies tun aus dem functions - Verzeichnis.

npm install --save @google-cloud/vision@2.4.0

Dadurch wird das Paket lokal und fügen Sie sie als erklärte Abhängigkeit in Ihrer installiert package.json Datei.

Abhängigkeiten importieren und konfigurieren

So importieren Sie die Abhängigkeiten , die installiert wurden und einige Node.js Kernmodule ( path , os und fs ) , dass wir in diesem Abschnitt benötigen, fügen Sie die folgenden Zeilen an der Spitze Ihrer index.js - Datei:

index.js

const Vision = require('@google-cloud/vision');
const vision = new Vision.ImageAnnotatorClient();
const {promisify} = require('util');
const exec = promisify(require('child_process').exec);

const path = require('path');
const os = require('os');
const fs = require('fs');

Da Ihre Funktion in einer Google Cloud-Umgebung ausgeführt wird, müssen die Cloud Storage- und Cloud Vision-Bibliotheken nicht konfiguriert werden: Sie werden automatisch für die Verwendung Ihres Projekts konfiguriert.

Unangemessene Bilder erkennen

Sie finden unter Verwendung functions.storage.onChange Cloud - Funktionen auslösen, die Ihren Code ausgeführt wird , sobald eine Datei oder einen Ordner in einer Cloud Storage Eimer erstellt oder geändert wird. Fügen Sie die blurOffensiveImages Funktion in Ihre index.js Datei:

index.js

// Checks if uploaded images are flagged as Adult or Violence and if so blurs them.
exports.blurOffensiveImages = functions.runWith({memory: '2GB'}).storage.object().onFinalize(
    async (object) => {
      const imageUri = `gs://${object.bucket}/${object.name}`;
      // Check the image content using the Cloud Vision API.
      const batchAnnotateImagesResponse = await vision.safeSearchDetection(imageUri);
      const safeSearchResult = batchAnnotateImagesResponse[0].safeSearchAnnotation;
      const Likelihood = Vision.protos.google.cloud.vision.v1.Likelihood;
      if (Likelihood[safeSearchResult.adult] >= Likelihood.LIKELY ||
          Likelihood[safeSearchResult.violence] >= Likelihood.LIKELY) {
        functions.logger.log('The image', object.name, 'has been detected as inappropriate.');
        return blurImage(object.name);
      }
      functions.logger.log('The image', object.name, 'has been detected as OK.');
    });

Beachten Sie, dass wir eine Konfiguration der Cloud Functions-Instanz hinzugefügt haben, die die Funktion ausführt. Mit .runWith({memory: '2GB'}) , sind anfordernden wir , dass die Instanz 2 GB Speicher wird statt dem Standard, da diese Funktion speicherintensiv ist.

Wenn die Funktion ausgelöst wird, wird das Bild durch die Cloud Vision API geleitet, um zu erkennen, ob es als nicht jugendfrei oder gewalttätig gekennzeichnet ist. Wenn das Bild als unangemessen auf der Grundlage dieser Kriterien festgestellt wird, wir unscharfe Bilder, die in der getan wird blurImage Funktion wie wir gleich sehen werden.

Verwischen des Bildes

Fügen Sie die folgende blurImage Funktion in Ihrer index.js - Datei:

index.js

// Blurs the given image located in the given bucket using ImageMagick.
async function blurImage(filePath) {
  const tempLocalFile = path.join(os.tmpdir(), path.basename(filePath));
  const messageId = filePath.split(path.sep)[1];
  const bucket = admin.storage().bucket();

  // Download file from bucket.
  await bucket.file(filePath).download({destination: tempLocalFile});
  functions.logger.log('Image has been downloaded to', tempLocalFile);
  // Blur the image using ImageMagick.
  await exec(`convert "${tempLocalFile}" -channel RGBA -blur 0x24 "${tempLocalFile}"`);
  functions.logger.log('Image has been blurred');
  // Uploading the Blurred image back into the bucket.
  await bucket.upload(tempLocalFile, {destination: filePath});
  functions.logger.log('Blurred image has been uploaded to', filePath);
  // Deleting the local file to free up disk space.
  fs.unlinkSync(tempLocalFile);
  functions.logger.log('Deleted local file.');
  // Indicate that the message has been moderated.
  await admin.firestore().collection('messages').doc(messageId).update({moderated: true});
  functions.logger.log('Marked the image as moderated in the database.');
}

In der obigen Funktion wird die Bildbinärdatei von Cloud Storage heruntergeladen. Das Bild wird dann unscharf ImageMagicks mit convert Werkzeug und die unscharfe Version ist neu hochgeladen auf dem Storage Eimer. Als Nächstes löschen wir die Datei auf der Cloud Functions-Instanz, um etwas Speicherplatz freizugeben, und zwar, weil dieselbe Cloud Functions-Instanz wiederverwendet werden kann und wenn Dateien nicht bereinigt werden, könnte ihr Speicherplatz ausgehen. Schließlich fügen wir der Chat-Nachricht einen booleschen Wert hinzu, der angibt, dass das Bild moderiert wurde, und dies löst eine Aktualisierung der Nachricht auf dem Client aus.

Stellen Sie die Funktion bereit

Die Funktion ist erst aktiv, nachdem Sie sie bereitgestellt haben. Auf der Kommandozeile ausführen firebase deploy --only functions :

firebase deploy --only functions

Dies ist die Konsolenausgabe, die Sie sehen sollten:

i  deploying functions
i  functions: ensuring necessary APIs are enabled...
✔  functions: all necessary APIs are enabled
i  functions: preparing functions directory for uploading...
i  functions: packaged functions (X.XX KB) for uploading
✔  functions: functions folder uploaded successfully
i  starting release process (may take several minutes)...
i  functions: updating function addWelcomeMessages...
i  functions: creating function blurOffensiveImages...
✔  functions[addWelcomeMessages]: Successful update operation.
✔  functions[blurOffensiveImages]: Successful create operation.
✔  functions: all functions deployed successfully!

✔  Deploy complete!

Project Console: https://console.firebase.google.com/project/friendlychat-1234/overview

Testen Sie die Funktion

Nach erfolgreicher Bereitstellung der Funktion:

  1. Öffnen Sie Ihre App in Ihrem Browser die Hosting - URL (in Form von https://<project-id>.firebaseapp.com ).
  2. Sobald Sie sich bei der App angemeldet haben, laden Sie ein Bild hoch: 4db9fdab56703e4a.png
  3. Wählen Sie Ihre beste Offensive Bild hochladen (oder Sie können diese verwenden , Fleisch zu essen Zombie !) Und nach wenigen Augenblicken, sollten Sie Ihren Beitrag Refresh mit einem unscharfen Version des Bildes sehen: 83dd904fbaf97d2b.png

10. Benachrichtigungen über neue Nachrichten

In diesem Abschnitt fügen Sie eine Cloud-Funktion hinzu, die Benachrichtigungen an die Teilnehmer des Chats sendet, wenn eine neue Nachricht gepostet wird.

Mit Firebase Cloud Messaging (FCM), können Sie zuverlässig Benachrichtigungen an Benutzern über Plattformen hinweg senden. Um eine Benachrichtigung an einen Benutzer zu senden, benötigen Sie dessen FCM-Gerätetoken. Die von uns verwendete Chat-Web-App sammelt bereits Geräte-Token von Benutzern, wenn sie die App zum ersten Mal auf einem neuen Browser oder Gerät öffnen. Dieser Marker wird in Cloud - Firestor in der gespeicherten fcmTokens Sammlung.

Wenn Sie möchten lernen , wie man FCM Geräte - Tokens auf einer Web - App zu erhalten, können Sie die durchFireBase Web Codelab .

Benachrichtigungen senden

Zu erkennen , wenn neue Nachrichten geschrieben werden, werden Sie die Verwendung von functions.firestore.document().onCreate Cloud - Funktionen auslösen, die Ihren Code ausgeführt wird, wenn ein neues Objekt zu einem bestimmten Pfad des Cloud Firestor erstellt wird. Fügen Sie die sendNotifications Funktion in Ihre index.js Datei:

index.js

// Sends a notifications to all users when a new message is posted.
exports.sendNotifications = functions.firestore.document('messages/{messageId}').onCreate(
  async (snapshot) => {
    // Notification details.
    const text = snapshot.data().text;
    const payload = {
      notification: {
        title: `${snapshot.data().name} posted ${text ? 'a message' : 'an image'}`,
        body: text ? (text.length <= 100 ? text : text.substring(0, 97) + '...') : '',
        icon: snapshot.data().profilePicUrl || '/images/profile_placeholder.png',
        click_action: `https://${process.env.GCLOUD_PROJECT}.firebaseapp.com`,
      }
    };

    // Get the list of device tokens.
    const allTokens = await admin.firestore().collection('fcmTokens').get();
    const tokens = [];
    allTokens.forEach((tokenDoc) => {
      tokens.push(tokenDoc.id);
    });

    if (tokens.length > 0) {
      // Send notifications to all tokens.
      const response = await admin.messaging().sendToDevice(tokens, payload);
      await cleanupTokens(response, tokens);
      functions.logger.log('Notifications have been sent and tokens cleaned up.');
    }
  });

In der Funktion oben, sammeln wir alle Geräte - Tokens Benutzer aus der Cloud Firestore - Datenbank und eine Benachrichtigung an jedem dieser Senden der mit admin.messaging().sendToDevice Funktion.

Bereinigen Sie die Token

Schließlich wollen wir die Token entfernen, die nicht mehr gültig sind. Dies geschieht, wenn das Token, das wir einmal vom Benutzer erhalten haben, nicht mehr vom Browser oder Gerät verwendet wird. Dies ist beispielsweise der Fall, wenn der Benutzer die Benachrichtigungserlaubnis für die Browsersitzung widerrufen hat. Um dies zu tun, fügen Sie die folgende cleanupTokens in Ihrer Funktion index.js Datei:

index.js

// Cleans up the tokens that are no longer valid.
function cleanupTokens(response, tokens) {
 // For each notification we check if there was an error.
 const tokensDelete = [];
 response.results.forEach((result, index) => {
   const error = result.error;
   if (error) {
     functions.logger.error('Failure sending notification to', tokens[index], error);
     // Cleanup the tokens that are not registered anymore.
     if (error.code === 'messaging/invalid-registration-token' ||
         error.code === 'messaging/registration-token-not-registered') {
       const deleteTask = admin.firestore().collection('fcmTokens').doc(tokens[index]).delete();
       tokensDelete.push(deleteTask);
     }
   }
 });
 return Promise.all(tokensDelete);
}

Stellen Sie die Funktion bereit

Die Funktion ist erst aktiv, nachdem Sie sie bereitgestellt haben, und um sie bereitzustellen, führen Sie Folgendes in der Befehlszeile aus:

firebase deploy --only functions

Dies ist die Konsolenausgabe, die Sie sehen sollten:

i  deploying functions
i  functions: ensuring necessary APIs are enabled...
✔  functions: all necessary APIs are enabled
i  functions: preparing functions directory for uploading...
i  functions: packaged functions (X.XX KB) for uploading
✔  functions: functions folder uploaded successfully
i  starting release process (may take several minutes)...
i  functions: updating function addWelcomeMessages...
i  functions: updating function blurOffensiveImages...
i  functions: creating function sendNotifications...
✔  functions[addWelcomeMessages]: Successful update operation.
✔  functions[blurOffensiveImages]: Successful updating operation.
✔  functions[sendNotifications]: Successful create operation.
✔  functions: all functions deployed successfully!

✔  Deploy complete!

Project Console: https://console.firebase.google.com/project/friendlychat-1234/overview

Testen Sie die Funktion

  1. Sobald die Funktion erfolgreich eingesetzt hat, öffnen Sie Ihre App in Ihrem Browser die Hosting - URL (in Form von https://<project-id>.firebaseapp.com ).
  2. Wenn Sie sich zum ersten Mal in der App anmelden, stellen Sie sicher, dass Sie Benachrichtigungen zulassen, wenn Sie dazu aufgefordert werden: 8b9d0c66dc36153d.png
  3. Schließen Sie die Registerkarte der Chat-App oder zeigen Sie eine andere Registerkarte an: Benachrichtigungen werden nur angezeigt, wenn sich die App im Hintergrund befindet. Wenn Sie möchten lernen , wie man Nachrichten empfangen , während die App im Vordergrund steht, haben Sie einen Blick auf unsere Dokumentation .
  4. Melden Sie sich mit einem anderen Browser (oder einem Inkognito-Fenster) bei der App an und posten Sie eine Nachricht. Sie sollten eine Benachrichtigung sehen, die vom ersten Browser angezeigt wird: 45282ab12b28b926.png

11. Herzlichen Glückwunsch!

Sie haben das Firebase SDK for Cloud Functions verwendet und einer Chat-App serverseitige Komponenten hinzugefügt.

Was wir abgedeckt haben

  • Erstellen von Cloud-Funktionen mit dem Firebase SDK für Cloud-Funktionen.
  • Lösen Sie Cloud Functions basierend auf Auth-, Cloud Storage- und Cloud Firestore-Ereignissen aus.
  • Fügen Sie Ihrer Web-App Firebase Cloud Messaging-Unterstützung hinzu.
  • Stellen Sie Cloud Functions mithilfe der Firebase-Befehlszeilenschnittstelle bereit.

Nächste Schritte

Lern mehr