Verbinden Sie Ihre App mit dem Realtime Database Emulator

Bevor Sie Ihre App mit dem Realtime Database-Emulator verbinden, vergewissern Sie sich, dass Sie den gesamten Arbeitsablauf der Firebase Local Emulator Suite verstehen und dass Sie die Local Emulator Suite installieren und konfigurieren und ihre CLI-Befehle überprüfen .

Wählen Sie ein Firebase-Projekt aus

Die Firebase Local Emulator Suite emuliert Produkte für ein einzelnes Firebase-Projekt.

Um das zu verwendende Projekt auszuwählen, bevor Sie die Emulatoren starten, führen Sie in der Befehlszeilenschnittstelle firebase use in Ihrem Arbeitsverzeichnis aus. Oder Sie können das Flag --project an jeden Emulatorbefehl übergeben.

Hinweis: Es empfiehlt sich im Allgemeinen, eine Projekt-ID für alle Emulatoraufrufe zu verwenden, damit die Benutzeroberfläche der Emulator Suite, verschiedene Produktemulatoren und alle ausgeführten Instanzen eines bestimmten Emulators in allen Fällen korrekt kommunizieren können. Tatsächlich warnt die Local Emulator Suite standardmäßig, wenn mehrere verwendete Projekt-IDs erkannt werden, obwohl Sie dieses Verhalten überschreiben können. Anleitungen zum Festlegen und Verwalten von Projekt-IDs finden Sie im Installations- und Konfigurationshandbuch .

Die Local Emulator Suite unterstützt die Emulation echter Firebase-Projekte und Demo- Projekte.

Projekttyp	Merkmale	Verwenden Sie mit Emulatoren
Real	Ein echtes Firebase-Projekt ist eines, das Sie erstellt und konfiguriert haben (höchstwahrscheinlich über die Firebase-Konsole). Echte Projekte haben Live-Ressourcen wie Datenbankinstanzen, Speicher-Buckets, Funktionen oder andere Ressourcen, die Sie für dieses Firebase-Projekt eingerichtet haben.	Wenn Sie mit echten Firebase-Projekten arbeiten, können Sie Emulatoren für einige oder alle unterstützten Produkte ausführen. Bei allen Produkten, die Sie nicht emulieren, interagieren Ihre Apps und Ihr Code mit der Live- Ressource (Datenbankinstanz, Speicher-Bucket, Funktion usw.).
Demo	Ein Demo-Firebase-Projekt hat keine echte Firebase-Konfiguration und keine Live-Ressourcen. Auf diese Projekte wird normalerweise über Codelabs oder andere Tutorials zugegriffen. Projekt-IDs für Demo-Projekte haben das demo- Präfix.	Wenn Sie mit Firebase-Demoprojekten arbeiten, interagieren Ihre Apps und Ihr Code nur mit Emulatoren . Wenn Ihre App versucht, mit einer Ressource zu interagieren, für die kein Emulator ausgeführt wird, schlägt dieser Code fehl.

Wir empfehlen Ihnen, möglichst Demoprojekte zu verwenden. Zu den Vorteilen gehören:

• Einfachere Einrichtung, da Sie die Emulatoren ausführen können, ohne jemals ein Firebase-Projekt zu erstellen
• Höhere Sicherheit, denn wenn Ihr Code versehentlich nicht emulierte (Produktions-)Ressourcen aufruft, besteht keine Chance auf Datenänderung, Nutzung und Abrechnung
• Besserer Offline-Support, da Sie nicht auf das Internet zugreifen müssen, um Ihre SDK-Konfiguration herunterzuladen.

Hinweis: Wenn Sie dienstübergreifende Interaktionen wie datenbankgetriggerte Cloud-Funktionen oder Regeln emulieren möchten, die auf Authentifizierung angewiesen sind, müssen Sie sicherstellen, dass die Projekt-ID in Ihrem Code (in initializeApp() usw.) mit der von verwendeten Projekt-ID übereinstimmt die Firebase-CLI.

