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


تتيح لك حِزم تطوير البرامج (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 القابلة للاستدعاء:

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

وإذا أردت إضافة وظائف مشابهة إلى تطبيق تم إنشاؤه على نظام أساسي غير متوافق، يمكنك الاطّلاع على مواصفات البروتوكول لـ https.onCall. تقدّم بقية أقسام هذا الدليل تعليمات حول كيفية كتابة دالة قابلة للاتّصال عبر بروتوكول HTTP ونشرها ودعوها لأنظمة التشغيل Apple وAndroid والويب وC++ وUnity.

كتابة الدالة القابلة للاستدعاء ونشرها

استخدِم functions.https.onCall لإنشاء دالة قابلة للاستدعاء في 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) => {
    // ...
  });
  

بالنسبة إلى الدالة القابلة للاستدعاء التي تحفظ رسالة نصية في Realtime Database، على سبيل المثال، يمكن أن تحتوي السمة data على نص الرسالة، بينما تمثّل مَعلمات context معلومات مصادقة المستخدم:

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

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

يمكنك اختياريًا إرفاق مصادقة App Check للمساعدة في حماية مواردك الخلفية من إساءة الاستخدام، مثل الفوترة الاحتيالية أو التصيّد الاحتيالي. راجِع تفعيل فرض App Check في Cloud Functions.

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

لإعادة إرسال البيانات إلى العميل، اعرض البيانات التي يمكن ترميزها بتنسيق JSON. على سبيل المثال، لعرض نتيجة عملية الجمع:

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

لعرض البيانات بعد عملية غير متزامنة، أعد وعدًا. يتم إرسال البيانات التي يعرضها الوعد إلى العميل. على سبيل المثال، يمكنك إرجاع نص تم تصحيحه كتبته الدالة القابلة للاستدعاء إلى Realtime Database:

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

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

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

firebase deploy --only functions:addMessage

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

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

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

iOS+

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

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

  1. في Xcode، مع فتح مشروع تطبيقك، انتقِل إلى ملف > إضافة حِزم.
  2. أضِف مستودع حزمة تطوير البرامج (SDK) لمنصّات Apple من Firebase عندما يُطلب منك ذلك:
  3.   https://github.com/firebase/firebase-ios-sdk.git
  4. اختَر مكتبة "Cloud Functions".
  5. أضِف العلامة -ObjC إلى قسم رموز ربط أخرى في إعدادات الإنشاء الخاصة بالهدف.
  6. عند الانتهاء، ستبدأ خدمة Xcode تلقائيًا في حلّ المشاكل المتعلّقة بالعناصر التي تعتمد عليها وتنزيلها في الخلفية.

Web

  1. اتّبِع التعليمات لإضافة Firebase إلى تطبيق الويب. احرص على تنفيذ الإجراء التالي من وحدة التحكّم الطرفية:
    npm install firebase@11.0.1 --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);

Web

  1. اتّبِع التعليمات من أجل إضافة Firebase إلى تطبيق الويب.
  2. أضِف مكتبتَي Firebase الأساسية وCloud Functions العميل إلى تطبيقك:
    <script src="https://www.gstatic.com/firebasejs/8.10.1/firebase.js"></script>
    <script src="https://www.gstatic.com/firebasejs/8.10.1/firebase-functions.js"></script>

تتوفّر حزمة تطوير البرامج (SDK) لنظام التشغيل Cloud Functions أيضًا كحزمة npm.

  1. شغِّل الأمر التالي من الوحدة الطرفية:
    npm install firebase@8.10.1 --save
  2. يمكنك طلب Firebase Core وCloud Functions يدويًا:
    const firebase = require("firebase");
    // Required for side-effects
    require("firebase/functions");

Kotlin+KTX

  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.5.1"))
    
        // 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.0.0")
    }
    هل تبحث عن وحدة مكتبة خاصة بلغة Kotlin؟ اعتبارًا من تشرين الأول (أكتوبر) 2023 (Firebase BoM 32.5.0)، يمكن لمطوّري Kotlin وJava الاعتماد على وحدة المكتبة الرئيسية (للاطّلاع على التفاصيل، راجِع الأسئلة الشائعة حول هذه المبادرة).

Java

  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.5.1"))
    
        // 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، سيستخدم تطبيقك دائمًا الإصدارات المتوافقة من مكتبات Android في Firebase.

    (بديل) إضافة ملحقات مكتبة 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.0.0")
    }
    هل تبحث عن وحدة مكتبة خاصة بلغة Kotlin؟ اعتبارًا من تشرين الأول (أكتوبر) 2023 (Firebase BoM 32.5.0)، يمكن لمطوّري Kotlin وJava الاعتماد على وحدة المكتبة الرئيسية (للاطّلاع على التفاصيل، راجِع الأسئلة الشائعة حول هذه المبادرة).

Dart

  1. اتّبِع التعليمات لإضافة Firebase إلى تطبيقك المكتوب باستخدام Flutter.

  2. من جذر مشروع Flutter، شغِّل الأمر التالي لتثبيت المكوِّن الإضافي:

    flutter pub add cloud_functions
    
  3. بعد الانتهاء، أعِد إنشاء تطبيق Flutter:

    flutter run
    
  4. بعد التثبيت، يمكنك الوصول إلى المكوّن cloud_functions الإضافي من خلال استيراده في رمز Dart:

    import 'package:cloud_functions/cloud_functions.dart';
    

C++‎

بالنسبة إلى C++ مع Android:

  1. اتّبِع التعليمات لإضافة Firebase إلى مشروع C++.
  2. أضِف مكتبة firebase_functions إلى ملف CMakeLists.txt.

بالنسبة إلى C++ مع منصات Apple:

  1. اتّبِع التعليمات من أجل إضافة Firebase إلى مشروع C++.
  2. أضِف مجموعة Cloud Functions إلى Podfile:
    pod 'Firebase/Functions'
  3. احفظ الملف، ثم شغِّل:
    pod install
  4. أضِف إطار عمل Firebase الأساسي وCloud Functions من حزمة تطوير البرامج (SDK) C++ Firebase إلى مشروع Xcode.
    • firebase.framework
    • firebase_functions.framework

Unity

  1. اتّبِع التعليمات ل إضافة Firebase إلى مشروع Unity.
  2. أضِف FirebaseFunctions.unitypackage من حزمة تطوير البرامج (SDK) Firebase Unity إلى مشروعك على Unity.

إعداد حزمة تطوير البرامج (SDK) للعميل

يمكنك إعداد مثيل من Cloud Functions:

Swift

lazy var functions = Functions.functions()

Objective-C

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

Web

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

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

Java

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

Dart

final functions = FirebaseFunctions.instance;

C++‎

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

Unity

functions = Firebase.Functions.DefaultInstance;

استدعاء الدالة

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

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

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

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

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

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]
  }
  // ...
}

Objective-C

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

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

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

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

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

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 للمساعدة في ضمان وصول تطبيقاتك فقط إلى نقاط نهاية الوظائف القابلة للاستعانة بها.