קריאה לפונקציות דרך בקשות HTTP

אפשר להפעיל פונקציה באמצעות בקשת HTTP עם handler של בקשה. כך אפשר להפעיל פונקציה באמצעות שיטות ה-HTTP הנתמכות הבאות: GET,‏ POST,‏ PUT,‏ DELETE ו-OPTIONS.

במדריך הזה אנחנו יוצאים מנקודת הנחה שביצעתם את משימות ההגדרה שמתוארות במדריך לתחילת העבודה עם Node.js ו-Python או את משימות ההגדרה של Dart SDK הניסיוני.

אפשרויות HTTP נוספות

אפשרות	תיאור
`region`	פונקציות HTTP יכולות לציין מערך של אזורים וגם אזור יחיד. כשמציינים כמה אזורים, מתבצע פריסה של מופע פונקציה נפרד לכל אזור.
‫`timeoutSeconds` (`timeout_sec` ל-Python)	פונקציות HTTP יכולות לציין זמן קצוב לתפוגה של עד שעה.
`cors`	פונקציות HTTP יכולות לציין מדיניות CORS. אפשר להגדיר את הערך הזה ל-`true` כדי לאפשר את כל המקורות, או ל-`string`, `regex` או `array` כדי לציין מקורות מותרים. אם לא מגדירים במפורש, ברירת המחדל היא false או ללא מדיניות CORS.

הגדרת שיתוף משאבים בין מקורות (CORS)

משתמשים באפשרות cors כדי לקבוע לאילו מקורות תהיה גישה לפונקציה. כברירת מחדל, פונקציות HTTP לא מוגדרות עם CORS, כלומר כל בקשת CORS לפונקציה שלכם תגרום לשגיאה הבאה:

request has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource.

אפשר גם להשבית את CORS באופן מפורש על ידי הגדרת האפשרות cors לערך false בפונקציה.

כדי לאפשר חלק מהבקשות חוצות המקורות, אבל לא את כולן, אפשר להעביר רשימה של דומיינים ספציפיים או ביטויים רגולריים שצריך לאפשר. לדוגמה, אם אתם הבעלים של הדומיינים firebase.com ו-flutter.com, ויכולים להיות לתת-הדומיין firebase.com תתי-דומיין רבים, יכול להיות שתרצו להגדיר את האפשרות cors כמו שמוצג כאן:

Node.js

const { onRequest } = require("firebase-functions/v2/https");

exports.sayHello = onRequest(
  { cors: [/firebase\.com$/, "https://flutter.com"] },
  (req, res) => {
    res.status(200).send("Hello world!");
  }
);

Python

from firebase_functions import https_fn, options

