קריאה לפונקציות מהאפליקציה

דור שני דור ראשון

ערכות ה-SDK של הלקוח ב-Cloud Functions for Firebase מאפשרות להפעיל פונקציות ישירות מאפליקציית Firebase. כדי להפעיל פונקציה מהאפליקציה באופן הזה, כותבים ומפרסים פונקציה ניתנת לקריאה ב-HTTP ב-Cloud Functions, ואז מוסיפים לוגיקה של לקוח כדי להפעיל את הפונקציה מהאפליקציה.

חשוב לזכור שפונקציות קריאה ל-HTTP דומות לפונקציות HTTP, אבל לא זהות להן. כדי להשתמש בפונקציות שניתן להפעיל באמצעות HTTP, צריך להשתמש ב-SDK של הלקוח בפלטפורמה שלכם יחד עם ה-API לקצה העורפי (או להטמיע את הפרוטוקול). ל-callables יש את ההבדלים העיקריים הבאים מפונקציות HTTP:

• כשמשתמשים ב-callables, אסימוני Firebase Authentication, אסימוני FCM ואסימוני App Check, אם הם זמינים, נכללים באופן אוטומטי בבקשות.
• הטריגר מבצע באופן אוטומטי דה-סריאליזציה של גוף הבקשה ומאמת את אסימוני האימות.

ערכת ה-SDK של Firebase ל-Cloud Functions מדור שני ואילך פועלת בשילוב עם הגרסאות המינימליות הבאות של Firebase SDK ללקוח, כדי לתמוך בפונקציות Callable של HTTPS:

• Firebase SDK לפלטפורמות Apple 11.6.0
• Firebase SDK עבור Android 21.1.0
• Firebase Modular Web SDK גרסה 9.7.0

אם רוצים להוסיף פונקציונליות דומה לאפליקציה שנוצרה בפלטפורמה שאינה נתמכת, אפשר לעיין במפרט הפרוטוקול של https.onCall. בהמשך המדריך מפורטות הוראות לכתיבת פונקציה ניתנת לקריאה ב-HTTP, לפריסה שלה ולקריאה אליה בפלטפורמות של Apple, ב-Android, באינטרנט, ב-C++‎ וב-Unity.

כתיבת הפונקציה שניתן לבצע קריאה אליה ופריסה שלה

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

Node.js

// Dependencies for callable functions.
const {onCall, HttpsError} = require("firebase-functions/v2/https");
const {logger} = require("firebase-functions/v2");

// Dependencies for the addMessage function.
const {getDatabase} = require("firebase-admin/database");
const sanitizer = require("./sanitizer");
index.js

Python

# Dependencies for callable functions.
from firebase_functions import https_fn, options

# Dependencies for writing to Realtime Database.
from firebase_admin import db, initialize_app
main.py

משתמשים בבורר הבקשות של הפלטפורמה (functions.https.onCall) או ב-on_call כדי ליצור פונקציה שניתן להפעיל אותה באמצעות HTTPS. לשיטה הזו מצורף פרמטר של בקשה:

Node.js

// Saves a message to the Firebase Realtime Database but sanitizes the
// text by removing swearwords.
exports.addmessage = onCall((request) => {
  // ...
});
index.js

Python

@https_fn.on_call()
def addmessage(req: https_fn.CallableRequest) -> Any:
    """Saves a message to the Firebase Realtime Database but sanitizes the text
    by removing swear words."""
main.py

הפרמטר request מכיל נתונים שהועברו מאפליקציית הלקוח, וגם הקשר נוסף כמו מצב האימות. לדוגמה, בפונקציה שניתן להפעיל ששומרת הודעת טקסט ב-Realtime Database, השדה data יכול להכיל את טקסט ההודעה, יחד עם פרטי האימות ב-auth:

Node.js

// Message text passed from the client.
const text = request.data.text;
// Authentication / user information is automatically added to the request.
const uid = request.auth.uid;
const name = request.auth.token.name || null;
const picture = request.auth.token.picture || null;
const email = request.auth.token.email || null;
index.js

Python

# Message text passed from the client.
text = req.data["text"]
main.py
# Authentication / user information is automatically added to the request.
uid = req.auth.uid
name = req.auth.token.get("name", "")
picture = req.auth.token.get("picture", "")
email = req.auth.token.get("email", "")
main.py

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

אפשר גם לצרף אימות App Check כדי להגן על המשאבים בקצה העורפי מפני ניצול לרעה, כמו הונאות חיוב או פישינג. למידע נוסף, ראו הפעלת אכיפת App Check ב-Cloud Functions.

