Pierwsze kroki: pisanie, testowanie i wdrażanie pierwszych funkcji

.


Aby rozpocząć korzystanie z Cloud Functions, zapoznaj się z tym samouczkiem, który zaczyna się od wymaganych zadań konfiguracyjnych, a kończy na tworzeniu, testowaniu i wdrażaniu 2 powiązanych ze sobą funkcji:

  • Funkcja „add message”, która udostępnia adres URL, który przyjmuje wartość tekstową i zapisuje ją w pliku Cloud Firestore.
  • Funkcja „make uppercase”, która jest wywoływana po zapisie za pomocą funkcji Cloud Firestore i przekształca tekst na wielkie litery.

W tym przykładzie wybraliśmy funkcje JavaScript Cloud Firestore i funkcję JavaScript uruchamianą przez HTTP, ponieważ te tła można dokładnie przetestować za pomocą Firebase Local Emulator Suite. Ten zestaw narzędzi obsługuje też Realtime Database, Aktywatory PubSub, Auth i HTTP dostępne do wywołania. Inne typy reguł działania w tle, takie jak Remote Config, TestLab i reguły Analytics, można testować interaktywnie za pomocą zestawów narzędzi, które nie są opisane na tej stronie.

W następnych sekcjach tego samouczka znajdziesz szczegółowe instrukcje kompilowania, testowania i wdrażania przykładowej aplikacji. Jeśli wolisz uruchomić kod i go sprawdzić, przejdź do sekcji Przeglądanie pełnego przykładowego kodu.

Tworzenie projektu Firebase

  1. W konsoli Firebase kliknij Dodaj projekt.

    • Aby dodać zasoby Firebase do istniejącego projektu Google Cloud, wpisz jego nazwę lub wybierz ją z menu.

    • Aby utworzyć nowy projekt, wpisz odpowiednią nazwę. Opcjonalnie możesz też edytować identyfikator projektu wyświetlany pod nazwą projektu.

  2. Jeśli pojawi się taka prośba, zapoznaj się z warunkami usługi Firebase i je zaakceptuj.

  3. Kliknij Dalej.

  4. (Opcjonalnie) Skonfiguruj w swoim projekcie usługę Google Analytics, która pozwoli Ci aby zoptymalizować jedną z następujących usług Firebase:

    Wybierz istniejący Konto Google Analytics lub utworzyć nowe konto.

    Jeśli tworzysz nowe konto, wybierz Analytics lokalizacja raportowania, a następnie zaakceptuj ustawienia udostępniania danych i warunki korzystania z usługi Google Analytics dotyczące Twojego projektu.

  5. Kliknij Utwórz projekt (lub Dodaj Firebase, jeśli używasz istniejący projekt Google Cloud).

Firebase automatycznie udostępnia zasoby dla Twojego projektu Firebase. Po zakończeniu procesu wyświetli się strona podsumowania projektu Firebase w konsoli Firebase.

Skonfiguruj Node.js i interfejs wiersza poleceń Firebase

Do pisania funkcji potrzebujesz środowiska Node.js, i do wdrażania funkcji w interfejsie wiersza poleceń Firebase potrzebny Ci będzie w środowisku wykonawczym Cloud Functions. Aby zainstalować Node.js i npm: Menedżer wersji węzłów .

Po zainstalowaniu Node.js i npm zainstaluj interfejs wiersza poleceń Firebase za pomocą preferowanej metody. Aby zainstalować interfejs wiersza poleceń przy użyciu npm, użyj:

npm install -g firebase-tools

Spowoduje to zainstalowanie polecenia firebase dostępnego na całym świecie. Jeśli nie powiedzie się, może być konieczne zmień uprawnienia npm. Aby zaktualizować aplikację firebase-tools do najnowszej wersji, ponownie uruchom to samo polecenie.

Zainicjuj projekt

Gdy zainicjujesz pakiet SDK Firebase dla aplikacji Cloud Functions, utworzysz pusty projekt zawierający zależności i minimalną ilość przykładowego kodu, a następnie wybierzesz jedną z opcji TypeScript lub JavaScript do tworzenia funkcji. W tym samouczku musisz też zainicjować Cloud Firestore.

