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


تتيح لك حِزم تطوير البرامج (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.15.0
  • Firebase حزمة SDK للإصدار 21.2.1 من Android
  • الإصدار 9.7.0 من حزمة تطوير البرامج (SDK) على الويب المعيارية من Firebase

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

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

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

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

iOS+‎

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

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

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

Web

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

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

  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.16.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متعدّدة في تطبيقك، ننصحك بشدة باستخدام 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.2.1")
    }
    هل تبحث عن وحدة مكتبة خاصة بلغة 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.16.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متعدّدة في تطبيقك، ننصحك بشدة باستخدام 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.2.1")
    }
    هل تبحث عن وحدة مكتبة خاصة بلغة 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. بعد تثبيت المكوّن الإضافي، يمكنك الوصول إليه من خلال استيراده في رمز Dart:cloud_functions

    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 من Firebase C++ SDK إلى مشروع 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

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

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

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

قبل تشغيل تطبيقك، عليك تفعيل App Check للمساعدة في ضمان أنّ تطبيقاتك فقط هي التي يمكنها الوصول إلى نقاط نهاية الدوال القابلة للاستدعاء.