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

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

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

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

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

• Firebase SDK لمنصات Apple 8.11.0
• Firebase SDK لنظام Android 20.0.1
• Firebase JavaScript SDK 8.10.0
• Firebase Modular Web SDK الإصدار 9.0

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

لوظيفة للاستدعاء الذي يحفظ رسالة نصية إلى قاعدة البيانات في الوقت الحقيقي، على سبيل المثال، 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;
index.js

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

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

ملاحظة: لا تستخدم إلا functions.https API الواجهة الخلفية لكتابة وظائف للاستدعاء. و API HTTP الزناد منفصل تماما وليس للتشغيل المتبادل مع وظائف للاستدعاء.

تحذير: HTTP الجديدة وHTTP وظائف للاستدعاء نشرها مع أي Firebase CLI خفض من الإصدار 7.7.0 وخاصة افتراضيا ورمي HTTP 403 أخطاء عند استدعاء. إما صراحة جعل هذه الوظائف العامة أو تحديث برنامج Firebase CLI قبل نشر أية وظائف جديدة.

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

لإرسال البيانات مرة أخرى إلى العميل ، قم بإرجاع البيانات التي يمكن تشفيرها بتنسيق JSON. على سبيل المثال ، لإرجاع نتيجة عملية إضافة:

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

لإرجاع البيانات بعد عملية غير متزامنة ، قم بإرجاع الوعد. يتم إرسال البيانات التي تم إرجاعها من خلال الوعد إلى العميل. على سبيل المثال ، يمكنك إرجاع النص المعقول الذي كتبته الوظيفة القابلة للاستدعاء إلى قاعدة بيانات الوقت الحقيقي:

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

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

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

$ firebase deploy --only functions:addMessage

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

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

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

iOS +

اتبع الإرشادات ل إضافة Firebase إلى التطبيق أبل الخاص بك .

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

زيارة دليل التثبيت لدينا للتعرف على الطرق المختلفة التي يمكن أن تضيف Firebase تطوير البرامج لمشروع أبل الخاص بك، بما في ذلك استيراد الأطر واستخدام مباشرة CocoaPods.

1. في كسكودي، مع مشروع التطبيق فتح، انتقل إلى ملف> حزم سويفت> إضافة حزمة التبعية.
2. عند المطالبة ، قم بإضافة مستودع SDK لأنظمة Firebase Apple الأساسية:

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

ملاحظة: يجب أن المشاريع الجديدة استخدام الإصدار SDK الافتراضي (آخر)، ولكن يمكنك اختيار نسخة قديمة إذا لزم الأمر.
3. اختر مكتبة وظائف السحابة.
4. عند الانتهاء ، سيبدأ Xcode تلقائيًا في حل وتنزيل التبعيات الخاصة بك في الخلفية.

إصدار الويب 9

1. اتبع الإرشادات ل إضافة Firebase إلى التطبيق ويب . تأكد من تشغيل الأمر التالي من هاتفك محطة:

   npm install firebase@9.6.4 --save
   

2. تتطلب يدويًا وظائف Firebase الأساسية والسحابة:

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

إصدار الويب 8

1. اتبع الإرشادات ل إضافة Firebase إلى التطبيق ويب .
2. إضافة محور Firebase والمكتبات العميل وظائف السحب على التطبيق الخاص بك:

   <script src="https://www.gstatic.com/firebasejs/8.10.0/firebase.js"></script>
   <script src="https://www.gstatic.com/firebasejs/8.10.0/firebase-functions.js"></script>
   

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

1. قم بتشغيل الأمر التالي من هاتفك محطة:

   npm install firebase@8.10.0 --save
   

2. تتطلب يدويا على حد سواء الأساسية Firebase وظائف سحابة:

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

جافا

1. اتبع الإرشادات ل إضافة Firebase لتطبيق Android .

