Mit functions.https
können Sie eine Funktion über eine HTTP-Anfrage auslösen. So können Sie eine synchrone Funktion über die folgenden unterstützten HTTP-Methoden aufrufen: GET
, POST
, PUT
, DELETE
und OPTIONS
.
Die Beispiele auf dieser Seite basieren auf einer Beispielfunktion, die ausgelöst wird, wenn Sie eine HTTP-GET
-Anfrage an den Endpunkt der Funktion senden. Die Beispielfunktion ruft die aktuelle Serverzeit ab, formatiert die Zeit gemäß den Angaben in einem URL-Suchparameter und sendet das Ergebnis in der HTTP-Antwort.
Funktion mit einer HTTP-Anfrage auslösen
Verwenden Sie functions.https
, um eine Funktion zu erstellen, die HTTP-Ereignisse verarbeitet. Der Ereignis-Handler für eine HTTP-Funktion wartet auf das Ereignis onRequest()
, das Router und Apps unterstützt, die vom Express-Webframework verwaltet werden.
Express-Anfrage- und Antwortobjekte verwenden
Das Objekt Request wird als Argumente für onRequest()
verwendet und bietet Zugriff auf die Attribute der vom Client gesendeten HTTP-Anfrage. Mit dem Objekt Response können Sie eine Antwort an den Client zurücksenden.
exports.date = functions.https.onRequest((req, res) => { // ... });
Vorhandene Express-Apps verwenden
Wenn Sie App als Argument für onRequest()
verwenden, können Sie eine vollständige Express-Anwendung an eine HTTP-Funktion übergeben. Boilerplate-Code kann wie hier gezeigt in die Middleware verschoben werden:
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);
HTTP-Funktion aufrufen
Nachdem Sie eine HTTP-Funktion bereitgestellt haben, können Sie sie über eine eigene eindeutige URL aufrufen. Die URL enthält Folgendes in der angegebenen Reihenfolge:
- Die Region (en), in denen Sie die Funktion bereitgestellt haben. Bei einigen Produktionsfunktionen muss der Standort möglicherweise explizit festgelegt werden, um die Netzwerklatenz zu minimieren.
- Ihre Firebase-Projekt-ID
cloudfunctions.net
- Der Name Ihrer Funktion
Die URL zum Aufrufen von date()
sieht beispielsweise so aus:
https://us-central1-<project-id>.cloudfunctions.net/date
Wenn beim Bereitstellen von Funktionen Berechtigungsfehler auftreten, prüfen Sie, ob dem Nutzer, der die Bereitstellungsbefehle ausführt, die entsprechenden IAM-Rollen zugewiesen sind.
Bei der Express-App-Weiterleitung wird der Funktionsname den URL-Pfaden in der von Ihnen definierten App als Präfix hinzugefügt. Die URL zum Aufrufen des Getters in der Beispiel-Express-Anwendung oben sieht beispielsweise so aus:
https://us-central1-<project-id>.cloudfunctions.net/widgets/<id>
Wenn Sie HTTP-Funktionen hinter einer Firewall oder einem IP-Filter aufrufen, können Sie die IP-Adressen abrufen, die Google zum Bereitstellen von HTTP-Funktionen verwendet.
Middleware-Module mit Cloud Functions verwenden
Wenn Sie Middleware-Abhängigkeiten für Dinge wie Cookie-Unterstützung oder CORS einfügen müssen, rufen Sie diese innerhalb der Funktion auf. Fügen Sie beispielsweise den folgenden Block hinzu, um die CORS-Unterstützung zu aktivieren:
// Enable CORS using the `cors` express middleware. cors(req, res, () => { // ... });
Werte aus der Anfrage lesen
In der folgenden Tabelle sind einige gängige Szenarien aufgeführt:Inhaltstyp | Anfragetext | Verhalten |
---|---|---|
application/json |
'{"name":"John"}' |
request.body.name entspricht „John“ |
application/octet-stream |
'my text' | request.body entspricht „6d792074657874“ (die Rohbyte der Anfrage; siehe die Dokumentation zum Node.js-Zwischenspeicher). |
text/plain |
"mein Text" | request.body ist gleich „mein Text“ |
application/x-www-form-urlencoded |
'name=Max' | request.body.name entspricht „John“ |
Dieses Parsen wird von den folgenden Textparsern durchgeführt:
Angenommen, Ihre Funktion wird mit der folgenden Anfrage aufgerufen:
curl -X POST -H "Content-Type:application/json" -H "X-MyHeader: 123" YOUR_HTTP_TRIGGER_ENDPOINT?foo=baz -d '{"text":"something"}'
werden die gesendeten Daten folgendermaßen materialisiert:
Eigenschaft/Methode | Wert |
---|---|
req.method |
"POST" |
req.get('x-myheader') |
„123“ |
req.query.foo |
„baz“ |
req.body.text |
„etwas“ |
req.rawBody |
Die Roh- (nicht geparsten) Byte der Anfrage |
Im Beispiel für die date()
-Funktion wird sowohl der URL-Parameter als auch der Textkörper auf einen format
-Wert geprüft, um das zu verwendende Datums-/Uhrzeitformat festzulegen:
let format = req.query.format; format = req.body.format;
HTTP-Funktionen beenden
Beenden Sie eine HTTP-Funktion immer mit send()
, redirect()
oder end()
. Andernfalls wird Ihre Funktion möglicherweise weiterhin ausgeführt und vom System zwangsweise beendet. Siehe auch Synchronisieren, asynchron und verspricht.
Nachdem die Serverzeit mit dem Node.js-Modul moment
abgerufen und formatiert wurde, wird die date()
-Funktion beendet, indem das Ergebnis in der HTTP-Antwort gesendet wird:
const formattedDate = moment().format(`${format}`); functions.logger.log('Sending Formatted date:', formattedDate); res.status(200).send(formattedDate);
HTTP-Funktionen mit Firebase Hosting verbinden
Sie können eine HTTP-Funktion mit Firebase Hosting verknüpfen. Anfragen auf deiner Firebase Hosting-Website können an bestimmte HTTP-Funktionen weitergeleitet werden. So können Sie auch Ihre eigene benutzerdefinierte Domain mit einer HTTP-Funktion verwenden. Weitere Informationen zum Verbinden von Cloud Functions mit Firebase Hosting