Google is committed to advancing racial equity for Black communities. See how.
ترجمت واجهة Cloud Translation API‏ هذه الصفحة.
Switch to English

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

تتيح لك وظائف السحابة لحزم SDK لعميل Firebase استدعاء الوظائف مباشرة من تطبيق Firebase. لاستدعاء وظيفة من تطبيقك بهذه الطريقة ، اكتب ونشر وظيفة HTTPS Callable في Cloud Functions ، ثم أضف منطق العميل لاستدعاء الوظيفة من تطبيقك.

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

  • مع العناصر القابلة للاستدعاء ، يتم تضمين مصادقة Firebase ورموز FCM المميزة ، عند توفرها ، تلقائيًا في الطلبات.
  • يقوم مشغل functions.https.onCall بإلغاء تسلسل نص الطلب تلقائيًا والتحقق من صحة رموز المصادقة.

يعمل Firebase SDK for Cloud Functions الإصدار 0.9.1 والإصدارات الأحدث مع إصدارات Firebase العميلة SDK الدنيا لدعم وظائف HTTPS القابلة للاستدعاء:

  • Firebase SDK لنظام iOS 6.34.0
  • Firebase SDK لنظام Android 19.1.0
  • Firebase JavaScript SDK 7.24.0

إذا كنت ترغب في إضافة وظائف مماثلة إلى تطبيق مبني على نظام https.onCall غير مدعوم ، فراجع مواصفات البروتوكول لـ https.onCall . يوفر باقي هذا الدليل إرشادات حول كيفية كتابة ونشر واستدعاء وظيفة HTTPS القابلة للاستدعاء لأنظمة iOS و 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 ، على سبيل المثال ، يمكن أن تحتوي 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;

يمكن للمسافة بين موقع الوظيفة القابلة للاستدعاء وموقع العميل المتصل إنشاء زمن انتقال للشبكة. لتحسين الأداء ، ضع في اعتبارك تحديد موقع الوظيفة حيثما أمكن ، وتأكد من محاذاة موقع الاستدعاء مع الموقع المحدد عند تهيئة SDK على جانب العميل.

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

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

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

لضمان حصول العميل على تفاصيل خطأ مفيدة ، قم بإرجاع الأخطاء من الاستدعاء عن طريق طرح (أو إرجاع الوعد المرفوض مع) مثيل من functions.https.HttpsError . يحتوي الخطأ على سمة code يمكن أن تكون إحدى القيم المدرجة في functions.https.HttpsError . تحتوي الأخطاء أيضًا على message ، والتي يتم تعيينها افتراضيًا على سلسلة فارغة. يمكن أن يكون لديهم أيضًا حقل details اختياري بقيمة عشوائية. إذا تم إلقاء خطأ بخلاف HttpsError من 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.');
}

انشر الوظيفة القابلة للاستدعاء

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

$ firebase deploy --only functions:addMessage

إذا واجهت أخطاء في الأذونات عند نشر الوظائف ، فتأكد من تعيين أدوار IAM المناسبة للمستخدم الذي يقوم بتشغيل أوامر النشر.

قم بإعداد بيئة تطوير العميل الخاصة بك

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

iOS

  1. اتبع التعليمات لإضافة Firebase إلى تطبيق iOS الخاص بك .
  2. أضف Podfile وظائف السحابة إلى Podfile :
    pod 'Firebase/Functions'
  3. احفظ الملف ، ثم قم بتشغيل:
    pod install

الويب

  1. اتبع التعليمات لإضافة Firebase إلى تطبيق الويب الخاص بك .
  2. أضف مكتبات عميل Firebase core و Cloud Functions إلى تطبيقك:
    <script src="https://www.gstatic.com/firebasejs/7.24.0/firebase.js"></script>
    <script src="https://www.gstatic.com/firebasejs/7.24.0/firebase-functions.js"></script>
    

تتوفر حزمة SDK الخاصة بوظائف السحابة أيضًا كحزمة npm.

  1. قم بتشغيل الأمر التالي من جهازك الطرفي:
    npm install firebase@7.24.0 --save
    
  2. تتطلب يدويًا وظائف Firebase الأساسية والسحابة:
    const firebase = require("firebase");
    // Required for side-effects
    require("firebase/functions");
    

جافا

  1. اتبع التعليمات لإضافة Firebase إلى تطبيق Android الخاص بك .
  2. في ملف build.gradle مستوى المشروع ، تأكد من تضمين مستودع Google Maven في كل من buildscript الخاص بك buildscript allprojects .
  3. أضف تبعية مكتبة Cloud Functions Android إلى ملف Gradle (على مستوى التطبيق) الخاص بالوحدة النمطية (عادةً app/build.gradle ):
    implementation 'com.google.firebase:firebase-functions:19.1.0'
    

Kotlin + KTX

  1. اتبع التعليمات لإضافة Firebase إلى تطبيق Android الخاص بك .
  2. في ملف build.gradle مستوى المشروع ، تأكد من تضمين مستودع Google Maven في كل من buildscript الخاص بك buildscript allprojects .
  3. أضف تبعية مكتبة Android Functions إلى الوحدة النمطية الخاصة بك (مستوى التطبيق) ملف Gradle (عادةً app/build.gradle ):
    implementation 'com.google.firebase:firebase-functions:19.1.0'
    

C ++

لـ C ++ مع Android :

  1. اتبع التعليمات لإضافة Firebase إلى مشروع C ++ الخاص بك .
  2. في ملف build.gradle مستوى المشروع ، تأكد من تضمين مستودع Google Maven في كل من buildscript الخاص بك buildscript allprojects .
  3. إضافة firebase_functions مكتبة لبك CMakeLists.txt الملف.

بالنسبة لـ C ++ مع iOS :

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

وحدة

  1. اتبع التعليمات لإضافة Firebase إلى مشروع Unity الخاص بك .
  2. أضف FirebaseFunctions.unitypackage من Firebase Unity SDK إلى مشروع الوحدة الخاص بك.

تهيئة العميل SDK

تهيئة مثيل من وظائف السحابة:

سويفت

lazy var functions = Functions.functions()

ج موضوعية

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

الويب

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

جافا

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 text = (result?.data as? [String: Any])?["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"];
}];

الويب

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({text: messageText}).then(function(result) {
  // Read result of the Cloud Function.
  var sanitizedMessage = result.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 . اطلع على الإرشادات الخاصة بكيفية معالجة الأخطاء في الوظيفة القابلة للاستدعاء.

سويفت

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

الويب

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({text: messageText}).then(function(result) {
  // Read result of the Cloud Function.
  var sanitizedMessage = result.data.text;
}).catch(function(error) {
  // Getting the Error details.
  var code = error.code;
  var message = error.message;
  var 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;
  }
});