Połącz aplikację i rozpocznij prototyp

Cloud Firestore Baza danych czasu rzeczywistego

Zanim zaczniesz korzystać z Firebase Local Emulator Suite, utwórz projekt Firebase, skonfiguruj środowisko programistyczne oraz wybierz i zainstaluj pakiety SDK Firebase na swoją platformę zgodnie z tematami z sekcji Pierwsze kroki z Firebase dotyczącymi Twojej platformy: Apple, Android lub Web.

Prototypowanie i testowanie

Uwaga: zanim zaczniesz korzystać z Pakietu emulatorów lokalnych Firebase, zapoznaj się z usługami Firebase i modelem programowania w Firebase. Po przeczytaniu sekcji Rozpocznij dotyczącej Twojej platformy pobierz gotową do uruchomienia aplikację z szybkim wprowadzeniem na wybranej platformie, a następnie przeczytaj i wykonaj kod. Aplikacja FriendlyEats to dobry wybór (iOS, Android lub Web).

Local Emulator Suite zawiera kilka emulatorów produktów, które zostały opisane w artykule Wprowadzenie do Firebase Local Emulator Suite. Możesz tworzyć prototypy i testować je na poszczególnych emulatorach oraz na ich kombinacjach, w zależności od tego, które usługi Firebase używasz w wersji produkcyjnej.

Baza danych i emulatory Cloud Functions w ramach pełnej Local Emulator Suite.

Aby wprowadzić Cię w temat Local Emulator Suite, załóżmy, że pracujesz nad aplikacją, która korzysta z typowego połączenia usług: bazy danych Firebase i funkcji Cloud Functions wywoływanych przez operacje w tej bazie danych.

Po lokalnym zainicjowaniu projektu Firebase cykl programowania z użyciem Local Emulator Suite zwykle składa się z 3 etapów:

1. Twórz interaktywne prototypy funkcji za pomocą emulatorów i Emulator Suite UI.

2. Jeśli używasz emulatora bazy danych lub emulatora Cloud Functions, wykonaj jednorazową czynność, aby połączyć aplikację z emulatorami.

3. Automatyzuj testy za pomocą emulatorów i skryptów niestandardowych.

Lokalne inicjowanie projektu Firebase

Zainstaluj interfejs wiersza poleceń lub zaktualizuj go do najnowszej wersji.

curl -sL firebase.tools | bash

Jeśli jeszcze tego nie zrobisz, zainicjuj bieżący katalog roboczy jako projekt Firebase. Postępuj zgodnie z instrukcjami wyświetlanymi na ekranie, aby określić, że używasz Cloud Functions oraz Cloud Firestore lub Realtime Database:

firebase init

Katalog projektu będzie teraz zawierać pliki konfiguracyjne Firebase, plik definicji bazy danychFirebase Security Rules, katalog functions zawierający kod funkcji w chmurze i inne pliki pomocnicze.

Interaktywne prototypowanie

Local Emulator Suite umożliwia szybkie tworzenie prototypów nowych funkcji, a wbudowany interfejs pakietu jest jednym z najbardziej przydatnych narzędzi do prototypowania. To trochę tak, jakby Firebase konsola działała lokalnie.

Za pomocą Emulator Suite UI możesz iteracyjnie projektować bazę danych, wypróbowywać różne przepływy danych z użyciem funkcji Cloud Functions, oceniać zmiany w regułach zabezpieczeń, sprawdzać logi, aby potwierdzić wydajność usług backendu, i wykonywać inne czynności. Jeśli chcesz zacząć od nowa, wyczyść bazę danych i zacznij od początku z nowym pomysłem na projekt.

Wszystkie te funkcje są dostępne po uruchomieniu Local Emulator Suite za pomocą:

firebase emulators:start

Aby stworzyć prototyp naszej hipotetycznej aplikacji, skonfigurujmy i przetestujmy podstawową funkcję chmurową, która będzie modyfikować wpisy tekstowe w bazie danych, a także tworzyć i wypełniać tę bazę danych w Emulator Suite UI, aby ją wywoływać.

1. Utwórz funkcję w Cloud Functions aktywowaną przez zapisy w bazie danych, edytując plik functions/index.js w katalogu projektu. Zastąp zawartość istniejącego pliku tym fragmentem kodu. Ta funkcja nasłuchuje zmian w dokumentach w kolekcji messages, konwertuje zawartość pola original dokumentu na wielkie litery i zapisuje wynik w polu uppercase tego dokumentu.

  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});
      });
  

2. Uruchom Local Emulator Suite za pomocą firebase emulators:start. Emulatory Cloud Functions i bazy danych uruchamiają się automatycznie i są skonfigurowane do współpracy.
3. Wyświetl interfejs w przeglądarce pod adresem http://localhost:4000. Port 4000 jest domyślnym portem interfejsu, ale sprawdź komunikaty terminala wygenerowane przez interfejs wiersza poleceń Firebase. Sprawdź stan dostępnych emulatorów. W naszym przypadku będą działać emulatory Cloud Functions i Cloud Firestore.
   Wyświetlanie strony głównej interfejsu
4. W interfejsie na karcie Firestore > Dane kliknij Rozpocznij kolekcję i postępuj zgodnie z instrukcjami, aby utworzyć nowy dokument w kolekcji messages z nazwą pola original i wartością test. Spowoduje to aktywowanie naszej funkcji w Cloud Functions. Zauważ, że wkrótce pojawi się nowe pole uppercase wypełnione ciągiem znaków „TEST”.
   Jak utworzyć kolekcję Wyświetl aktualizacje funkcji