Instrumentieren Sie Ihre App, um mit den Emulatoren zu kommunizieren

Android-, Apple-Plattformen und Web-SDKs

Richten Sie Ihre In-App-Konfiguration oder Testklassen für die Interaktion mit der Echtzeitdatenbank wie folgt ein.

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 database = Firebase.database
database.useEmulator("10.0.2.2", 9000)
EmulatorSuite.kt

Java

// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
FirebaseDatabase database = FirebaseDatabase.getInstance();
database.useEmulator("10.0.2.2", 9000);
EmulatorSuite.java

Schnell

    // In almost all cases the ns (namespace) is your project ID.
let db = Database.database(url:"http://localhost:9000?ns=YOUR_DATABASE_NAMESPACE")
ViewController.swift

Web version 9

Erfahren Sie mehr über das modulare Web v9-SDK, das durch Baumstruktur erschüttert werden kann, und aktualisieren Sie es von Version 8.

import { getDatabase, connectDatabaseEmulator } from "firebase/database";

const db = getDatabase();
if (location.hostname === "localhost") {
  // Point to the RTDB emulator running on localhost.
  connectDatabaseEmulator(db, "localhost", 9000);
} 
rtdb_emulator_connect.js

Web version 8

Erfahren Sie mehr über das modulare Web v9-SDK, das durch Baumstruktur erschüttert werden kann, und aktualisieren Sie es von Version 8.

var db = firebase.database();
if (location.hostname === "localhost") {
  // Point to the RTDB emulator running on localhost.
  db.useEmulator("localhost", 9000);
} 
emulator-suite.js

Es ist keine zusätzliche Einrichtung erforderlich, um Cloud Functions-Funktionen zu testen , die von Realtime Database-Ereignissen mit dem Emulator ausgelöst werden . Wenn die Realtime Database- und Cloud Functions-Emulatoren beide ausgeführt werden, arbeiten sie automatisch zusammen.

Admin-SDKs

Die Firebase Admin SDKs stellen automatisch eine Verbindung zum Realtime Database-Emulator her, wenn die Umgebungsvariable FIREBASE_DATABASE_EMULATOR_HOST festgelegt ist:

export FIREBASE_DATABASE_EMULATOR_HOST="localhost:9000"

Wenn Ihr Code im Cloud Functions-Emulator ausgeführt wird, werden Ihre Projekt-ID und andere Konfigurationen beim Aufrufen initalizeApp automatisch festgelegt.

Wenn Sie möchten, dass Ihr Admin SDK-Code eine Verbindung zu einem freigegebenen Emulator herstellt, der in einer anderen Umgebung ausgeführt wird, müssen Sie dieselbe Projekt-ID angeben, die Sie mit der Firebase-CLI festgelegt haben . Sie können eine Projekt-ID direkt an initializeApp übergeben oder die Umgebungsvariable GCLOUD_PROJECT festlegen.

Node.js-Admin-SDK

admin.initializeApp({ projectId: "your-project-id" });

Umgebungsvariable

export GCLOUD_PROJECT="your-project-id"

Löschen Sie Ihre Datenbank zwischen den Tests

Um die Echtzeitdatenbank zwischen Aktivitäten zu leeren, können Sie die Datenbankreferenz löschen. Sie können diesen Ansatz als Alternative zum einfachen Herunterfahren des Emulatorprozesses verwenden.

Achtung: Schließen Sie in Ihrer Testkonfiguration nur Code zum Leeren Ihrer Datenbank ein. Stellen Sie sicher, dass diese Methode nicht versehentlich im Produktionscode aufgerufen wird.

Kotlin+KTX

// With a DatabaseReference, write null to clear the database.
database.reference.setValue(null)
EmulatorSuite.kt

Java

// With a DatabaseReference, write null to clear the database.
database.getReference().setValue(null);
EmulatorSuite.java

Schnell

// With a DatabaseReference, write nil to clear the database.
    Database.database().reference().setValue(nil);

Web version 9