Aby zainicjować projekt:

  1. Uruchom firebase login, aby zalogować się w przeglądarce i uwierzytelnić Interfejs wiersza poleceń Firebase.
  2. Przejdź do katalogu projektów Firebase.
  3. Uruchom firebase init firestore. Na potrzeby tego samouczka możesz zaakceptować wartości domyślne, gdy pojawi się prośba o pliki indeksu i reguł Firestore. Jeśli nie używałeś(-aś) usługi Cloud Firestore w tym projekcie, musisz też musisz wybrać tryb początkowy i lokalizację dla Firestore, jak opisano w Pierwsze kroki w Cloud Firestore.
  4. Uruchom firebase init functions. Narzędzie wiersza poleceń wyświetli prośbę o wybranie istniejącej bazy kodu lub zainicjowanie i nazwanie nowej. Na początku wystarczy jedna baza kodu w domyślnej lokalizacji. Później, gdy Twoja implementacja się rozrośnie, możesz uporządkować funkcje w bazach kodu.

  5. Interfejs wiersza poleceń oferuje 2 opcje obsługi języka:

    Na potrzeby tego samouczka wybierz JavaScript.

  6. Interfejs wiersza poleceń umożliwia instalowanie zależności przy użyciu npm. Jest bezpieczna odrzucić, jeśli chcesz zarządzać zależnościami w inny sposób, Jeśli jednak odrzucisz warunki, konieczne będzie uruchomienie programu npm install przed emulacją lub wdrażanie funkcji.

Po wykonaniu tych poleceń struktura projektu będzie wyglądać tak to:

myproject
 +- .firebaserc    # Hidden file that helps you quickly switch between
 |                 # projects with `firebase use`
 |
 +- firebase.json  # Describes properties for your project
 |
 +- functions/     # Directory containing all your functions code
      |
      +- .eslintrc.json  # Optional file containing rules for JavaScript linting.
      |
      +- package.json  # npm package file describing your Cloud Functions code
      |
      +- index.js      # main source file for your Cloud Functions code
      |
      +- node_modules/ # directory where your dependencies (declared in
                       # package.json) are installed

Plik package.json utworzony podczas inicjowania zawiera ważny element klucz: "engines": {"node": "16"}. To ustawienie określa wersję Node.js używaną do zapisywania i wdrażania funkcji. Dostępne opcje wybierz inne obsługiwane wersje.

Zaimportuj wymagane moduły i zainicjuj aplikację

Po wykonaniu zadań konfiguracyjnych możesz otworzyć katalog źródeł i rozpocząć dodawanie kodu zgodnie z instrukcjami podanymi w następnych sekcjach. W tym przykładzie projekt musi zaimportować Moduły Cloud Functions i pakiet Admin SDK używający węzła require wyciągów. Dodaj do pliku index.js wiersze podobne do tych:

// The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
const functions = require('firebase-functions/v1');

// The Firebase Admin SDK to access Firestore.
const admin = require("firebase-admin");
admin.initializeApp();
index.js

Te wiersze ładują moduły firebase-functions i firebase-admin, a także zainicjować instancję aplikacji admin, w której można wprowadzić zmiany w usłudze Cloud Firestore. Wszędzie tam, gdzie jest dostępny pakiet Admin SDK (jak w przypadku FCM, Authentication i Firebase Realtime Database), stanowi on potężne narzędzie do integracji Firebase za pomocą Cloud Functions.

Gdy inicjujesz projekt, wiersz poleceń Firebase automatycznie instaluje pakiet SDK Firebase i Firebase dla modułów Cloud Functions Node. Aby dodać biblioteki innych firm do projektu, możesz zmodyfikować package.json i uruchomić npm install. Więcej informacji: Obsługuj zależności.

Dodaj funkcję addMessage()

W przypadku funkcji addMessage() dodaj do index.js te wiersze:

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addMessage = functions.https.onRequest(async (req, res) => {
  // Grab the text parameter.
  const original = req.query.text;
  // Push the new message into Firestore using the Firebase Admin SDK.
  const writeResult = await admin
    .firestore()
    .collection("messages")
    .add({ original: original });
  // Send back a message that we've successfully written the message
  res.json({ result: `Message with ID: ${writeResult.id} added.` });
});
index.js

Funkcja addMessage() jest punktem końcowym HTTP. Dowolne żądanie skierowane do punktu końcowego w wynikach w stylu ExpressJS Żądanie i odpowiedź obiekty przekazane do Wywołanie zwrotne onRequest().

