Wywołuj funkcje za pomocą żądań HTTP


Możesz aktywować funkcję za pomocą żądania HTTP przy użyciu metody functions.https. Pozwala to wywoływać funkcję synchroniczną 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 aktywuje się, 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 URL i wysyła wynik w odpowiedzi HTTP.

Aktywowanie funkcji za pomocą żądania HTTP

Użyj 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 żądań i odpowiedzi ekspresowych

Obiekt Request używany jako argumenty funkcji onRequest() 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 Google Express

Używając argumentu App (Aplikacja) jako argumentu dla właściwości onRequest(), możesz przekazać do funkcji HTTP pełną aplikację Express. Standardowy kod można przenieść do oprogramowania pośredniczącego, jak w przykładzie:

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 unikalnego adresu URL. Adresy URL zawierają te elementy w kolejności:

  • Region (lub regiony), w którym wdrożono funkcję. W niektórych funkcjach produkcyjnych konieczne może być jawne ustawienie lokalizacji w celu zminimalizowania opóźnienia w sieci.
  • Identyfikator Twojego projektu Firebase
  • cloudfunctions.net
  • Nazwa funkcji

Na przykład adres URL służący do wywołania funkcji date() wygląda tak:

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

Jeśli podczas wdrażania funkcji wystąpią błędy uprawnień, upewnij się, że do użytkownika wykonującego polecenia wdrożenia są przypisane odpowiednie role uprawnień.

W przypadku szybkiego routingu aplikacji jest ona dodawana jako prefiks do ścieżek adresów URL w zdefiniowanej przez Ciebie aplikacji. Przykładowy adres URL do wywoływania metody getter w przykładowej 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, których Google używa do obsługi funkcji HTTP.

Używanie modułów oprogramowania pośredniczącego w Cloud Functions

Jeśli musisz wstawić zależności oprogramowania pośredniczącego na przykład w celu obsługi plików cookie lub CORS, wywołaj je w funkcji. Na przykład, aby włączyć obsługę CORS, dodaj ten blok:

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

Odczyt wartości z żądania

W tabeli poniżej znajdziesz kilka typowych scenariuszy:

Typ treści Treść żądania Sposób działania
application/json '{"name":"John"}' request.body.name równa się „Jan”
application/octet-stream „mój tekst” request.body równa się „6d792074657874” (nieprzetworzone bajty żądania – patrz dokumentacja 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 równa się „Jan”

Tę analizę wykonują te parsery treści:

Załóżmy, że funkcja jest wywoływana 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"}'

wysłane dane będą widoczne jako:

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

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

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

Zatrzymywanie funkcji HTTP

Zawsze kończ funkcję HTTP wartością send(), redirect() lub end(). W przeciwnym razie Twoja funkcja może nadal działać i zostać wymuszona przez system. Zapoznaj się też z sekcją Synchronizowanie, asynchroniczne i obiecywanie.

Po pobraniu i sformatowaniu czasu serwera za pomocą modułu Node.js moment funkcja date() kończy, 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 w witrynie Hostingu Firebase mogą być przesyłane przez serwery proxy 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.