פונקציות שיחה מהאפליקציה שלך

פונקציות הענן עבור ערכות SDK של לקוח Firebase מאפשרות לך להתקשר לפונקציות ישירות מאפליקציית Firebase. כדי להתקשר לפונקציה מהאפליקציה שלך בדרך זו, כתוב ופרס פונקציה הניתנת להתקשרות ב- HTTPS בפונקציות ענן ואז הוסף לוגיקה של הלקוח כדי להתקשר לפונקציה מהאפליקציה שלך.

חשוב לזכור כי HTTPS פונקציות callable דומים אך לא זהים HTTP פונקציות. כדי להשתמש ב- HTTPS פונקציות callable עליך להשתמש ב- SDK לקוח לפלטפורמה שלך יחד עם functions.https API backend (או ליישם את הפרוטוקול). להפרש Callables יש הבדל מפתח זה מפונקציות HTTP:

  • עם שמיעה הניתנת להתקשרות, אסימונים לאימות Firebase, אסימונים של FCM ואסימונים לאפליקציית בדיקה כלולים באופן אוטומטי בבקשות, כאשר הם זמינים.
  • functions.https.onCall ההדק באופן אוטומטי deserializes בגוף הבקשה ומאמת auth אסימונים.

SDK של Firebase לפונקציות ענן v0.9.1 ומעלה משתף פעולה עם גרסאות מינימליות אלה של SDK של לקוח Firebase כדי לתמוך בפונקציות הניתנות להתקשרות ב- HTTPS:

  • Firebase SDK עבור iOS 8.4.0
  • Firebase SDK לאנדרואיד 20.0.0
  • Firebase JavaScript SDK 8.8.0
  • Firebase מודולרי אינטרנט SDK נ '9.0

אם אתה רוצה להוסיף פונקציונליות דומה לזו של אפליקציה מבוססת על פלטפורמה שאינה נתמכת, לראות את מפרט פרוטוקול עבור https.onCall . שאר המדריך הזה מספק הוראות כיצד לכתוב, לפרוס ולהתקשר לפונקציה הניתנת להתקשרות HTTPS עבור iOS, Android, אינטרנט, C ++ ואחדות.

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

השתמש functions.https.onCall ליצור פונקציה callable HTTPS. שיטה זו מקבלת שני פרמטרים: data , ו אופציונלי context :

// Saves a message to the Firebase Realtime Database but sanitizes the text by removing swearwords.
exports.addMessage = functions.https.onCall((data, context) => {
  // ...
});

עבור פונקציה callable כי חוסך הודעת טקסט אל מסד נתונים בזמן אמת, למשל, data יכול להכיל את טקסט ההודעה, ואילו context פרמטרים מייצגים מידע אימות המשתמש:

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

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

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

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

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

// returning result.
return {
  firstNumber: firstNumber,
  secondNumber: secondNumber,
  operator: '+',
  operationResult: firstNumber + secondNumber,
};

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

// Saving the new message to the Realtime Database.
const sanitizedMessage = sanitizer.sanitizeText(text); // Sanitize the message.
return admin.database().ref('/messages').push({
  text: sanitizedMessage,
  author: { uid, name, picture, email },
}).then(() => {
  console.log('New Message written');
  // Returning the sanitized message to the client.
  return { text: sanitizedMessage };
})

לטפל בשגיאות

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

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

// Checking attribute.
if (!(typeof text === 'string') || text.length === 0) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new functions.https.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 (!context.auth) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new functions.https.HttpsError('failed-precondition', 'The function must be called ' +
      'while authenticated.');
}

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

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

$ firebase deploy --only functions:addMessage

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

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

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

iOS

  1. פעל בהתאם להוראות כדי להוסיף Firebase אפליקציית iOS שלך .
  2. מוסיפים את תרמיל פונקציות מענן שלך Podfile :
    pod 'Firebase/Functions'
  3. שמור את הקובץ, ולאחר מכן להפעיל:
    pod install

אינטרנט v9

  1. פעל בהתאם להוראות כדי להוסיף Firebase ביישום האינטרנט שלך .
  2. מוסיפים את הליבה Firebase וספריות לקוח פונקציות ענן באפליקציה:
    <script src="https://www.gstatic.com/firebasejs/8.8.0/firebase.js"></script>
    <script src="https://www.gstatic.com/firebasejs/8.8.0/firebase-functions.js"></script>
    

ה- SDK של פונקציות הענן זמין גם כחבילת npm.

  1. הפעל את הפקודה הבאה מהטרמינל שלך:
    npm install firebase@8.8.0 --save
    
  2. ידני דורשים הוא ליבת Firebase ותפקידי ענן:

    import { initializeApp } from 'firebase/app';
    import { initializeFunctions } from 'firebase/functions';

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

אינטרנט v8

  1. פעל בהתאם להוראות כדי להוסיף Firebase ביישום האינטרנט שלך .
  2. מוסיפים את הליבה Firebase וספריות לקוח פונקציות ענן באפליקציה:
    <script src="https://www.gstatic.com/firebasejs/8.8.0/firebase.js"></script>
    <script src="https://www.gstatic.com/firebasejs/8.8.0/firebase-functions.js"></script>
    

