وظائف الاتصال من تطبيقك

الجيل الثاني الجيل الأول

تتيح لك حِزم تطوير البرامج (SDK) لعملاء Cloud Functions for Firebase استدعاء الدوالّ مباشرةً من تطبيق Firebase. لاستدعاء دالة من تطبيقك بهذه الطريقة، عليك كتابة دالة قابلة للاستدعاء عبر بروتوكول HTTP ونشرها في Cloud Functions، ثم إضافة منطق العميل لاستدعاء الدالة من تطبيقك.

من المهمّ مراعاة أنّ الدوالّ القابلة للاتّصال عبر HTTP متشابهة ولكنها ليست مطابقة لدوالّ HTTP. لاستخدام الدوال التي يمكن استدعاؤها من خلال HTTP، يجب استخدام حزمة SDK للعميل على نظامك الأساسي مع واجهة برمجة التطبيقات لنظام التشغيل الأساسي (أو تنفيذ البروتوكول). تختلف الدوالّ القابلة للاستدعاء عن دوالّ HTTP في ما يلي:

• في حال توفّر الرموز المميّزة Firebase Authentication وFCM وApp Check، يتم تضمينها تلقائيًا في الطلبات.
• يُعيد العامل المشغِّل تسلسل محتوى الطلب تلقائيًا ويُجري عمليات تحقّق من الرموز المميّزة للمصادقة.

تتوافق حزمة تطوير البرامج (SDK) لنظام التشغيل Firebase من الجيل الثاني من نظام التشغيل Cloud Functions والإصدارات الأحدث مع الحد الأدنى من إصدارات حزمة تطوير البرامج (SDK) لخدمة Firebase العميلة لتوفير وظائف HTTPS Callable:

• Firebase حزمة SDK لأنظمة Apple الأساسية 11.5.0
• حزمة SDK لنظام التشغيل Firebase ‏21.1.0Android
• الإصدار 9.7.0 من حزمة تطوير البرامج (SDK) لبرنامج Firebase Modular Web

إذا كنت تريد إضافة وظيفة مشابهة إلى تطبيق تم إنشاؤه على منصّة غير متوافقة، اطّلِع على مواصفات البروتوكول لنظام التشغيل 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.

ملاحظة: استخدِم واجهات برمجة التطبيقات functions.https أو firebase_functions.https_fn لنظام التشغيل فقط لكتابة دوال قابلة للاستدعاء. إنّ واجهة برمجة التطبيقات HTTP trigger API منفصلة تمامًا ولا يمكن استخدامها مع الدوال القابلة للاستدعاء.

إعادة إرسال النتيجة

لإرسال البيانات مرة أخرى إلى العميل، يجب إرجاع البيانات التي يمكن ترميزها بتنسيق 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.

معالجة الأخطاء

لضمان حصول العميل على تفاصيل خطأ مفيدة، يمكنك عرض الأخطاء من دالة قابلة للاستدعاء من خلال رمي (أو لعرض Node.js لوعد تم رفضه باستخدام) مثيل functions.https.HttpsError أو https_fn.HttpsError. يحتوي الخطأ على سمة 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. لنشر العنصر القابل للاستدعاء فقط، استخدِم وسيطة --only كما هو موضّح لتنفيذ عمليات النشر الجزئية:

firebase deploy --only functions:addMessage

إذا واجهت أخطاء في الأذونات عند نشر الدوالّ، تأكَّد من أنّه تم منح أدوار إدارة الهوية وإمكانية الوصول المناسبة للمستخدم الذي يُنفِّذ أوامر النشر.

إعداد بيئة تطوير العميل

تأكَّد من استيفاء أي متطلبات أساسية، ثم أضِف التبعيات المطلوبة و مكتبات العملاء إلى تطبيقك.

iOS+

اتّبِع التعليمات لإضافة Firebase إلى تطبيقك على Apple.

استخدِم أداة Swift Package Manager لتثبيت تبعيات Firebase وإدارتها.

يمكنك الانتقال إلى دليل التثبيت للتعرّف على الطرق المختلفة التي يمكنك من خلالها إضافة حِزم تطوير البرامج (SDK) لنظام Firebase إلى مشروعك على Apple، بما في ذلك استيراد الإطارات مباشرةً واستخدام CocoaPods.

1. في Xcode، مع فتح مشروع تطبيقك، انتقِل إلى ملف > إضافة حِزم.
2. أضِف مستودع حزمة تطوير البرامج (SDK) لمنصّات Apple من Firebase عندما يُطلب منك ذلك:

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

ملاحظة: يجب أن تستخدم المشاريع الجديدة الإصدار التلقائي (أحدث) من حزمة SDK، ولكن يمكنك اختيار إصدار أقدم إذا لزم الأمر.
3. اختَر مكتبة Cloud Functions.
4. أضِف العلامة -ObjC إلى قسم رموز ربط أخرى في إعدادات الإنشاء الخاصة بالهدف.
5. عند الانتهاء، سيبدأ Xcode تلقائيًا في حلّ ملفاتك المضمّنة وتنزيلها في الخلفية.

Web

1. اتّبِع التعليمات لإضافة Firebase إلى تطبيق الويب. احرص على تنفيذ الأمر التالي من وحدة التحكّم الطرفية:

   npm install firebase@11.0.2 --save

2. يمكنك طلب Firebase Core و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.6.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 للمساعدة في التأكّد من أنّ تطبيقاتك فقط هي التي يمكنها الوصول إلى نقاط نهاية وظائفك القابلة للاستدعاء.