Funkcje HTTP są synchroniczne (podobnie jak funkcje wywoływane), dlatego odpowiedź należy wysłać tak szybko, jak to możliwe, i odłożyć wykonanie kodu za pomocą funkcji Cloud Firestore. addMessage() Funkcja HTTP przekazuje wartość tekstową do punktu końcowego HTTP i wstawia ją do parametru w bazie danych w ścieżce /messages/:documentId/original.

Dodaj funkcję makeUppercase()

W przypadku funkcji makeUppercase() dodaj te wiersze do funkcji index.js:

// Listens for new messages added to /messages/:documentId/original and creates an
// uppercase version of the message to /messages/:documentId/uppercase
exports.makeUppercase = functions.firestore
  .document("/messages/{documentId}")
  .onCreate((snap, context) => {
    // Grab the current value of what was written to Firestore.
    const original = snap.data().original;

    // Access the parameter `{documentId}` with `context.params`
    functions.logger.log("Uppercasing", context.params.documentId, original);

    const uppercase = original.toUpperCase();

    // You must return a Promise when performing asynchronous tasks inside a Functions such as
    // writing to Firestore.
    // Setting an 'uppercase' field in Firestore document returns a Promise.
    return snap.ref.set({ uppercase }, { merge: true });
  });
index.js

Funkcja makeUppercase() jest wykonywana, gdy do Cloud Firestore jest zapisywany element. Funkcja ref.set definiuje dokument do nasłuchiwania. Aby zwiększyć wydajność, powinny być jak najbardziej szczegółowe.

„Parametry” (czyli znaki wieloznaczne) są otoczone nawiasami klamrowymi (np. {documentId}), które w zwrotnym wywołaniu udostępniają dopasowane dane.

Cloud Firestore wyzwala onCreate(). wywołanie zwrotne po dodaniu nowych wiadomości.

Funkcje oparte na zdarzeniach, takie jak zdarzenia Cloud Firestore, są asynchronicznie. Funkcja wywołania zwrotnego powinna zwrócić null, Object, lub Promise. Jeśli nie zwrócisz niczego, funkcja zostanie przerwana, co spowoduje błąd i ponownie podjęta próba. Zobacz Synchronizacja, asynchroniczność i obietnice.

Emuluj wykonywanie funkcji

Firebase Local Emulator Suiteumożliwia tworzenie i testowanie aplikacji na komputerze lokalnym zamiast wdrażania ich w projekcie Firebase. Zalecamy testowanie lokalne podczas tworzenia aplikacji, ponieważ zmniejsza to ryzyko błędów w kodzie, które mogą potencjalnie generować koszty w środowisku produkcyjnym (np. nieskończona pętla).

Aby emulować funkcje:

  1. Uruchom firebase emulators:start i sprawdź dane wyjściowe pod kątem adresu URL Emulator Suite UI. Domyślnie jest to localhost:4000, ale może być hostowane na innym porcie na komputerze. Wpisz ten adres URL w przeglądarce, aby otworzyć Emulator Suite UI

  2. Sprawdź dane wyjściowe polecenia firebase emulators:start dotyczące adresu URL funkcji HTTP addMessage(). Będzie ona wyglądać podobnie do: http://localhost:5001/MY_PROJECT/us-central1/addMessage, z tym wyjątkiem:

    1. MY_PROJECT zostanie zastąpiony identyfikatorem projektu.
    2. Port może się różnić w zależności od komputera lokalnego.

  3. Dodaj ciąg zapytania ?text=uppercaseme na końcu adresu URL funkcji. Powinna ona wyglądać mniej więcej tak: http://localhost:5001/MY_PROJECT/us-central1/addMessage?text=uppercaseme. Opcjonalnie możesz zmienić wiadomość „uppercaseme” na wiadomość niestandardową.

  4. Utwórz nową wiadomość, otwierając adres URL w nowej karcie przeglądarki.

  5. Wyświetl efekty funkcji w Emulator Suite UI:

    1. Na karcie Logi powinny pojawić się nowe logi wskazujące, że funkcje addMessage() i makeUppercase() zostały wykonane:

      i functions: Beginning execution of "addMessage"

      i functions: Beginning execution of "makeUppercase"

    2. Na karcie Firestore powinien być widoczny dokument zawierający oryginał a także wersję wiadomości pisaną wielkimi literami (jeśli była „WIELKIE LITERY” zobaczysz tylko „WIELKIE LITERY”).

Wdrażanie funkcji w środowisku produkcyjnym

