App mit dem Cloud Storage for Firebase-Emulator verbinden

Bevor Sie Ihre App mit dem Cloud Storage for Firebase-Emulator verbinden, sollten Sie sich mit dem allgemeinen Firebase Local Emulator Suite-Workflow vertraut machen. Außerdem müssen Sie die Local Emulator Suite installieren und konfigurieren und sich die zugehörigen CLI-Befehle ansehen.

Firebase-Projekt auswählen

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

Wenn Sie das zu verwendende Projekt auswählen möchten, führen Sie vor dem Starten der Emulatoren in der Befehlszeile firebase use in Ihrem Arbeitsverzeichnis aus. Alternativ können Sie das Flag --project an jeden Emulatorbefehl übergeben.

Local Emulator Suite unterstützt die Emulation von echten Firebase-Projekten und Demoprojekten.

Projekttyp Funktionen Mit Emulatoren verwenden
Real

Ein echtes Firebase-Projekt ist ein Projekt, das Sie erstellt und konfiguriert haben (höchstwahrscheinlich über die Firebase Console).

Echte Projekte haben Live-Ressourcen wie Datenbankinstanzen, Storage-Buckets, Funktionen oder andere Ressourcen, die Sie für dieses Firebase-Projekt einrichten.

Wenn Sie mit echten Firebase-Projekten arbeiten, können Sie Emulatoren für alle oder einige der unterstützten Produkte ausführen.

Bei allen Produkten, die Sie nicht emulieren, interagieren Ihre Anwendungen und Ihr Code mit der Live-Ressource (Datenbankinstanz, Storage-Bucket, Funktion usw.).

Demo

Ein Firebase-Demoprojekt hat keine echte Firebase-Konfiguration und keine Live-Ressourcen. Auf diese Projekte wird in der Regel über Code-Labs oder andere Tutorials zugegriffen.

Projekt-IDs für Demoprojekte haben das Präfix demo-.

Wenn Sie mit Firebase-Demoprojekten arbeiten, interagieren Ihre Apps und Ihr Code nur mit Emulatoren. Wenn Ihre Anwendung versucht, mit einer Ressource zu interagieren, für die kein Emulator ausgeführt wird, schlägt dieser Code fehl.

Wir empfehlen, nach Möglichkeit Demoprojekte zu verwenden. Die wichtigsten Vorteile:

  • Einfachere Einrichtung, da Sie die Emulatoren ausführen können, ohne ein Firebase-Projekt erstellen zu müssen
  • Höhere Sicherheit, da bei versehentlichem Aufruf nicht emulierter (Produktions-)Ressourcen durch Ihren Code keine Datenänderung, Nutzung und Abrechnung möglich ist.
  • Bessere Offline-Unterstützung, da kein Internetzugriff erforderlich ist, um Ihre SDK-Konfiguration herunterzuladen.

Anwendung für die Kommunikation mit den Emulatoren instrumentieren

Android-, Apple- und Web-SDKs

Richten Sie Ihre In-App-Konfiguration oder Testklassen so ein, dass sie mit dem Cloud Storage for Firebase-Emulator interagieren.

Kotlin
// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
val storage = Firebase.storage
storage.useEmulator("10.0.2.2", 9199)
Java
// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
FirebaseStorage storage = FirebaseStorage.getInstance();
storage.useEmulator("10.0.2.2", 9199);
Swift
Storage.storage().useEmulator(withHost: "127.0.0.1", port: 9199)
Einheit
FirebaseStorage storage = FirebaseStorage.DefaultInstance;
// Connects to the Storage Emulator running on port 9199
storage.UseEmulator("127.0.0.1", 9199);

Web

const { getStorage, connectStorageEmulator } = require("firebase/storage");

const storage = getStorage();
if (location.hostname === "localhost") {
  // Point to the Storage emulator running on localhost.
  connectStorageEmulator(storage, "127.0.0.1", 9199);
}

Web

var storage = firebase.storage();
if (location.hostname === "localhost") {
  // Point to the Storage emulator running on localhost.
  storage.useEmulator("127.0.0.1", 9199);
}

Für das Testen von Cloud Functions-Funktionen, die durch Cloud Storage for Firebase-Ereignisse ausgelöst werden, ist mit dem Emulator keine zusätzliche Einrichtung erforderlich. Wenn die Emulatoren Cloud Storage for Firebase und Cloud Functions beide ausgeführt werden, arbeiten sie automatisch zusammen.

Admin SDK Sek.