2. باستخدام Firebase الروبوت بوم ، أن يعلن التبعية وظائف سحابة مكتبة الروبوت في الوحدة النمطية الخاصة بك (على مستوى التطبيق) ملف Gradle (عادة app/build.gradle ).

   dependencies {
       // Import the BoM for the Firebase platform
       implementation platform('com.google.firebase:firebase-bom:29.0.4')
   
       // Declare 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 الروبوت بوم ، والتطبيق دائما استخدام إصدارات متوافقة من المكتبات Firebase الروبوت.

   (البديل) إعلان Firebase تبعيات مكتبة دون استخدام BOM

   إذا اخترت عدم استخدام Firebase BoM ، فيجب عليك تحديد كل إصدار من إصدارات مكتبة Firebase في سطر التبعية الخاص بها.

   ملاحظة أنه إذا كنت تستخدم مكتبات Firebase متعددة في التطبيق الخاص بك، ونحن نوصي بشدة باستخدام بوم لإدارة إصدارات المكتبة، والذي يضمن أن جميع إصدارات متوافقة.

   dependencies {
       // Declare 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:20.0.1'
   }
   

Kotlin + KTX

1. اتبع الإرشادات ل إضافة Firebase لتطبيق Android .

2. باستخدام Firebase الروبوت بوم ، أن يعلن التبعية وظائف سحابة مكتبة الروبوت في الوحدة النمطية الخاصة بك (على مستوى التطبيق) ملف Gradle (عادة app/build.gradle ).

   dependencies {
       // Import the BoM for the Firebase platform
       implementation platform('com.google.firebase:firebase-bom:29.0.4')
   
       // Declare 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-ktx'
   }
   

   باستخدام Firebase الروبوت بوم ، والتطبيق دائما استخدام إصدارات متوافقة من المكتبات Firebase الروبوت.

   (البديل) إعلان Firebase تبعيات مكتبة دون استخدام BOM

   إذا اخترت عدم استخدام Firebase BoM ، فيجب عليك تحديد كل إصدار من إصدارات مكتبة Firebase في سطر التبعية الخاص بها.

   ملاحظة أنه إذا كنت تستخدم مكتبات Firebase متعددة في التطبيق الخاص بك، ونحن نوصي بشدة باستخدام بوم لإدارة إصدارات المكتبة، والذي يضمن أن جميع إصدارات متوافقة.

   dependencies {
       // Declare 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-ktx:20.0.1'
   }
   

سي ++

لC ++ مع الروبوت:

1. اتبع الإرشادات ل إضافة Firebase لمشروعك C ++ .
2. إضافة firebase_functions مكتبة لبك CMakeLists.txt الملف.

لC ++ مع منصات أبل:

1. اتبع الإرشادات ل إضافة Firebase لمشروعك C ++ .
2. إضافة سحابة وظائف جراب لديك Podfile :

   pod 'Firebase/Functions'

3. حفظ الملف، ثم قم بتشغيل:

   pod install

4. إضافة محور Firebase والغيمة الأطر وظائف من ++ SDK Firebase C إلى مشروع Xcode.
   • firebase.framework
   • firebase_functions.framework

وحدة

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

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

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

سويفت

lazy var functions = Functions.functions()
CloudAddCell.swift

ج موضوعية

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

إصدار الويب 8

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

إصدار الويب 9

const app = initializeApp({
  projectId: '### CLOUD FUNCTIONS PROJECT ID ###',
  apiKey: '### FIREBASE API KEY ###',
  authDomain: '### FIREBASE AUTH DOMAIN ###',
});
const functions = getFunctions(app);

جافا

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

Kotlin + KTX

private lateinit var functions: FirebaseFunctions
// ...
functions = Firebase.functions
MainActivity.kt

سي ++

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

وحدة

functions = Firebase.Functions.DefaultInstance;

ملاحظة: لاستدعاء وظيفة تعمل في أي مكان آخر غير الافتراضي us-central1 ، يجب عليك تعيين القيمة المناسبة في التهيئة. على سبيل المثال، على الروبوت كنت تهيئة مع getInstance(FirebaseApp app, String region) .

استدعاء الوظيفة

سويفت

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

ج موضوعية

[[_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"];
}];

إصدار الويب 8

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    var sanitizedMessage = result.data.text;
  });
callable.js

إصدار الويب 9

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

جافا

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

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

سي ++

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

ج موضوعية

if (error) {
  if (error.domain == FIRFunctionsErrorDomain) {
    FIRFunctionsErrorCode code = error.code;
    NSString *message = error.localizedDescription;
    NSObject *details = error.userInfo[FIRFunctionsErrorDetailsKey];
  }
  // ...
}
CloudAddCell.m

إصدار الويب 8

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

إصدار الويب 9

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

جافا

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

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
                }

                // ...
            }

            // ...
        })
MainActivity.kt

سي ++

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

موصى به: منع إساءة الاستخدام باستخدام التحقق من التطبيق

قبل إطلاق التطبيق الخاص بك، يجب تمكين التطبيقات تحقق للمساعدة على ضمان فقط التطبيقات الخاصة بك يمكن الوصول الخاصة بك النهاية وظيفة للاستدعاء.