הערה: כדי לכתוב פונקציות שניתן להפעיל, צריך להשתמש רק בממשקי ה-API לקצה העורפי functions.https או firebase_functions.https_fn. ה-API של טריגר ה-HTTP הוא נפרד לחלוטין ואין לו יכולת פעולה הדדית עם פונקציות שניתן לקרוא להן.

שליחת התוצאה חזרה

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

Node.js

// returning result.
return {
  firstNumber: firstNumber,
  secondNumber: secondNumber,
  operator: "+",
  operationResult: firstNumber + secondNumber,
};
index.js

Python

return {
    "firstNumber": first_number,
    "secondNumber": second_number,
    "operator": "+",
    "operationResult": first_number + second_number
}
main.py

הטקסט המטוהר מהדוגמה לטקסט של ההודעה מוחזר גם ללקוח וגם ל-Realtime Database. ב-Node.js אפשר לעשות זאת באופן אסינכרוני באמצעות הבטחה של JavaScript:

Node.js

// Saving the new message to the Realtime Database.
const sanitizedMessage = sanitizer.sanitizeText(text); // Sanitize message.

return getDatabase().ref("/messages").push({
  text: sanitizedMessage,
  author: {uid, name, picture, email},
}).then(() => {
  logger.info("New Message written");
  // Returning the sanitized message to the client.
  return {text: sanitizedMessage};
})
index.js

Python

# Saving the new message to the Realtime Database.
sanitized_message = sanitize_text(text)  # Sanitize message.
db.reference("/messages").push({  # type: ignore
    "text": sanitized_message,
    "author": {
        "uid": uid,
        "name": name,
        "picture": picture,
        "email": email
    }
})
print("New message written")

# Returning the sanitized message to the client.
return {"text": sanitized_message}
main.py

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

אפשר להשתמש באפשרות cors כדי לקבוע לאילו מקורות תהיה גישה לפונקציה.

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

Node.js

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

exports.getGreeting = onCall(
  { cors: [/firebase\.com$/, "https://flutter.com"] },
  (request) => {
    return "Hello, world!";
  }
);

כדי לאסור בקשות ממקורות שונים, מגדירים את המדיניות cors לערך false.

טיפול בשגיאות

כדי לוודא שהלקוח מקבל פרטי שגיאה שימושיים, צריך להחזיר שגיאות מפונקציונליות ניתנות לקריאה באמצעות הטלת מופע של functions.https.HttpsError או https_fn.HttpsError (או, ב-Node.js, החזרת Promise שנדחה עם). לשגיאה יש מאפיין code שיכול להיות אחד מהערכים שמפורטים בקודי המצב של gRPC. השגיאות כוללות גם מחרוזת message, שמשתנה כברירת מחדל למחרוזת ריקה. הם יכולים לכלול גם שדה details אופציונלי עם ערך שרירותי. אם הפונקציות שלכם גורמות להשלכת שגיאה שאינה שגיאת HTTPS, במקום זאת הלקוח יקבל שגיאה עם ההודעה INTERNAL והקוד internal.

לדוגמה, פונקציה עשויה להחזיר שגיאות אימות ונתונים עם הודעות שגיאה ללקוח הקורא:

Node.js

// Checking attribute.
if (!(typeof text === "string") || text.length === 0) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new HttpsError("invalid-argument", "The function must be called " +
          "with one arguments \"text\" containing the message text to add.");
}
// Checking that the user is authenticated.
if (!request.auth) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new HttpsError("failed-precondition", "The function must be " +
          "called while authenticated.");
}
index.js

Python

# Checking attribute.
if not isinstance(text, str) or len(text) < 1:
    # Throwing an HttpsError so that the client gets the error details.
    raise https_fn.HttpsError(code=https_fn.FunctionsErrorCode.INVALID_ARGUMENT,
                              message=('The function must be called with one argument, "text",'
                                       " containing the message text to add."))

# Checking that the user is authenticated.
if req.auth is None:
    # Throwing an HttpsError so that the client gets the error details.
    raise https_fn.HttpsError(code=https_fn.FunctionsErrorCode.FAILED_PRECONDITION,
                              message="The function must be called while authenticated.")
main.py

פריסת הפונקציה שניתן לקרוא לה

אחרי ששומרים פונקציה ניתנת לקריאה ב-index.js, היא נפרסת יחד עם כל שאר הפונקציות כשמריצים את firebase deploy. כדי לפרוס רק את ה-callable, משתמשים בארגומנט --only כפי שמוצג כדי לבצע פריסות חלקיות:

