Funkcję możesz aktywować za pomocą żądania HTTP, używając funkcji functions.https. Dzięki temu możesz wywoływać funkcję synchroniczną za pomocą
te obsługiwane metody HTTP: GET, POST, PUT, DELETE i
OPTIONS.
Przykłady na tej stronie oparte na:
funkcja przykładowa
uruchamiany, gdy wysyłasz
żądanie HTTP GET do punktu końcowego funkcji. Przykładowa funkcja pobiera bieżący czas serwera, formatuje go zgodnie z parametrem zapytania w adresie URL i wysyła wynik w odpowiedzi HTTP.
Aktywowanie funkcji za pomocą żądania HTTP
Użyj formatu functions.https
aby utworzyć funkcję, która obsługuje HTTP
zdarzeń. Obsługa zdarzenia dla funkcji HTTP wykrywa zdarzenie onRequest(), które obsługuje routery i aplikacje zarządzane przez platformę internetową Express.
Korzystanie z obiektów żądań i odpowiedzi Express
Obiekt Request, który jest używany jako argument funkcji onRequest(), zapewnia dostęp do właściwości żądania HTTP wysłanego przez klienta, a obiekt Response umożliwia wysłanie odpowiedzi do klienta.
exports.date = functions.https.onRequest((req, res) => { // ... });
Korzystanie z istniejących aplikacji Express
Używanie App jako argumentu
onRequest(), możesz
przekazać pełną aplikację ekspresową do funkcji HTTP. Powtarzalny kod można przenieść do oprogramowania pośredniczącego w ten sposób:
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ływanie funkcji HTTP
Po wdrożeniu funkcji HTTP możesz ją wywołać za pomocą jej własnego adresu URL. Adres URL zawiera w kolejności:
- Region (lub regiony), w którym wdrożono funkcję. Niektóre produkcje funkcje mogą wymagać wyraźnego ustawienia atrybutu lokalizacja w celu zminimalizowania opóźnień sieciowych.
- Identyfikator Twojego projektu Firebase
cloudfunctions.net- Nazwa funkcji
Adres URL wywołania date() może wyglądać na przykład tak:
https://us-central1-<project-id>.cloudfunctions.net/date
Jeśli podczas wdrażania funkcji wystąpią błędy uprawnień, upewnij się, odpowiednie role uprawnień są przypisaną do użytkownika wykonującego polecenia wdrożeniowe.
W przypadku szybkiego kierowania aplikacji nazwa funkcji jest dodawana jako prefiks do ścieżek URL w określonej przez Ciebie aplikacji. Na przykład adres URL wywołania gettera w przykładzie aplikacji Express powyżej wygląda tak:
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, których Google używa do obsługi funkcji HTTP.
Używanie modułów oprogramowania pośredniczącego w Cloud Functions
Jeśli musisz wstrzyknąć zależności oprogramowania pośredniczącego np. w obsłudze plików cookie czy CORS, wywołaj je w funkcji. Aby na przykład 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 tabeli poniżej znajdziesz kilka typowych scenariuszy:| Typ treści | Treść żądania | Zachowanie |
|---|---|---|
application/json |
'{"name":"John"}' |
request.body.name to „Jan”. |
application/octet-stream |
„mój tekst” | request.body równa się „6d792074657874” (nieprzetworzone bajty żądania; zapoznaj się z dokumentacją bufora Node.js) |
text/plain |
„mój tekst” | request.body równa się „mój tekst” |
application/x-www-form-urlencoded |
'name=John' | request.body.name to „Jan”. |
Analiza ta jest wykonywana przez te moduły parsowania treści:
- Parsowanie treści w formacie JSON
- Parsowanie nieprzetworzonego tekstu
- Parsowanie tekstu
- parser treści formularza zakodowany w adresie URL
Załóżmy, że Twoja funkcja jest wywoływana za pomocą następującego żądania:
curl -X POST -H "Content-Type:application/json" -H "X-MyHeader: 123" YOUR_HTTP_TRIGGER_ENDPOINT?foo=baz -d '{"text":"something"}'
wtedy wysłane dane zostaną zmaterializowane w ramach:
| Właściwość/metoda | Wartość |
|---|---|
req.method |
„POST” |
req.get('x-myheader') |
„123” |
req.query.foo |
„baz” |
req.body.text |
„coś” |
req.rawBody |
Nieprzetworzone bajty żądania |
W przykładzie funkcji date() funkcja sprawdza zarówno parametr adresu URL, jak i tekst w polu „body” pod kątem wartości format, aby ustawić format daty/godziny:
let format = req.query.format; format = req.body.format;
Zakończ funkcje HTTP
Zawsze kończ funkcję HTTP ciągiem send(), redirect(),
lub end(). W przeciwnym razie funkcja może być nadal uruchomiona
może zostać wymuszone przez system. Zobacz też
Synchronizacja, asynchronizacja i obietnice.
Po pobraniu i sformatowaniu czasu serwera za pomocą modułu Node.js moment 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);
Łączenie funkcji HTTP z Firebase Hosting
Z funkcją Firebase Hosting możesz połączyć funkcję HTTP. Żądania w witrynie Firebase Hosting mogą być przekierowywane do określonych funkcji HTTP. To także umożliwia użycie własnej domeny z funkcją HTTP. Więcej informacji o Łączę aplikację Cloud Functions z usługą Firebase Hosting.