@https_fn.on_request(
    cors=options.CorsOptions(
        cors_origins=[r"firebase\.com$", r"https://flutter\.com"],
        cors_methods=["get", "post"],
    )
)
def say_hello(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello world!")

Dart (ניסיוני)

import 'package:firebase_functions/firebase_functions.dart';

void main(List<String> args) {
  fireUp(args, (firebase) {
    firebase.https.onRequest(
      name: 'sayHello',
      options: const HttpsOptions(
        cors: Cors([RegExp(r'^https:\/\/firebase\.com$'), 'https://flutter.com']),
      ),
      (request) async => Response(200, body: 'Hello world!'),
    );
  });
}

אם הפונקציה שלכם צריכה להיות זמינה לכולם, למשל אם היא מציגה API ציבורי או אתר, צריך להגדיר את המדיניות cors לערך true.

הפעלת פונקציה באמצעות בקשת HTTP

משתמשים ב-request handler של הפלטפורמה כדי ליצור פונקציה שמטפלת באירועי HTTP. הדוגמאות בקטע הזה מבוססות על דוגמה של 'שרת זמן' שמופעלת כששולחים בקשת HTTP GET לנקודת הקצה של הפונקציות. הפונקציה sample מאחזרת את השעה הנוכחית בשרת, מעצבת את השעה כפי שמצוין בפרמטר של שאילתת כתובת URL ושולחת את התוצאה בתגובת ה-HTTP.

שימוש באובייקטים של בקשות ותגובות

אובייקט הבקשה מאפשר לכם לגשת למאפיינים של בקשת ה-HTTP שנשלחה על ידי הלקוח, ואובייקט התגובה מאפשר לכם לשלוח תגובה בחזרה ללקוח.

Node.js

exports.date = onRequest(
    {timeoutSeconds: 1200, region: ["us-west1", "us-east1"]},
    (req, res) => {
// ...
});

Python

@https_fn.on_request(cors=options.CorsOptions(cors_origins="*", cors_methods=["get", "post"]))
def date(req: https_fn.Request) -> https_fn.Response:
    """Get the server's local date and time."""main.py

Dart (ניסיוני)

void main(List<String> args) async {
  await fireUp(args, (firebase) {
    firebase.https.onRequest(name: 'date', (request) async {server.dart

שימוש באפליקציות קיימות של Express או Flask

אפשר להעביר אפליקציה מלאה לפונקציית HTTP באמצעות האפליקציה כארגומנט של handler הבקשות:

Node.js

const { onRequest } = require('firebase-functions/v2/https');

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

// 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 = onRequest(app);

Python

from firebase_admin import initialize_app, db
from firebase_functions import https_fn
import flask

initialize_app()
app = flask.Flask(__name__)

# Build multiple CRUD interfaces:


@app.get("/widgets")
@app.get("/widgets/<id>")
def get_widget(id=None):
    if id is not None:
        return db.reference(f"/widgets/{id}").get()
    else:
        return db.reference("/widgets").get()


@app.post("/widgets")
def add_widget():
    new_widget = flask.request.get_data(as_text=True)
    db.reference("/widgets").push(new_widget)
    return flask.Response(status=201, response="Added widget")


# Expose Flask app as a single Cloud Function:


@https_fn.on_request()
def httpsflaskexample(req: https_fn.Request) -> https_fn.Response:
    with app.request_context(req.environ):
        return app.full_dispatch_request()main.py

הפעלת פונקציית HTTP

אחרי שפורסים פונקציית HTTP, אפשר להפעיל אותה באמצעות כתובת URL ייחודית משלה. אחרי הפריסה, משתמשים בכתובת ה-URL המדויקת שמוצגת ב-CLI.

לדוגמה, כתובת ה-URL להפעלת date() נראית כך:

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

בניתוב אפליקציות ב-Express וב-Flask, שם הפונקציה מתווסף כקידומת לנתיבי כתובות ה-URL באפליקציה שאתם מגדירים.

קריאת ערכים מהבקשה

בדוגמה של הפונקציה date(), הפונקציה בודקת גם את פרמטר כתובת ה-URL וגם את הגוף כדי למצוא ערך format ולהגדיר את פורמט התאריך והשעה לשימוש:

Node.js

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

Python

format = req.args["format"] if "format" in req.args else Nonemain.py

Dart (ניסיוני)

var format = request.url.queryParameters['format'];
final bodyString = await request.readAsString();
try {
  if (bodyString.isNotEmpty) {
    final body = jsonDecode(bodyString) as Map<String, dynamic>;
    format = body['format'] as String?;
  }
} catch (e) {
  return Response.badRequest(body: 'invalid JSON');
}server.dart

הפסקת פונקציות HTTP

אחרי שליפת זמן השרת ועיצובו, הפונקציה date() מסיימת את הפעולה בשליחת התוצאה בתגובת ה-HTTP:

Node.js

תמיד מסיימים פונקציית HTTP עם send(), redirect() או end(). אחרת, יכול להיות שהפונקציה תמשיך לפעול והמערכת תפסיק אותה בכוח. אפשר לעיין גם במאמר Sync, Async and Promises (סנכרון, אסינכרון והבטחות).

const formattedDate = moment().format(`${format}`);
logger.log("Sending formatted date:", formattedDate);
res.status(200).send(formattedDate);index.js

Python

formatted_date = datetime.now().strftime(format)
print(f"Sending Formatted date: {formatted_date}")
return https_fn.Response(formatted_date)main.py

Dart (ניסיוני)

final formattedDate = DateFormat(format).format(DateTime.now());
print('Sending formatted date: $formattedDate');
return Response.ok(formattedDate);server.dart

שילוב עם אירוח ב-Firebase

אפשר לקשר פונקציית HTTP אל Firebase Hosting. אפשר להעביר בקשות באתר Firebase Hosting באמצעות פרוקסי לפונקציות HTTP ספציפיות. בנוסף, תוכלו להשתמש בדומיין מותאם אישית משלכם עם פונקציית HTTP. מידע נוסף על חיבור Cloud Functions אל Firebase Hosting

קריאה לפונקציות דרך בקשות HTTP קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

אפשרויות HTTP נוספות

הגדרת שיתוף משאבים בין מקורות (CORS)

Node.js

Python

Dart (ניסיוני)

הפעלת פונקציה באמצעות בקשת HTTP

שימוש באובייקטים של בקשות ותגובות

Node.js

Python

Dart (ניסיוני)

שימוש באפליקציות קיימות של Express או Flask

Node.js

Python

הפעלת פונקציית HTTP

קריאת ערכים מהבקשה

Node.js

Python

Dart (ניסיוני)

הפסקת פונקציות HTTP

Node.js

Python

Dart (ניסיוני)

שילוב עם אירוח ב-Firebase

קריאה לפונקציות דרך בקשות HTTP