Gdy funkcje w emulatorze będą działać zgodnie z oczekiwaniami, możesz przejść do wdrażaniem, testowaniem i uruchamianiem ich w środowisku produkcyjnym; Pamiętaj aby wdrożyć ją w zalecanym środowisku wykonawczym Node.js 14, musi być objęta abonamentem Blaze. Sprawdź cennikCloud Functions.

Aby ukończyć samouczek, wdróż funkcje, a potem wykonaj funkcję addMessage(), aby aktywować funkcję makeUppercase().

  1. Aby wdrożyć funkcje, uruchom to polecenie:

     firebase deploy --only functions

    Po uruchomieniu tego polecenia interfejs wiersza poleceń Firebase wyświetla adres URL wszystkich punktów końcowych funkcji HTTP. W terminalu powinien pojawić się wiersz podobny do tego:

    Function URL (addMessage): https://us-central1-MY_PROJECT.cloudfunctions.net/addMessage

    Adres URL zawiera identyfikator projektu oraz region dla żądania HTTP . Chociaż nie musisz się tym teraz przejmować, niektóre produkcyjne wersje HTTP funkcje powinny określać lokalizację oraz zminimalizować opóźnienia sieciowe.

    Jeśli wystąpią błędy dostępu, takie jak „Nie można autoryzować dostępu do projektu”, sprawdź aliasy projektu.

  2. Korzystając z adresu URL addMessage() wygenerowanego przez CLI, dodaj parametr zapytania tekstowego i otwórz go w przeglądarce:

    https://us-central1-MY_PROJECT.cloudfunctions.net/addMessage?text=uppercasemetoo

    Funkcja jest wykonywana i przekierowuje przeglądarkę do konsoli Firebase w lokalizacji bazy danych, w której przechowywany jest ciąg tekstowy. To zdarzenie zapisu powoduje wywołanie funkcji makeUppercase(), która zapisuje ciąg znaków w wersji z wielkimi literami.

Po wdrożeniu i wykonywaniu funkcji możesz wyświetlać dzienniki w konsoli Google Cloud. Jeśli musisz usunąć funkcje w środowisku programistycznym lub produkcyjnym, użyj interfejsu wiersza poleceń Firebase.

W środowisku produkcyjnym warto zoptymalizować wydajność funkcji i kontrolę przez ustawienie minimalnej i maksymalnej liczby uruchomionych instancji. Więcej informacji o tych opcjach w czasie wykonywania znajdziesz w artykule Kontrolowanie zachowania skalowania.

Zobacz pełny przykładowy kod

Oto gotowe zadanie functions/index.js zawierające funkcje addMessage() i makeUppercase(). Te funkcje umożliwiają przekazanie parametru do punktu końcowego HTTP, który zapisuje wartość w parametrie Cloud Firestore, a potem przekształca ją, zamieniając wszystkie znaki w ciągu na wielkie litery.

// The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
const functions = require('firebase-functions/v1');

// The Firebase Admin SDK to access Firestore.
const admin = require("firebase-admin");
admin.initializeApp();

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addMessage = functions.https.onRequest(async (req, res) => {
  // Grab the text parameter.
  const original = req.query.text;
  // Push the new message into Firestore using the Firebase Admin SDK.
  const writeResult = await admin
    .firestore()
    .collection("messages")
    .add({ original: original });
  // Send back a message that we've successfully written the message
  res.json({ result: `Message with ID: ${writeResult.id} added.` });
});

// Listens for new messages added to /messages/:documentId/original and creates an
// uppercase version of the message to /messages/:documentId/uppercase
exports.makeUppercase = functions.firestore
  .document("/messages/{documentId}")
  .onCreate((snap, context) => {
    // Grab the current value of what was written to Firestore.
    const original = snap.data().original;

    // Access the parameter `{documentId}` with `context.params`
    functions.logger.log("Uppercasing", context.params.documentId, original);

    const uppercase = original.toUpperCase();

    // You must return a Promise when performing asynchronous tasks inside a Functions such as
    // writing to Firestore.
    // Setting an 'uppercase' field in Firestore document returns a Promise.
    return snap.ref.set({ uppercase }, { merge: true });
  });
index.js

Dalsze kroki

W tej dokumentacji znajdziesz więcej informacji o zarządzaniu funkcjami w przypadku usługi Cloud Functions, a także o obsługiwaniu wszystkich typów zdarzeń obsługiwanych przez usługę Cloud Functions.

Aby dowiedzieć się więcej o stronie Cloud Functions, może też: