Wywołaj funkcje za pośrednictwem żądań HTTP


Funkcję można uruchomić za pomocą żądania HTTP, korzystając z functions.https . Umożliwia to wywołanie funkcji synchronicznej za pomocą następujących obsługiwanych metod HTTP: GET , POST , PUT , DELETE i OPTIONS .

Przykłady na tej stronie opierają się na przykładowej funkcji , która jest wyzwalana po wysłaniu żądania HTTP GET do punktu końcowego funkcji. Przykładowa funkcja pobiera bieżący czas serwera, formatuje czas zgodnie z parametrem zapytania adresu URL i wysyła wynik w odpowiedzi HTTP.

Wywołaj funkcję za pomocą żądania HTTP

Użyj functions.https , aby utworzyć funkcję obsługującą zdarzenia HTTP. Procedura obsługi zdarzeń dla funkcji HTTP nasłuchuje zdarzenia onRequest() , które obsługuje routery i aplikacje zarządzane przez platformę internetową Express .

Korzystanie z obiektów ekspresowych żądań i odpowiedzi

Używany jako argumenty funkcji onRequest() obiekt Request zapewnia dostęp do właściwości żądania HTTP wysłanego przez klienta, a obiekt Response umożliwia wysłanie odpowiedzi z powrotem do klienta.

exports.date = functions.https.onRequest((req, res) => {
  // ...
});

Korzystanie z istniejących aplikacji Express

Używając App jako argumentu onRequest() , możesz przekazać pełną aplikację Express do funkcji HTTP. Kod standardowy można przenieść do oprogramowania pośredniego, jak pokazano:

const express = require('express');
const cors = require('cors');

const app = express();

// Automatically allow cross-origin requests
app.use(cors({ origin: true }));

// Add middleware to authenticate requests
app.use(myMiddleware);

// build multiple CRUD interfaces:
app.get('/:id', (req, res) => res.send(Widgets.getById(req.params.id)));
app.post('/', (req, res) => res.send(Widgets.create()));
app.put('/:id', (req, res) => res.send(Widgets.update(req.params.id, req.body)));
app.delete('/:id', (req, res) => res.send(Widgets.delete(req.params.id)));
app.get('/', (req, res) => res.send(Widgets.list()));

// Expose Express API as a single Cloud Function:
exports.widgets = functions.https.onRequest(app);

Wywołaj funkcję HTTP

Po wdrożeniu funkcji HTTP można ją wywołać za pośrednictwem jej własnego, unikalnego adresu URL. Adres URL zawiera w kolejności następujące elementy:

  • Region (lub regiony), w którym wdrożono funkcję. Niektóre funkcje produkcyjne mogą wymagać jawnego ustawienia lokalizacji , aby zminimalizować opóźnienia sieci.
  • Twój identyfikator projektu Firebase
  • cloudfunctions.net
  • Nazwa Twojej funkcji

Na przykład adres URL wywołujący funkcję date() wygląda następująco:

https://us-central1-<project-id>.cloudfunctions.net/date

Jeśli podczas wdrażania funkcji napotkasz błędy uprawnień, upewnij się, że użytkownikowi uruchamiającemu polecenia wdrażania przypisano odpowiednie role IAM .

W przypadku ekspresowego routingu aplikacji nazwa funkcji jest dodawana jako przedrostek do ścieżek URL w zdefiniowanej aplikacji. Na przykład adres URL wywołujący moduł pobierający w powyższym przykładzie aplikacji Express wygląda następująco:

https://us-central1-<project-id>.cloudfunctions.net/widgets/<id>

Jeśli wywołujesz funkcje HTTP za zaporą sieciową lub filtrem IP, możesz sprawdzić adresy IP używane przez Google do obsługi funkcji HTTP.

Używaj modułów oprogramowania pośredniego z Cloud Functions

Jeśli chcesz wstrzyknąć zależności oprogramowania pośredniego na potrzeby obsługi plików cookie lub CORS, wywołaj je w ramach funkcji. Na przykład, aby włączyć obsługę CORS, dodaj następujący blok:

// Enable CORS using the `cors` express middleware.
cors(req, res, () => {
  // ...
});

Odczytaj wartości z żądania

W poniższej tabeli wymieniono kilka typowych scenariuszy:

Typ zawartości Treść żądania Zachowanie
application/json '{"name":"John"}' request.body.name równa się „John”
application/octet-stream „mój tekst” request.body równa się „6d792074657874” (nieprzetworzone bajty żądania; zobacz dokumentację bufora Node.js )
text/plain „mój tekst” request.body równa się „mój tekst”
application/x-www-form-urlencoded „imię = Jan” request.body.name równa się „John”

Ta analiza jest wykonywana przez następujące analizatory treści:

Załóżmy, że funkcja zostanie wywołana z następującym żądaniem:

curl -X POST -H "Content-Type:application/json" -H "X-MyHeader: 123" YOUR_HTTP_TRIGGER_ENDPOINT?foo=baz -d '{"text":"something"}'

wówczas przesłane dane zostałyby zmaterializowane pod:

Właściwość/metoda Wartość
req.method "POST"
req.get('x-myheader') „123”
req.query.foo „baza”
req.body.text "coś"
req.rawBody Surowe (nieprzeanalizowane) bajty żądania

W przykładzie funkcji date() funkcja testuje zarówno parametr adresu URL, jak i treść pod kątem wartości format , aby ustawić używany format daty/godziny:

let format = req.query.format;
format = req.body.format;

Zakończ funkcje HTTP

Zawsze kończ funkcję HTTP za pomocą send() , redirect() lub end() . W przeciwnym razie funkcja może nadal działać i zostać wymuszona przez system. Zobacz także Synchronizacja, Asynchronizacja i Obietnice .

Po pobraniu i sformatowaniu czasu serwera za pomocą modułu moment Node.js, funkcja date() kończy się wysłaniem wyniku w odpowiedzi HTTP:

const formattedDate = moment().format(`${format}`);
functions.logger.log('Sending Formatted date:', formattedDate);
res.status(200).send(formattedDate);

Podłączanie funkcji HTTP do hostingu Firebase

Możesz podłączyć funkcję HTTP do Hostingu Firebase. Żądania w witrynie Firebase Hosting mogą być przekazywane do określonych funkcji HTTP. Umożliwia to również użycie własnej domeny niestandardowej z funkcją HTTP. Dowiedz się więcej o łączeniu Cloud Functions z Hostingiem Firebase .