Erfahren Sie mehr über das modulare Web v9-SDK, das durch Baumstruktur erschüttert werden kann, und aktualisieren Sie es von Version 8.

import { getDatabase, ref, set } from "firebase/database";

// With a database Reference, write null to clear the database.
const db = getDatabase();
set(ref(db), null);
rtdb_emulator_flush.js

Web version 8

Erfahren Sie mehr über das modulare Web v9-SDK, das durch Baumstruktur erschüttert werden kann, und aktualisieren Sie es von Version 8.

// With a database Reference, write null to clear the database.
firebase.database().ref().set(null);
emulator-suite.js

Natürlich sollte Ihr Code mithilfe der asynchronen Ereignisbehandlungsfunktionen Ihrer Plattform auf die Bestätigung warten, dass der Flush beendet wurde oder fehlgeschlagen ist.

Nachdem Sie einen solchen Schritt implementiert haben, können Sie Ihre Tests sequenzieren und Ihre Funktionen in der Gewissheit auslösen, dass alte Daten zwischen den Läufen gelöscht werden und Sie eine neue Baseline-Testkonfiguration verwenden.

Daten importieren und exportieren

Mit der Datenbank und Cloud Storage for Firebase-Emulatoren können Sie Daten aus einer laufenden Emulatorinstanz exportieren. Definieren Sie einen Basisdatensatz zur Verwendung in Ihren Einheitentests oder kontinuierlichen Integrationsworkflows und exportieren Sie ihn dann zur gemeinsamen Nutzung im Team.

firebase emulators:export ./dir

Importieren Sie in Tests beim Start des Emulators die Basisdaten.

firebase emulators:start --import=./dir

Sie können den Emulator anweisen, Daten beim Herunterfahren zu exportieren, indem Sie entweder einen Exportpfad angeben oder einfach den Pfad verwenden, der an das Flag --import übergeben wird.

firebase emulators:start --import=./dir --export-on-exit

Diese Datenimport- und -exportoptionen funktionieren auch mit dem Befehl firebase emulators:exec . Weitere Informationen finden Sie in der Emulator-Befehlsreferenz .

Visualisieren Sie die Aktivität der Sicherheitsregeln

Beim Durcharbeiten von Prototypen und Testschleifen können Sie Visualisierungstools und Berichte verwenden, die von der Local Emulator Suite bereitgestellt werden.

Visualisieren Sie Regelauswertungen

Wenn Sie Ihrem Prototyp Sicherheitsregeln hinzufügen, können Sie diese mit den Tools der Local Emulator Suite debuggen.

Nachdem Sie eine Reihe von Tests ausgeführt haben, können Sie auf Testabdeckungsberichte zugreifen, die zeigen, wie jede Ihrer Regeln bewertet wurde. Um die Berichte abzurufen, fragen Sie einen exponierten Endpunkt auf dem Emulator ab, während er ausgeführt wird. Verwenden Sie für eine browserfreundliche Version die folgende URL:

http://localhost:9000/.inspect/coverage?ns=<database_name>

Dadurch werden Ihre Regeln in Ausdrücke und Unterausdrücke unterteilt, über die Sie mit der Maus fahren können, um weitere Informationen anzuzeigen, einschließlich der Anzahl der Ausführungen und der zurückgegebenen Werte. Für die rohe JSON-Version dieser Daten fügen Sie die folgende URL in Ihre Abfrage ein:

http://localhost:9000/.inspect/coverage.json?ns=<database_name>

Was als nächstes?

• Eine kuratierte Reihe von Videos und detaillierten Anleitungsbeispielen finden Sie in der Firebase Emulators Training Playlist .
• Untersuchen Sie fortgeschrittene Anwendungsfälle im Zusammenhang mit dem Testen von Sicherheitsregeln und dem Firebase Test SDK: Test Security Rules (Realtime Database) .
• Da ausgelöste Funktionen eine typische Integration mit Realtime Database sind, erfahren Sie mehr über den Cloud Functions for Firebase-Emulator unter Funktionen lokal ausführen .