firebase deploy --only functions:addMessage

אם נתקלתם בשגיאות הרשאות בזמן הפריסה של הפונקציות, ודאו שהמשתמש שמריץ את פקודות הפריסה הוקצו לו תפקידי IAM מתאימים.

הגדרת סביבת הפיתוח של הלקוח

עליכם לוודא שאתם עומדים בדרישות הסף, ואז להוסיף לאפליקציה את יחסי התלות ואת ספריות הלקוח הנדרשות.

iOS+

פועלים לפי ההוראות להוספת Firebase לאפליקציה ל-Apple.

שימוש ב-Swift Package Manager כדי להתקין ולנהל יחסי תלות ב-Firebase.

במדריך ההתקנה מוסבר על הדרכים השונות להוספת ערכות SDK של Firebase לפרויקט שלכם ב-Apple, כולל ייבוא של מסגרות ישירות ושימוש ב-CocoaPods.

1. ב-Xcode, כשפרויקט האפליקציה פתוח, עוברים אל קובץ > הוספת חבילות.
2. כשמופיעה בקשה, מוסיפים את המאגר של Firebase SDK לפלטפורמות של Apple:

  https://github.com/firebase/firebase-ios-sdk.git

הערה: בפרויקטים חדשים צריך להשתמש בגרסת ברירת המחדל (העדכנית) של ה-SDK, אבל אפשר לבחור גרסה ישנה יותר במקרה הצורך.
3. בוחרים את הספרייה Cloud Functions.
4. מוסיפים את הדגל -ObjC לקטע Other Linker Flags (דגלים אחרים של קישור) בהגדרות ה-build של היעד.
5. בסיום, Xcode יתחיל לפתור את יחסי התלות ולהוריד אותם באופן אוטומטי ברקע.

Web

1. פועלים לפי ההוראות להוספת Firebase לאפליקציית האינטרנט. חשוב להריץ את הפקודה הבאה מהטרמינל:

   npm install firebase@11.0.2 --save

2. דורשים באופן ידני גם את הליבה של Firebase וגם את Cloud Functions:

    import { initializeApp } from 'firebase/app';
    import { getFunctions } from 'firebase/functions';
   
    const app = initializeApp({
        projectId: '### CLOUD FUNCTIONS PROJECT ID ###',
        apiKey: '### FIREBASE API KEY ###',
        authDomain: '### FIREBASE AUTH DOMAIN ###',
      });
    const functions = getFunctions(app);

Android

1. פועלים לפי ההוראות כדי להוסיף את Firebase לאפליקציה ל-Android.

2. בקובץ Gradle של המודול (ברמת האפליקציה) (בדרך כלל <project>/<app-module>/build.gradle.kts או <project>/<app-module>/build.gradle), מוסיפים את התלות בספרייה Cloud Functions ל-Android. מומלץ להשתמש ב-Firebase Android BoM כדי לשלוט בגרסאות הספרייה.

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:33.7.0"))
   
       // Add the dependency for the Cloud Functions library
       // When using the BoM, you don't specify versions in Firebase library dependencies
       implementation("com.google.firebase:firebase-functions")
   }

   כשמשתמשים ב-Firebase Android BoM, האפליקציה תמיד תשתמש בגרסאות תואמות של ספריות Firebase ל-Android.

   (חלופה)  מוסיפים יחסי תלות לספריות של Firebase בלי להשתמש ב-BoM

   אם בוחרים לא להשתמש ב-Firebase BoM, צריך לציין את כל הגרסאות של ספריות Firebase בשורת התלות שלהן.

   שימו לב: אם אתם משתמשים במספר ספריות של Firebase באפליקציה, מומלץ מאוד להשתמש ב-BoM כדי לנהל את הגרסאות של הספריות, וכך לוודא שכל הגרסאות תואמות.

   dependencies {
       // Add the dependency for the Cloud Functions library
       // When NOT using the BoM, you must specify versions in Firebase library dependencies
       implementation("com.google.firebase:firebase-functions:21.1.0")
   }

   מחפשים מודול ספרייה ספציפי ל-Kotlin? החל מ-אוקטובר 2023 (Firebase BoM 32.5.0), מפתחי Kotlin ומפתחי Java יוכלו להסתמך על מודול הספרייה הראשי (פרטים נוספים זמינים בשאלות הנפוצות לגבי היוזמה הזו).

אתחול ה-SDK של הלקוח

מאתחלים מופע של Cloud Functions:

