Вызов функций из вашего приложения (1-го поколения)

Клиентские SDK Cloud Functions for Firebase позволяют вызывать функции непосредственно из приложения Firebase. Чтобы вызвать функцию из вашего приложения таким образом, напишите и разверните HTTP-функцию Callable в Cloud Functions , а затем добавьте клиентскую логику для вызова этой функции из вашего приложения.

Важно помнить, что вызываемые по HTTP функции похожи, но не идентичны функциям HTTP. Для использования вызываемых по HTTP функций необходимо использовать клиентский SDK для вашей платформы вместе с бэкэнд-API (или реализовать протокол). Вызываемые функции имеют следующие ключевые отличия от функций HTTP:

  • При использовании вызываемых функций токены Firebase Authentication , токены FCM и токены App Check (при наличии) автоматически включаются в запросы.
  • Триггер автоматически десериализует тело запроса и проверяет токены аутентификации.

Firebase SDK для Cloud Functions 2-го поколения и выше взаимодействует со следующими минимальными версиями клиентского SDK Firebase для поддержки вызываемых функций HTTPS:

  • Firebase SDK для платформ Apple 12.7.0
  • Firebase SDK для Android 22.1.0
  • Firebase Modular Web SDK v. 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;

Расстояние между местоположением вызываемой функции и местоположением вызывающего клиента может создавать задержку в сети. Для оптимизации производительности рекомендуется указывать местоположение функции там, где это применимо, и убедиться, что местоположение вызываемой функции совпадает с местоположением, заданным при инициализации 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};
})

Обработка ошибок

Чтобы клиент получал полезные сведения об ошибке, возвращайте ошибки из вызываемой функции, генерируя исключение (или возвращая Promise, отклоненный с помощью) экземпляр 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, открыв проект приложения, перейдите в меню File > Add Packages .
  2. При появлении запроса добавьте репозиторий Firebase Apple Platforms SDK:
  3.   https://github.com/firebase/firebase-ios-sdk.git
  4. Выберите библиотеку Cloud Functions .
  5. Добавьте флаг -ObjC в раздел «Другие флаги компоновщика» в настройках сборки вашей целевой системы.
  6. После завершения Xcode автоматически начнет разрешение и загрузку ваших зависимостей в фоновом режиме.

Web

  1. Следуйте инструкциям, чтобы добавить Firebase в ваше веб-приложение . Обязательно выполните следующую команду в терминале:
    npm install firebase@12.7.0 --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, так и 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:34.7.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 для управления версиями библиотек, что гарантирует совместимость всех версий.

    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:22.1.0")
    }

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:34.7.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 для управления версиями библиотек, что гарантирует совместимость всех версий.

    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:22.1.0")
    }

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. Добавьте в свой проект Xcode ядро ​​Firebase и фреймворк Cloud Functions из Firebase C++ SDK .
    • firebase.framework
    • firebase_functions.framework

Единство

  1. Следуйте инструкциям, чтобы добавить Firebase в ваш проект Unity .
  2. Добавьте файл FirebaseFunctions.unitypackage из Firebase Unity SDK в свой проект Unity.

Инициализируйте клиентский SDK.

Инициализация экземпляра Cloud Functions :

Быстрый

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

Единство

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

Единство

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

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

Единство

 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 , чтобы гарантировать, что доступ к вызываемым функциям будет предоставлен только вашим приложениям.