Połącz aplikację i rozpocznij prototyp

Zanim zaczniesz korzystać z Pakietu emulatorów lokalnych Firebase, utwórz projekt Firebase, skonfiguruj środowisko programistyczne oraz wybierz i zainstaluj pakiety SDK Firebase dla swojej platformy zgodnie z tematami Pierwsze kroki z Firebase przeznaczonymi dla Twojej platformy: Apple, Android lub Internet.

Prototypowanie i testowanie

Pakiet emulatorów lokalnych zawiera kilka emulatorów usług. Ich opis znajdziesz we wprowadzeniu do Pakietu emulatorów lokalnych Firebase. Możesz prototypować i testować za pomocą poszczególnych emulatorów oraz ich kombinacji, zależnie od tego, których usług Firebase używasz w środowisku produkcyjnym.

Interakcja między bazą danych Firebase a emulatorami funkcji
Emulatory baz danych i Cloud Functions w ramach pełnego Pakietu emulatorów lokalnych.

W tym temacie, aby przedstawić przepływ pracy w Pakiecie emulatorów lokalnych, załóżmy, że pracujesz nad aplikacją, która wykorzystuje typową kombinację usług: bazę danych Firebase i funkcje w chmurze aktywowane przez operacje na tej bazie.

Po zainicjowaniu lokalnie projektu Firebase cykl programowania w Pakiecie emulatorów lokalnych składa się zwykle z 3 kroków:

  1. Prototypowe funkcje interaktywne z użyciem emulatorów i interfejsu pakietu emulatorów.

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

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

Inicjowanie projektu Firebase lokalnie

Pamiętaj, aby zainstalować interfejs wiersza poleceń lub zaktualizować go do najnowszej wersji.

curl -sL firebase.tools | bash

Jeśli nie zostało to jeszcze zrobione, zainicjuj bieżący katalog roboczy jako projekt Firebase, wykonując instrukcje wyświetlane na ekranie, aby określić, czy korzystasz z Cloud Functions i Cloud Firestore albo Bazy danych czasu rzeczywistego:

firebase init

Katalog projektu będzie teraz zawierać pliki konfiguracji Firebase, plik definicji reguł zabezpieczeń Firebase dla bazy danych, katalog functions z kodem Cloud Functions i inne pliki pomocnicze.

Interaktywne prototypowanie

Pakiet emulatorów lokalnych umożliwia szybkie tworzenie prototypów nowych funkcji, a wbudowany interfejs użytkownika jest jednym z najbardziej przydatnych narzędzi do tworzenia prototypów. Działa to trochę tak, jakby konsola Firebase działała lokalnie.

Korzystając z interfejsu użytkownika pakietu emulatorów, możesz m.in. iterować projekt bazy danych, testować różne przepływy danych obejmujące funkcje w chmurze, oceniać zmiany reguł zabezpieczeń i sprawdzać logi w celu potwierdzenia wydajności usług backendu. Jeśli chcesz zacząć od początku, po prostu wyczyść bazę danych i zacznij od nowa z nowym pomysłem.

Wszystkie te funkcje są dostępne po uruchomieniu Pakietu emulatorów lokalnych z użyciem:

firebase emulators:start

Aby stworzyć prototyp naszej hipotetycznej aplikacji, skonfigurujmy i przetestujmy podstawową funkcję w Cloud Functions, która będzie modyfikować wpisy tekstowe w bazie danych, a potem utworzymy i uzupełnimy tę bazę danych w interfejsie Pakietu emulatorów, aby ją aktywować.

  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 poniższym fragmentem. 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.
  2.   const functions = require('firebase-functions');
    
      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});
          });
      
  3. Uruchom Pakiet emulatorów lokalnych za pomocą firebase emulators:start. Uruchomią się emulatory Cloud Functions i bazy danych, które będą automatycznie skonfigurowane do współpracy.
  4. Wyświetl interfejs w przeglądarce na stronie http://localhost:4000. Port 4000 jest domyślnym portem w interfejsie użytkownika, ale sprawdź komunikaty terminala generowane przez interfejs wiersza poleceń Firebase. Zwróć uwagę na stan dostępnych emulatorów. W naszym przypadku emulatory Cloud Functions i Cloud Firestore będą uruchomione.
    Moje zdjęcie
  5. W interfejsie na karcie Firestore > Dane kliknij Rozpocznij zbieranie i postępuj zgodnie z wyświetlanymi instrukcjami, aby utworzyć nowy dokument w kolekcji messages z nazwą pola original i wartością test. Spowoduje to aktywowanie funkcji w Cloud Functions. Wkrótce pojawi się nowe pole uppercase z ciągiem znaków „TEST”.
    Moje zdjęcie Moje zdjęcie
  6. Na karcie Firestore > Żądania możesz przeglądać żądania wysyłane do emulowanej bazy danych, w tym wszystkie oceny reguł zabezpieczeń Firebase dokonane w ramach realizacji tych żądań.
  7. Sprawdź kartę Logi, aby upewnić się, że funkcja nie napotkała błędów podczas aktualizowania bazy danych.

Możesz łatwo powtarzać kod funkcji w Cloud Functions i interaktywne zmiany w bazie danych aż do uzyskania odpowiedniego przepływu danych bez dotykania kodu dostępu do bazy danych w aplikacji, ponownego kompilowania i ponownego uruchamiania zestawów testowych.

Łączenie aplikacji z emulatorami

Po dobrych postępach w tworzeniu interaktywnego prototypowania i zaplanowaniu projektu będzie można dodać do aplikacji kod dostępu do bazy danych za pomocą odpowiedniego pakietu SDK. Nadal będziesz korzystać z karty bazy danych oraz (w przypadku funkcji) karty Logs w interfejsie Pakietu emulatorów, aby sprawdzać, czy aplikacja działa prawidłowo.

Pamiętaj, że Pakiet emulatorów lokalnych jest narzędziem dla programistów lokalnych. Zapisy w produkcyjnych bazach danych nie będą aktywować funkcji, które tworzysz lokalnie.

Aby umożliwić aplikacji wykonywanie zapisów w bazie danych, musisz wskazać emulatorowi Cloud Firestore klasy testowe lub konfigurację w aplikacji.

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 Modular API

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

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

Interfejs API internetowej przestrzeni nazw

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

Automatyzowanie testów za pomocą skryptów niestandardowych

A teraz ostatni krok ogólnego przepływu pracy. Gdy masz prototypowany element w aplikacji i wygląda on obiecująco na wszystkich platformach, możesz przejść do ostatecznego wdrożenia i testowania. W przypadku testowania jednostkowego i przepływów pracy CI możesz uruchamiać emulatory, uruchamiać testy skryptowe i wyłączać emulatory w pojedynczym wywołaniu za pomocą polecenia exec:

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

Więcej informacji na temat poszczególnych emulatorów

Skoro wiesz już, jak wygląda podstawowy przepływ pracy po stronie klienta, możesz przejść dalej, omawiając szczegóły poszczególnych emulatorów w pakiecie Analytics. Możesz na przykład dowiedzieć się, jak używać ich do tworzenia aplikacji po stronie serwera:

Co dalej?

Zapoznaj się z tematami związanymi z konkretnymi emulatorami, do których linki znajdziesz powyżej. Następnie: