了解 2023 年 Google I/O 大会上介绍的 Firebase 亮点。了解详情

تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

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

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

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

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

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

Firebase حزمة تطوير البرامج (SDK) Apple للأنظمة الأساسية 11.2.0
حزمة تطوير البرامج (SDK) Firebase للإصدار 21.0.0 من Android
Firebase Modular Web SDK - الإصدار 9.7.0

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

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

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

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

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

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

لعرض البيانات بعد عملية غير متزامنة، أعد وعدًا. البيانات التي يرجعها الوعد إلى العميل. على سبيل المثال، عرض نص تم تصحيحه كتبته الدالة القابلة للاستدعاء إلى 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};
})index.js

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

لضمان حصول العميل على تفاصيل مفيدة عن الخطأ، اعرض الأخطاء من عنصر قابل للاستدعاء. برمي (أو إرجاع وعد مرفوض مع) مثال 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

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

بعد حفظ دالة قابلة للاتّصال مكتملة ضمن index.js، يتم نشرها مع جميع الدوالّ الأخرى عند تشغيل firebase deploy. لنشر الدالة القابلة للاستدعاء فقط، استخدِم الوسيطة --only على النحو الموضّح لتنفيذ عمليات نشر جزئية:

firebase deploy --only functions:addMessage

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

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

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

iOS+

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

يمكنك استخدام "مدير حزم Swift" لتثبيت اعتماديات Firebase وإدارتها.

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

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

اختَر مكتبة Cloud Functions.
أضِف العلامة -ObjC إلى القسم علامات الروابط الأخرى في إعدادات إصدار هدفك.
عند الانتهاء، سيبدأ Xcode تلقائيًا في حل وتنزيل ملف والتبعيات في الخلفية.

Web

اتّبِع التعليمات إضافة Firebase إلى تطبيق الويب تأكد من تشغيل الأمر التالي من الوحدة الطرفية:
```
npm install firebase@10.13.1 --save
```

تتطلّب يدويًا كلاً من حزمة 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

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

إضافة مكتبات برامج 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.

شغِّل الأمر التالي من الوحدة الطرفية:
```
npm install firebase@8.10.1 --save
```

تتطلّب يدويًا كلاً من حزمة Firebase الأساسية وCloud Functions:

const firebase = require("firebase");
// Required for side-effects
require("firebase/functions");

Kotlin+KTX

اتّبِع التعليمات إضافة Firebase إلى تطبيقك على Android
في ملف 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.2.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، سيستخدم تطبيقك دائمًا إصدارات متوافقة من مكتبات 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 الاعتماد على وحدة المكتبة الرئيسية (للاطّلاع على التفاصيل، راجِع الأسئلة الشائعة حول هذه المبادرة).

Java

اتّبِع التعليمات لإضافة Firebase إلى تطبيق Android.
في ملف 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.2.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، سيستخدم تطبيقك دائمًا إصدارات متوافقة من مكتبات 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

اتّبِع التعليمات إضافة Firebase إلى تطبيق Flutter
من جذر مشروع Flutter، شغِّل الأمر التالي لتثبيت المكوّن الإضافي:
```
flutter pub add cloud_functions
```
بعد إكمال الخطوات، أعِد إنشاء تطبيق Flutter:
```
flutter run
```
بعد تثبيت الإضافة، يمكنك الوصول إلى "cloud_functions". المكون الإضافي عن طريق استيراده في تعليمة Dart الخاصة بك:
```
import 'package:cloud_functions/cloud_functions.dart';
```

C++‎

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

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

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

اتّبِع التعليمات لإضافة Firebase إلى مشروع C++.
إضافة لوحة Cloud Functions إلى Podfile:
```
pod 'Firebase/Functions'
```
احفظ الملف، ثم شغِّل:
```
pod install
```
إضافة إطارَي عمل Firebase الأساسي وCloud Functions من Firebase C++ SDK إلى مشروع Xcode
- firebase.framework
- firebase_functions.framework

Unity

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

إعداد حزمة تطوير البرامج (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

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.functionsMainActivity.kt

Java

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

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