5. Na karcie Firestore > Żądania możesz sprawdzić żądania wysyłane do emulowanej bazy danych, w tym wszystkie oceny Firebase Security Rules przeprowadzane w ramach realizacji tych żądań.
6. Sprawdź kartę Dzienniki, aby upewnić się, że podczas aktualizacji bazy danych funkcja nie napotkała błędów.

Możesz łatwo przełączać się między kodem funkcji w chmurze a interaktywnymi zmianami w bazie danych, aż uzyskasz oczekiwany przepływ danych, bez konieczności modyfikowania kodu dostępu do bazy danych w aplikacji, ponownej kompilacji i ponownego uruchamiania zestawów testów.

Łączenie aplikacji z emulatorami

Gdy osiągniesz postępy w tworzeniu interaktywnego prototypu i ustalisz projekt, możesz dodać do aplikacji kod dostępu do bazy danych za pomocą odpowiedniego pakietu SDK. Nadal będziesz używać karty bazy danych, a w przypadku funkcji – karty Dzienniki w Emulator Suite UI, aby potwierdzić, że aplikacja działa prawidłowo.

Pamiętaj, że Local Emulator Suite to lokalne narzędzie programistyczne. Zapisywanie danych w bazach danych produkcyjnych nie będzie wywoływać funkcji, które testujesz lokalnie.

Aby przełączyć aplikację na zapisywanie danych w bazie danych, musisz skierować klasy testowe lub konfigurację w aplikacji na Cloud Firestoreemulator.

Uwaga: emulator Cloud Firestore czyści zawartość bazy danych po wyłączeniu. Pamięć podręczna offline pakietu SDK Firestore nie jest czyszczona automatycznie, więc możesz wyłączyć trwałość lokalną w konfiguracji emulatora, aby uniknąć rozbieżności między emulowaną bazą danych a pamięcią podręczną lokalną. W przypadku pakietu SDK na platformę internetową trwałość jest domyślnie wyłączona.

Kotlin

// 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
}
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.
FirebaseFirestore firestore = FirebaseFirestore.getInstance();
firestore.useEmulator("10.0.2.2", 8080);

FirebaseFirestoreSettings settings = new FirebaseFirestoreSettings.Builder()
        .setPersistenceEnabled(false)
        .build();
firestore.setFirestoreSettings(settings);
EmulatorSuite.java

Swift

let settings = Firestore.firestore().settings
settings.host = "127.0.0.1:8080"
settings.cacheSettings = MemoryCacheSettings()
settings.isSSLEnabled = false
Firestore.firestore().settings = settings
ViewController.swift

Web

import { getFirestore, connectFirestoreEmulator } from "firebase/firestore";

// firebaseApps previously initialized using initializeApp()
const db = getFirestore();
connectFirestoreEmulator(db, '127.0.0.1', 8080);
fs_emulator_connect.js

Web

Dowiedz się więcej o modułowym interfejsie Web API, który można poddać tree-shakingowi, i o jego zaletach w porównaniu z interfejsem API z przestrzenią nazw.

// Firebase previously initialized using firebase.initializeApp().
var db = firebase.firestore();
if (location.hostname === "localhost") {
  db.useEmulator("127.0.0.1", 8080);
}
emulator-suite.js

Automatyzowanie testów za pomocą skryptów niestandardowych

Teraz przejdźmy do ostatniego kroku całego procesu. Gdy prototyp funkcji w aplikacji będzie wyglądać obiecująco na wszystkich platformach, możesz przejść do ostatecznego wdrożenia i testowania. W przypadku testów jednostkowych i procesów CI możesz uruchamiać emulatory, przeprowadzać testy skryptowe i zamykać emulatory za pomocą jednego wywołania z użyciem polecenia exec:

firebase emulators:exec "./testdir/test.sh"

Szczegółowe informacje o poszczególnych emulatorach

Znasz już podstawowy przepływ pracy po stronie klienta. Możesz teraz zapoznać się ze szczegółami dotyczącymi poszczególnych emulatorów w pakiecie, w tym z informacjami o tym, jak używać ich do tworzenia aplikacji po stronie serwera:

• Dodawanie emulatora Authentication do przepływów pracy związanych z prototypowaniem
• Więcej informacji o funkcjach Realtime Database emulatora
• Więcej informacji o funkcjach Cloud Storage for Firebase emulatora
• Więcej informacji o funkcjach Cloud Firestore emulatora
• Łączenie aplikacji z emulatorem Cloud Functions
• Ocena Firebase Extensions przy jednoczesnej minimalizacji kosztów rozliczeniowych za pomocą Extensions emulatora

Co dalej?

Zapoznaj się z tematami dotyczącymi konkretnych emulatorów, do których linki znajdziesz powyżej. Następnie:

• Zestaw wyselekcjonowanych filmów i szczegółowych instrukcji z przykładami znajdziesz na playliście szkoleń na temat emulatorów Firebase.
• Poznaj zaawansowane przypadki użycia związane z testowaniem reguł zabezpieczeń i pakietu Firebase Test SDK: Testowanie reguł zabezpieczeń (Cloud Firestore), Testowanie reguł zabezpieczeń (Realtime Database) i Testowanie reguł zabezpieczeń (Cloud Storage for Firebase).