Możesz aktywować funkcję za pomocą żądania HTTP za pomocą functions.https. Umożliwia to wywoływanie funkcji synchronicznej za pomocą tych 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, gdy wysyłasz żądanie HTTP GET do punktu końcowego funkcji. Przykładowa funkcja pobiera bieżący czas serwera, formatuje godzinę zgodnie z parametrem zapytania URL i wysyła wynik w odpowiedzi HTTP.
Aktywowanie funkcji za pomocą żądania HTTP
Użyj narzędzia functions.https, aby utworzyć funkcję, która obsługuje zdarzenia HTTP. Moduł obsługi zdarzeń 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
Obiekt Request używany jako argumenty 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żywając App jako argumentu onRequest(), możesz przekazać pełną aplikację Express do funkcji HTTP. Stały 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ć z jej unikalnego adresu URL. Adres URL zawiera te elementy w kolejności:
- Region (lub regiony), w którym wdrożono funkcję. Niektóre funkcje produkcyjne mogą wymagać jawnego ustawienia lokalizacji w celu zminimalizowania opóźnień sieciowych.
- Identyfikator Twojego projektu Firebase
cloudfunctions.net- Nazwa funkcji
Na przykład URL wywołujący date() wygląda tak:
https://us-central1-<project-id>.cloudfunctions.net/date
Jeśli podczas wdrażania funkcji wystąpią błędy uprawnień, sprawdź, czy do użytkownika wykonującego polecenia wdrożeniowe są przypisane odpowiednie role uprawnień.
W przypadku szybkiego routingu aplikacji nazwa funkcji jest dodawana jako prefiks do ścieżek adresów URL w określonej aplikacji. Na przykład URL wywołujący metodę pobierania w przykładzie powyżej w aplikacji Express 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 wyszukać adresy IP używane przez Google 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 przypadku obsługi plików cookie czy CORS, wywołaj je w tej funkcji. Aby na przykład włączyć obsługę CORS, dodaj ten blok:
// Enable CORS using the `cors` express middleware.
cors(req, res, () => {
// ...
});
Odczytaj wartości z żądania
W poniższej tabeli znajdziesz kilka typowych scenariuszy:| Typ treści | Treść żądania | Sposób działania |
|---|---|---|
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=Jan” | request.body.name to „Jan” |
Analiza jest wykonywana przez te parsery treści:
- Parser treści JSON
- Parser surowego ciała
- parser treści 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"}'
wówczas wysłane dane będą materializowane w następujący sposób:
| Właściwość/metoda | Wartość |
|---|---|
req.method |
„POST” |
req.get('x-myheader') |
„123” |
req.query.foo |
„baz” |
req.body.text |
„coś” |
req.rawBody |
Nieprzetworzone (nieprzeanalizowane) bajty żądania |
W przykładowej funkcji date() funkcja sprawdza pod kątem wartości format parametr URL i treść, 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 nadal działać, a jej zakończenie zostanie wymuszone przez system. Zapoznaj się też z sekcją Synchronizacja, asynchronizacja i obietnice.
Po pobraniu i sformatowaniu czasu serwera za pomocą modułu Node.js moment funkcja date() kończy działanie, wysyłając wynik w odpowiedzi HTTP:
const formattedDate = moment().format(`${format}`);
functions.logger.log('Sending Formatted date:', formattedDate);
res.status(200).send(formattedDate);
Łączenie funkcji HTTP z Hostingiem Firebase
Możesz połączyć funkcję HTTP z Hostingiem Firebase. Żądania z witryny Hostingu Firebase można przekazywać przez serwer proxy do określonych funkcji HTTP. Pozwala to również używać własnej domeny z funkcją HTTP. Dowiedz się więcej o łączeniu Cloud Functions z Hostingiem Firebase.