Verbinden Sie Ihre App mit dem Cloud Storage-Emulator

Bevor Sie Ihre App mit dem Cloud Storage-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.

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

Projekttyp Merkmale Verwenden Sie mit Emulatoren
Echt

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.

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 dem Cloud Storage-Emulator wie folgt ein.

Android
FirebaseStorage.getInstance().useEmulator('10.0.2.2', 9199);
Schnell
Storage.storage().useEmulator(withHost:"localhost", port:9199)
Web v8
var storage = firebase.storage();
storage.useEmulator("localhost", 9199);
Web v9
import { getStorage, connectStorageEmulator } from "firebase/storage";

const storage = getStorage();
connectStorageEmulator(storage, "localhost", 9199);

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

Admin-SDKs

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

export FIREBASE_STORAGE_EMULATOR_HOST="localhost:9199"

Beachten Sie, dass der Cloud Functions-Emulator den Cloud Storage-Emulator automatisch erkennt, sodass Sie diesen Schritt überspringen können, wenn Sie Integrationen zwischen Cloud Functions- und Cloud Storage-Emulatoren testen. Die Umgebungsvariable wird automatisch für das Admin SDK in Cloud Storage 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 .

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-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 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 .

Wie sich der Cloud Storage-Emulator von der Produktion unterscheidet

Zum Testen von Client-Apps passt sich der Cloud Storage-Emulator in Bezug auf die Firebase-API-Oberfläche nahezu perfekt an die Produktion an. Es wird erwartet, dass alle Firebase-Befehle zwischen den regulären Firebase-SDKs (Web-, Android- und Apple-Plattformen) funktionieren.

Für das Testen serverseitiger Apps bestehen Einschränkungen. Die Firebase Admin SDKs verwenden die Google Cloud API-Oberfläche und nicht alle Endpunkte dieser API werden emuliert. Als Faustregel gilt, dass alles, was von den Client-SDKs ausgeführt werden kann (Hochladen oder Löschen von Dateien, Abrufen und Festlegen von Metadaten), auch für die Verwendung von den Admin-SDKs implementiert wird, alles darüber hinaus jedoch nicht. Bemerkenswerte Ausschlüsse sind unten aufgeführt.

Cloud-IAM

Die Firebase Emulator Suite versucht nicht, IAM-bezogenes Verhalten für die Ausführung zu replizieren oder zu respektieren. Emulatoren halten sich an die bereitgestellten Firebase-Sicherheitsregeln, aber in Situationen, in denen IAM normalerweise verwendet würde, z. B. um Cloud-Funktionen zum Aufrufen von Dienstkonten und damit Berechtigungen festzulegen, ist der Emulator nicht konfigurierbar und verwendet das global verfügbare Konto auf Ihrem Entwicklercomputer. ähnlich wie beim direkten Ausführen eines lokalen Skripts.

Pub/Sub-Benachrichtigungen

Der Cloud Storage-Emulator lässt sich nicht in den Cloud Pub/Sub-Emulator integrieren und unterstützt daher nicht das Erstellen von Kanälen/Benachrichtigungen für Änderungen an Speicherobjekten. Wir empfehlen die direkte Verwendung von Cloud Functions Storage-Triggern.

Metadaten auf Bucket-Ebene

Der Cloud Storage-Emulator unterstützt keine Konfiguration 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.

Was nun?

  • Eine kuratierte Reihe von Videos und detaillierten Anleitungsbeispielen finden Sie in der Firebase Emulators Training Playlist .
  • Da ausgelöste Funktionen eine typische Integration mit Cloud Storage sind, erfahren Sie mehr über den Cloud Functions for Firebase-Emulator unter Funktionen lokal ausführen .