Swift

lazy var functions = Functions.functions()
CloudAddCell.swift

Objective-C

@property(strong, nonatomic) FIRFunctions *functions;
// ...
self.functions = [FIRFunctions functions];
CloudAddCell.m

Web

const app = initializeApp({
  projectId: '### CLOUD FUNCTIONS PROJECT ID ###',
  apiKey: '### FIREBASE API KEY ###',
  authDomain: '### FIREBASE AUTH DOMAIN ###',
});
const functions = getFunctions(app);

Kotlin+KTX

private lateinit var functions: FirebaseFunctions
// ...
functions = Firebase.functions
MainActivity.kt

Java

private FirebaseFunctions mFunctions;
// ...
mFunctions = FirebaseFunctions.getInstance();
MainActivity.java

הערה: כדי לקרוא לפונקציה שפועלת במיקום אחר מלבד us-central1 שמוגדר כברירת מחדל, צריך להגדיר את הערך המתאים במהלך האינטוליזציה. לדוגמה, ב-Android צריך להשתמש ב-getInstance(FirebaseApp app, String region).

קריאה לפונקציה

Swift

functions.httpsCallable("addMessage").call(["text": inputField.text]) { result, error in
  if let error = error as NSError? {
    if error.domain == FunctionsErrorDomain {
      let code = FunctionsErrorCode(rawValue: error.code)
      let message = error.localizedDescription
      let details = error.userInfo[FunctionsErrorDetailsKey]
    }
    // ...
  }
  if let data = result?.data as? [String: Any], let text = data["text"] as? String {
    self.resultField.text = text
  }
}
CommentCell.swift

Objective-C

[[_functions HTTPSCallableWithName:@"addMessage"] callWithObject:@{@"text": _inputField.text}
                                                      completion:^(FIRHTTPSCallableResult * _Nullable result, NSError * _Nullable error) {
  if (error) {
    if ([error.domain isEqual:@"com.firebase.functions"]) {
      FIRFunctionsErrorCode code = error.code;
      NSString *message = error.localizedDescription;
      NSObject *details = error.userInfo[@"details"];
    }
    // ...
  }
  self->_resultField.text = result.data[@"text"];
}];

Web

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    var sanitizedMessage = result.data.text;
  });
callable.js

Web

import { getFunctions, httpsCallable } from "firebase/functions";

const functions = getFunctions();
const addMessage = httpsCallable(functions, 'addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    /** @type {any} */
    const data = result.data;
    const sanitizedMessage = data.text;
  });
fb_functions_call_add_message.js

Kotlin+KTX

private fun addMessage(text: String): Task<String> {
    // Create the arguments to the callable function.
    val data = hashMapOf(
        "text" to text,
        "push" to true,
    )

    return functions
        .getHttpsCallable("addMessage")
        .call(data)
        .continueWith { task ->
            // This continuation runs on either success or failure, but if the task
            // has failed then result will throw an Exception which will be
            // propagated down.
            val result = task.result?.data as String
            result
        }
}
MainActivity.kt

Java

private Task<String> addMessage(String text) {
    // Create the arguments to the callable function.
    Map<String, Object> data = new HashMap<>();
    data.put("text", text);
    data.put("push", true);

    return mFunctions
            .getHttpsCallable("addMessage")
            .call(data)
            .continueWith(new Continuation<HttpsCallableResult, String>() {
                @Override
                public String then(@NonNull Task<HttpsCallableResult> task) throws Exception {
                    // This continuation runs on either success or failure, but if the task
                    // has failed then getResult() will throw an Exception which will be
                    // propagated down.
                    String result = (String) task.getResult().getData();
                    return result;
                }
            });
}
MainActivity.java

Dart

    final result = await FirebaseFunctions.instance.httpsCallable('addMessage').call(
      {
        "text": text,
        "push": true,
      },
    );
    _response = result.data as String;

C++‎

firebase::Future<firebase::functions::HttpsCallableResult> AddMessage(
    const std::string& text) {
  // Create the arguments to the callable function.
  firebase::Variant data = firebase::Variant::EmptyMap();
  data.map()["text"] = firebase::Variant(text);
  data.map()["push"] = true;

  // Call the function and add a callback for the result.
  firebase::functions::HttpsCallableReference doSomething =
      functions->GetHttpsCallable("addMessage");
  return doSomething.Call(data);
}

Unity

