Bevor Sie Firebase Local Emulator Suite verwenden, müssen Sie ein Firebase-Projekt erstellt, Ihre Entwicklungsumgebung eingerichtet und Firebase SDKs für Ihre Plattform ausgewählt und installiert haben. Beachten Sie dabei die Erste Schritte mit Firebase für Ihre Plattform: Apple, Android oder Web.
Prototypen erstellen und testen
Local Emulator Suite enthält mehrere Produktemulatoren, wie unter Einführung in Firebase Local Emulator Suite beschrieben. Sie können Prototypen erstellen und mit einzelnen Emulatoren oder Kombinationen von Emulatoren testen, je nachdem, welche Firebase-Produkte Sie in der Produktion verwenden.
Angenommen, Sie arbeiten an einer App, die eine typische Kombination von Produkten verwendet: eine Firebase-Datenbank und Cloud-Funktionen, die durch Vorgänge in dieser Datenbank ausgelöst werden.
Nachdem Sie Ihr Firebase-Projekt lokal initialisiert haben, besteht der Entwicklungszyklus mit Local Emulator Suite in der Regel aus drei Schritten:
Interaktive Prototypenfunktionen mit den Emulatoren und Emulator Suite UI
Wenn Sie einen Datenbankemulator oder den Cloud Functions-Emulator verwenden, führen Sie einen einmaligen Schritt aus, um Ihre Anwendung mit den Emulatoren zu verbinden.
Automatisieren Sie Ihre Tests mit den Emulatoren und benutzerdefinierten Skripts.
Firebase-Projekt lokal initialisieren
Achten Sie darauf, dass Sie die Befehlszeile installieren oder ein Update auf die neueste Version durchführen.
curl -sL firebase.tools | bash
Wenn Sie es noch nicht getan haben, initialisieren Sie das aktuelle Arbeitsverzeichnis als Firebase-Projekt. Folgen Sie der Anleitung auf dem Bildschirm, um anzugeben, dass Sie Cloud Functions und entweder Cloud Firestore oder Realtime Database verwenden:
firebase init
Ihr Projektverzeichnis enthält jetzt Firebase-Konfigurationsdateien, eine Firebase Security Rules-Definitiondatei für die Datenbank, ein functions
-Verzeichnis mit Cloud Functions-Code und andere unterstützende Dateien.
Interaktive Prototypen erstellen
Mit Local Emulator Suite können Sie schnell Prototypen neuer Funktionen erstellen. Die integrierte Benutzeroberfläche der Suite ist eines der nützlichsten Prototyping-Tools. Es ist ein bisschen so, als würde die Firebase-Konsole lokal ausgeführt.
Mit Emulator Suite UI können Sie unter anderem das Design einer Datenbank iterieren, verschiedene Dataflows mit Cloud-Funktionen ausprobieren, Änderungen an Sicherheitsregeln bewerten und Logs prüfen, um die Leistung Ihrer Back-End-Dienste zu überprüfen. Wenn Sie von vorne beginnen möchten, löschen Sie einfach Ihre Datenbank und beginnen Sie mit einer neuen Designidee.
Sie sind verfügbar, wenn Sie Local Emulator Suite mit einer der folgenden Optionen starten:
firebase emulators:start
Für den Prototyp unserer hypothetischen App richten wir eine einfache Cloud-Funktion ein und testen sie, um Texteinträge in einer Datenbank zu ändern. Außerdem erstellen und füllen wir diese Datenbank in der Emulator Suite UI, um sie auszulösen.
- Erstellen Sie eine Cloud-Funktion, die durch Datenbankschreiben ausgelöst wird, indem Sie die Datei
functions/index.js
in Ihrem Projektverzeichnis bearbeiten. Ersetzen Sie den Inhalt der vorhandenen Datei durch das folgende Snippet. Diese Funktion überwacht Änderungen an Dokumenten in der Sammlungmessages
, konvertiert den Inhalt des Feldsoriginal
eines Dokuments in Großbuchstaben und speichert das Ergebnis im Felduppercase
dieses Dokuments. - Starten Sie Local Emulator Suite mit
firebase emulators:start
. Die Cloud Functions- und Datenbankemulatoren werden gestartet und automatisch für die Interkonnektivität konfiguriert. - Sehen Sie sich die Benutzeroberfläche in Ihrem Browser unter
http://localhost:4000
an. Port 4000 ist die Standardeinstellung für die UI, aber prüfen Sie Terminalnachrichten, die von der Firebase-Befehlszeile ausgegeben werden. Notieren Sie sich den Status der verfügbaren Emulatoren. In unserem Fall werden die Emulatoren Cloud Functions und Cloud Firestore ausgeführt.
- Klicken Sie in der Benutzeroberfläche auf dem Tab Firestore > Daten auf Sammlung starten und folgen Sie den Aufforderungen, um ein neues Dokument in einer
messages
-Sammlung mit dem Feldnamenoriginal
und dem Werttest
zu erstellen. Dadurch wird die Cloud Functions-Funktion ausgelöst. Es wird kurz darauf ein neuesuppercase
-Feld mit dem String „TEST“ angezeigt.
- Untersuchen Sie auf dem Tab Firestore > Anfragen die Anfragen an die emulierte Datenbank, einschließlich aller Firebase Security Rules-Auswertungen, die im Rahmen der Verarbeitung dieser Anfragen ausgeführt wurden.
- Prüfen Sie auf dem Tab Protokolle, ob bei der Aktualisierung der Datenbank keine Fehler aufgetreten sind.
const functions = require('firebase-functions/v1'); exports.makeUppercase = functions.firestore.document('/messages/{documentId}') .onCreate((snap, context) => { const original = snap.data().original; console.log('Uppercasing', context.params.documentId, original); const uppercase = original.toUpperCase(); return snap.ref.set({uppercase}, {merge: true}); });
Sie können ganz einfach zwischen dem Code Ihrer Cloud-Funktion und interaktiven Datenbankbearbeitungen wechseln, bis Sie den gewünschten Datenfluss erhalten, ohne den Code für den In-App-Datenbankzugriff zu ändern, Test-Suites neu zu kompilieren und noch einmal auszuführen.
App mit den Emulatoren verbinden
Wenn Sie beim interaktiven Prototyping gute Fortschritte gemacht und sich für ein Design entschieden haben, können Sie Ihrer App mit dem entsprechenden SDK Datenbankzugriffscode hinzufügen. Sie verwenden weiterhin den Tab „Datenbank“ und für Funktionen den Tab Protokolle in Emulator Suite UI, um zu prüfen, ob die App richtig funktioniert.
Local Emulator Suite ist ein lokales Entwicklungstool. Schreibvorgänge in Ihre Produktionsdatenbanken lösen keine Funktionen aus, die Sie lokal prototypisieren.
Damit Ihre Anwendung Schreibvorgänge in der Datenbank ausführen kann, müssen Sie Ihre Testklassen oder In-App-Konfiguration auf den Cloud Firestore-Emulator verweisen.
Kotlin+KTX
// 10.0.2.2 is the special IP address to connect to the 'localhost' of // the host computer from an Android emulator. val firestore = Firebase.firestore firestore.useEmulator("10.0.2.2", 8080) firestore.firestoreSettings = firestoreSettings { isPersistenceEnabled = false }
Java
// 10.0.2.2 is the special IP address to connect to the 'localhost' of // the host computer from an Android emulator. FirebaseFirestore firestore = FirebaseFirestore.getInstance(); firestore.useEmulator("10.0.2.2", 8080); FirebaseFirestoreSettings settings = new FirebaseFirestoreSettings.Builder() .setPersistenceEnabled(false) .build(); firestore.setFirestoreSettings(settings);
Swift
let settings = Firestore.firestore().settings settings.host = "127.0.0.1:8080" settings.cacheSettings = MemoryCacheSettings() settings.isSSLEnabled = false Firestore.firestore().settings = settings
Web
import { getFirestore, connectFirestoreEmulator } from "firebase/firestore"; // firebaseApps previously initialized using initializeApp() const db = getFirestore(); connectFirestoreEmulator(db, '127.0.0.1', 8080);
Web
// Firebase previously initialized using firebase.initializeApp(). var db = firebase.firestore(); if (location.hostname === "localhost") { db.useEmulator("127.0.0.1", 8080); }
Tests mit benutzerdefinierten Scripts automatisieren
Kommen wir nun zum letzten Schritt des Workflows. Nachdem Sie einen Prototyp für Ihre Funktion in der App erstellt haben und sie auf allen Plattformen vielversprechend aussieht, können Sie mit der endgültigen Implementierung und Tests beginnen. Für Einheitentests und CI-Workflows können Sie mit dem Befehl exec
in einem einzigen Aufruf Emulatoren starten, Testskripts ausführen und Emulatoren herunterfahren:
firebase emulators:exec "./testdir/test.sh"
Ausführlichere Informationen zu einzelnen Emulatoren
Nachdem Sie nun wissen, wie der grundlegende clientseitige Workflow aussieht, können Sie mit Details zu den einzelnen Emulatoren in der Suite fortfahren, einschließlich der Verwendung für die serverseitige App-Entwicklung:
- Fügen Sie den Authentication-Emulator Ihren Prototyping-Workflows hinzu.
- Mehr über die Emulatorfunktionen von Realtime Database erfahren
- Mehr über die Emulatorfunktionen von Cloud Storage for Firebase erfahren
- Detaillierte Informationen zu den Cloud Firestore-Emulatorfunktionen
- Anwendung mit dem Cloud Functions-Emulator verbinden
- Firebase Extensions evaluieren und gleichzeitig die Abrechnungskosten mit dem Extensions-Emulator minimieren
Und jetzt?
Lesen Sie sich die Themen zu den einzelnen Emulatoren durch, die oben verlinkt sind. Gehen Sie anschließend so vor:
- Eine Auswahl an Videos und detaillierte Anleitungsbeispiele finden Sie in der Trainings-Playlist für Firebase Emulators.
- Untersuchen Sie erweiterte Anwendungsfälle, die das Testen von Sicherheitsregeln und das Firebase Test SDK beinhalten: Sicherheitsregeln testen (Cloud Firestore), Sicherheitsregeln testen (Realtime Database) und Sicherheitsregeln testen (Cloud Storage for Firebase).