ה- SDK של פונקציות הענן זמין גם כחבילת npm.

  1. הפעל את הפקודה הבאה מהטרמינל שלך:
    npm install firebase@8.8.0 --save
    
  2. ידני דורשים הוא ליבת Firebase ותפקידי ענן:
    const firebase = require("firebase");
    // Required for side-effects
    require("firebase/functions");
    

ג'אווה

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

  2. באמצעות BOM אנדרואיד Firebase , להכריז על התלות של הספרייה אנדרואיד פונקציות ענן מודול שלך (ברמת היישום) קובץ Gradle (בדרך כלל app/build.gradle ).

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:28.3.0')
    
        // Declare 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 אנדרואיד BOM , האפליקציה שלך תמיד ישתמשו גירסאות תואמות של ספריות אנדרואיד Firebase.

    (אלטרנטיבי) הצהר תלות הספרייה Firebase ללא שימוש BOM

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

    שים לב שאם אתה משתמש בספריות Firebase מרובים באפליקציה, אנו ממליצים בחום להשתמש בתמונה BOM לנהל גרסאות הספרייה, אשר מבטיח כי כל הגרסאות תואמות.

    dependencies {
        // Declare 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:20.0.0'
    }
    

Kotlin + KTX

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

  2. באמצעות BOM אנדרואיד Firebase , להכריז על התלות של הספרייה אנדרואיד פונקציות ענן מודול שלך (ברמת היישום) קובץ Gradle (בדרך כלל app/build.gradle ).

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:28.3.0')
    
        // Declare 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-ktx'
    }
    

    באמצעות Firebase אנדרואיד BOM , האפליקציה שלך תמיד ישתמשו גירסאות תואמות של ספריות אנדרואיד Firebase.

    (אלטרנטיבי) הצהר תלות הספרייה Firebase ללא שימוש BOM

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

    שים לב שאם אתה משתמש בספריות Firebase מרובים באפליקציה, אנו ממליצים בחום להשתמש בתמונה BOM לנהל גרסאות הספרייה, אשר מבטיח כי כל הגרסאות תואמות.

    dependencies {
        // Declare 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-ktx:20.0.0'
    }
    

C ++

עבור C ++ עם אנדרואיד:

  1. פעל בהתאם להוראות כדי להוסיף Firebase ל- C ++ לפרויקט שלך .
  2. מוסיפים את firebase_functions הספרייה שלך CMakeLists.txt קובץ.

עבור C ++ עם iOS:

  1. פעל בהתאם להוראות כדי להוסיף Firebase ל- C ++ לפרויקט שלך .
  2. מוסיפים את תרמיל פונקציות מענן שלך Podfile :
    pod 'Firebase/Functions'
  3. שמור את הקובץ, ולאחר מכן להפעיל:
    pod install
  4. מוסיפים את הליבה Firebase ומסגרות פונקציות ענן מן SDK Firebase C ++ לפרויקט Xcode שלך.
    • firebase.framework
    • firebase_functions.framework

אַחְדוּת

  1. פעל בהתאם להוראות כדי להוסיף Firebase לפרויקט האחדות שלך .
  2. מוסיפים את FirebaseFunctions.unitypackage מן SDK האחדות Firebase לפרויקט האחדות שלך.

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

אתחל מופע של פונקציות ענן:

מָהִיר

lazy var functions = Functions.functions()

מטרה-ג

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

אינטרנט v8

firebase.initializeApp({
  apiKey: '### FIREBASE API KEY ###',
  authDomain: '### FIREBASE AUTH DOMAIN ###',
  projectId: '### CLOUD FUNCTIONS PROJECT ID ###'
  databaseURL: 'https://### YOUR DATABASE NAME ###.firebaseio.com',
});

// Initialize Cloud Functions through Firebase
var functions = firebase.functions();

אינטרנט v9

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

ג'אווה

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

Kotlin + KTX

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

C ++

firebase::functions::Functions* functions;
// ...
functions = firebase::functions::Functions::GetInstance(app);

אַחְדוּת

functions = Firebase.Functions.DefaultInstance;

התקשרו לפונקציה

מָהִיר

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
  }
}

מטרה-ג

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

אינטרנט v8

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

אינטרנט v9

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;
  });

ג'אווה

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;
                }
            });
}

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
            }
}

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);
}

אַחְדוּת

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 . ראה הנחיות כיצד לטפל בשגיאות בתפקוד callable שלך.

מָהִיר

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 (error) {
  if (error.domain == FIRFunctionsErrorDomain) {
    FIRFunctionsErrorCode code = error.code;
    NSString *message = error.localizedDescription;
    NSObject *details = error.userInfo[FIRFunctionsErrorDetailsKey];
  }
  // ...
}

אינטרנט v8

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;
    // ...
  });

אינטרנט v9

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;
    // ...
  });

ג'אווה

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();
                    }

                    // ...
                }

                // ...
            }
        });

Kotlin + KTX

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

                // ...
            }

            // ...
        })

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);
// ...

אַחְדוּת

 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 כדי לעזור להבטיח שרק האפליקציות יכולות לגשת נקודות קצה פונקצית callable שלך.