Die Firebase Admin SDKs stellen automatisch eine Verbindung zum Cloud Storage for Firebase-Emulator her, wenn die Umgebungsvariable FIREBASE_STORAGE_EMULATOR_HOST festgelegt ist:

export FIREBASE_STORAGE_EMULATOR_HOST="127.0.0.1:9199"

Der Cloud Functions-Emulator erkennt den Cloud Storage for Firebase-Emulator automatisch. Sie können diesen Schritt also überspringen, wenn Sie Integrationen zwischen Cloud Functions- und Cloud Storage for Firebase-Emulatoren testen. Die Umgebungsvariable wird automatisch für das Admin SDK in Cloud Storage for Firebase festgelegt.

Wenn Sie Ihren Admin SDK-Code mit einem freigegebenen Emulator verbinden möchten, 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"

Daten importieren und exportieren

Mit den Datenbank- und Cloud Storage for Firebase-Emulatoren können Sie Daten aus einer laufenden Emulatorinstanz exportieren. Definieren Sie einen Baseline-Datensatz, der in Ihren Unit-Tests oder Continuous Integration-Workflows verwendet werden soll, und exportieren Sie ihn, um ihn im Team freizugeben.

firebase emulators:export ./dir

Importieren Sie in Tests beim Start des Emulators die Referenzdaten.

firebase emulators:start --import=./dir

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

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

Diese Optionen für den Datenimport und -export funktionieren auch mit dem Befehl firebase emulators:exec. Weitere Informationen finden Sie in der Referenz zu Emulatorbefehlen.

Unterschiede zwischen dem Cloud Storage for Firebase-Emulator und der Produktion

Beim Testen von Client-Apps entspricht der Cloud Storage for Firebase-Emulator in Bezug auf die Firebase API-Oberfläche fast vollständig der Produktionsumgebung. Alle Firebase-Befehle sollten zwischen den regulären Firebase SDKs (Web, Android und Apple-Plattformen) funktionieren.

Für das Testen von serverseitigen Apps gelten Einschränkungen. Die Firebase Admin SDKs verwenden die Google Cloud-API-Oberfläche. Nicht alle Endpunkte dieser API werden emuliert. Als Faustregel gilt: Alles, was über die Client-SDKs möglich ist (Dateien hochladen oder löschen, Metadaten abrufen und festlegen), ist auch für die Verwendung über die Admin-SDKs implementiert. Alles darüber hinaus ist jedoch nicht möglich. Wichtige Ausnahmen sind unten aufgeführt.

Unterschiede zu Google Cloud Storage

Das Cloud Storage for Firebase-Produkt, einschließlich des Storage-Emulators, bietet eine Teilmenge der Google Cloud Storage-Funktionen (GCS), die sich auf Speicherobjekte konzentrieren und für die Entwicklung von Firebase-Apps sehr nützlich sind. Cloud Storage for Firebase unterscheidet sich von GCS in folgenden Punkten:

  • Cloud Storage for Firebase unterstützt derzeit keine Bucket-APIs zum Erstellen, Auflisten, Abrufen oder Löschen von Storage-Buckets.
  • Von der Google Cloud Storage Objects API werden die folgenden Methoden unterstützt: copy, delete, get, insert, list, patch, rewrite, update.

Cloud IAM

Die Firebase Emulator Suite versucht nicht, IAM-bezogenes Verhalten für die Ausführung zu replizieren oder zu berücksichtigen. Emulatoren halten sich an die bereitgestellten Firebase-Sicherheitsregeln. In Situationen, in denen normalerweise IAM verwendet wird, z. B. zum Festlegen des Dienstkontos für den Aufruf von Cloud Functions und damit der Berechtigungen, ist der Emulator jedoch nicht konfigurierbar und verwendet das global verfügbare Konto auf Ihrer Entwicklungsmaschine, ähnlich wie beim direkten Ausführen eines lokalen Skripts.

Pub/Sub-Benachrichtigungen

Der Cloud Storage for Firebase-Emulator ist nicht in den Cloud-Pub/Sub-Emulator eingebunden und unterstützt daher nicht das Erstellen von Kanälen/Benachrichtigungen für Änderungen an Speicherobjekten. Wir empfehlen, Cloud Functions Storage-Trigger direkt zu verwenden.

Metadaten auf Bucket-Ebene

Der Cloud Storage for Firebase-Emulator unterstützt keine Konfigurationen auf Bucket-Ebene, einschließlich Speicherklasse, CORS-Konfiguration auf Bucket-Ebene, Labels oder Aufbewahrungsrichtlinien. Firebase beabsichtigt, diese Unterstützung im Laufe der Zeit zu verbessern.

Nächste Schritte