private Task<string> addMessage(string text) {
  // Create the arguments to the callable function.
  var data = new Dictionary<string, object>();
  data["text"] = text;
  data["push"] = true;

  // Call the function and extract the operation from the result.
  var function = functions.GetHttpsCallable("addMessage");
  return function.CallAsync(data).ContinueWith((task) => {
    return (string) task.Result.Data;
  });
}

טיפול בשגיאות בצד הלקוח

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

אם השגיאה שמוחזרת על ידי הפונקציה היא מסוג function.https.HttpsError, הלקוח מקבל את השגיאות code,‏ message ו-details מהשגיאה בשרת. אחרת, השגיאה מכילה את ההודעה INTERNAL ואת הקוד INTERNAL. כך מטפלים בשגיאות בפונקציה שניתן להפעיל.

Swift

if let error = error as NSError? {
  if error.domain == FunctionsErrorDomain {
    let code = FunctionsErrorCode(rawValue: error.code)
    let message = error.localizedDescription
    let details = error.userInfo[FunctionsErrorDetailsKey]
  }
  // ...
}
CloudAddCell.swift

Objective-C

if (error) {
  if ([error.domain isEqual:@"com.firebase.functions"]) {
    FIRFunctionsErrorCode code = error.code;
    NSString *message = error.localizedDescription;
    NSObject *details = error.userInfo[@"details"];
  }
  // ...
}
CloudAddCell.m

Web

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    var sanitizedMessage = result.data.text;
  })
  .catch((error) => {
    // Getting the Error details.
    var code = error.code;
    var message = error.message;
    var details = error.details;
    // ...
  });
callable.js

Web

import { getFunctions, httpsCallable } from "firebase/functions";

const functions = getFunctions();
const addMessage = httpsCallable(functions, 'addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    /** @type {any} */
    const data = result.data;
    const sanitizedMessage = data.text;
  })
  .catch((error) => {
    // Getting the Error details.
    const code = error.code;
    const message = error.message;
    const details = error.details;
    // ...
  });
fb_functions_call_add_message_error.js

Kotlin+KTX

addMessage(inputMessage)
    .addOnCompleteListener { task ->
        if (!task.isSuccessful) {
            val e = task.exception
            if (e is FirebaseFunctionsException) {
                val code = e.code
                val details = e.details
            }
        }
    }
MainActivity.kt

Java

addMessage(inputMessage)
        .addOnCompleteListener(new OnCompleteListener<String>() {
            @Override
            public void onComplete(@NonNull Task<String> task) {
                if (!task.isSuccessful()) {
                    Exception e = task.getException();
                    if (e instanceof FirebaseFunctionsException) {
                        FirebaseFunctionsException ffe = (FirebaseFunctionsException) e;
                        FirebaseFunctionsException.Code code = ffe.getCode();
                        Object details = ffe.getDetails();
                    }
                }
            }
        });
MainActivity.java

Dart

try {
  final result =
      await FirebaseFunctions.instance.httpsCallable('addMessage').call();
} on FirebaseFunctionsException catch (error) {
  print(error.code);
  print(error.details);
  print(error.message);
}

C++‎

void OnAddMessageCallback(
    const firebase::Future<firebase::functions::HttpsCallableResult>& future) {
  if (future.error() != firebase::functions::kErrorNone) {
    // Function error code, will be kErrorInternal if the failure was not
    // handled properly in the function call.
    auto code = static_cast<firebase::functions::Error>(future.error());

    // Display the error in the UI.
    DisplayError(code, future.error_message());
    return;
  }

  const firebase::functions::HttpsCallableResult* result = future.result();
  firebase::Variant data = result->data();
  // This will assert if the result returned from the function wasn't a string.
  std::string message = data.string_value();
  // Display the result in the UI.
  DisplayResult(message);
}

// ...

// ...
  auto future = AddMessage(message);
  future.OnCompletion(OnAddMessageCallback);
  // ...

Unity

 addMessage(text).ContinueWith((task) => {
  if (task.IsFaulted) {
    foreach (var inner in task.Exception.InnerExceptions) {
      if (inner is FunctionsException) {
        var e = (FunctionsException) inner;
        // Function error code, will be INTERNAL if the failure
        // was not handled properly in the function call.
        var code = e.ErrorCode;
        var message = e.ErrorMessage;
      }
    }
  } else {
    string result = task.Result;
  }
});

מומלץ: מניעת ניצול לרעה באמצעות App Check

לפני השקת האפליקציה, כדאי להפעיל את App Check כדי לוודא שרק האפליקציות שלכם יכולות לגשת לנקודות הקצה של הפונקציות שניתן לבצע קריאה אליהן.