Клиентские SDK Cloud Functions for Firebase позволяют вызывать функции непосредственно из приложения Firebase. Чтобы вызвать функцию из приложения таким образом, напишите и разверните вызываемую по HTTP функцию в Cloud Functions, а затем добавьте клиентскую логику для вызова функции из приложения.
Важно помнить, что вызываемые функции HTTP похожи на функции HTTP, но не идентичны им. Чтобы использовать вызываемые функции HTTP, необходимо использовать клиентский SDK для вашей платформы вместе с серверным API (или реализовать протокол). У вызываемых функций есть следующие ключевые отличия от функций HTTP:
- Если доступны вызываемые объекты, токены Firebase Authentication, FCM и App Check, они автоматически включаются в запросы.
- Триггер автоматически десериализует тело запроса и проверяет токены аутентификации.
Firebase SDK для Cloud Functions второго поколения и более новых устройств взаимодействует с указанными ниже минимальными версиями клиентских SDK Firebase, чтобы поддерживать вызываемые функции HTTPS:
- Firebase SDK для платформ Apple 12.19.1
- Firebase SDK для Android 22.1.1
- Firebase Modular Web SDK версии 9.7.0
Если вы хотите добавить похожую функцию в приложение, созданное на неподдерживаемой платформе, ознакомьтесь со спецификацией протокола для https.onCall. В остальной части этого руководства приведены инструкции по написанию, развертыванию и вызову вызываемой функции HTTP для платформ Apple, Android, интернета, C++ и Unity.
Как написать и развернуть вызываемую функцию
Чтобы создать вызываемую функцию HTTPS, используйте functions.https.onCall. Этот метод принимает два параметра: 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,
};
Чтобы вернуть данные после асинхронной операции, верните объект Promise. Данные, возвращенные объектом Promise, отправляются обратно клиенту. Например, вы можете вернуть очищенный текст, который вызываемая функция записала в 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.
Для установки зависимостей Firebase и управления ими используйте Swift Package Manager.
- Откройте проект приложения в Xcode и перейдите в меню File (Файл) > Add Packages (Добавить пакеты).
- Когда появится запрос, добавьте хранилище Firebase SDK для платформ Apple:
- Выберите библиотеку Cloud Functions.
- Добавьте флаг
-ObjCв раздел Other Linker Flags (Другие флаги компоновщика) в настройках сборки целевого объекта. - После этого Xcode автоматически начнет распознавать и скачивать зависимости в фоновом режиме.
https://github.com/firebase/firebase-ios-sdk.git
Web
- Следуйте инструкциям по добавлению Firebase в веб-приложение. Обязательно выполните в терминале следующую команду:
npm install firebase@12.19.0 --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>
Cloud Functions SDK также доступен в виде пакета npm.
- Выполните в терминале следующую команду:
npm install firebase@8.10.1 --save
- Вручную добавьте основные компоненты Firebase и Cloud Functions:
const firebase = require("firebase"); // Required for side-effects require("firebase/functions");
Kotlin
Следуйте инструкциям, чтобы добавить 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:34.19.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.1") }
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:34.19.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.1") }
Dart
Следуйте инструкциям, чтобы добавить Firebase в приложение Flutter.
Чтобы установить плагин, выполните следующую команду в корневом каталоге проекта Flutter:
flutter pub add cloud_functionsПосле этого пересоберите приложение Flutter:
flutter runПосле установки плагина вы можете получить доступ к нему, импортировав его в код Dart:
cloud_functionsimport '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
- Добавьте в проект Xcode основные фреймворки Firebase и фреймворки Cloud Functions из Firebase C++ SDK.
firebase.frameworkfirebase_functions.framework
Unity
- Следуйте инструкциям по добавлению Firebase в проект Unity.
- Добавьте в свой проект Unity
FirebaseFunctions.unitypackageиз Firebase Unity SDK.
Инициализируйте клиентский 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;
});
}
Как обрабатывать ошибки на стороне клиента
Клиент получает ошибку, если сервер выдал ошибку или если полученный объект Promise был отклонен.
Если функция возвращает ошибку типа 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;
}
});
Как задать время ожидания клиента
По умолчанию в клиентских SDK Cloud Functions для вызываемых запросов используется тайм-аут в 70 секунд. Если вызываемая функция выполняется дольше 70 секунд, клиентский SDK завершает запрос с ошибкой DEADLINE_EXCEEDED (deadline-exceeded), даже если на стороне сервера задано большее время ожидания.
Чтобы поддерживать вызываемые функции с длительным временем выполнения, необходимо увеличить время ожидания как на сервере, так и на клиенте:
- Увеличьте время ожидания функции на стороне сервера (см. раздел Настройка времени ожидания и выделения памяти).
- Увеличьте время ожидания на стороне клиента при настройке вызываемой ссылки в приложении:
Swift
let callable = functions.httpsCallable("addMessage")
callable.timeoutInterval = 300 // 300 seconds (default is 70)
let result = try await callable.call(["text": text, "push": true])
Objective-C
FIRHTTPSCallable *callable = [self.functions HTTPSCallableWithName:@"addMessage"];
callable.timeoutInterval = 300; // 300 seconds (default is 70)
[callable callWithObject:@{@"text": text, @"push": @YES}
completion:^(FIRHTTPSCallableResult * _Nullable result, NSError * _Nullable error) {
// ...
}];
Web
var addMessage = firebase.functions().httpsCallable('addMessage', {
timeout: 300000, // 300 seconds in milliseconds (default is 70000)
});
addMessage({ text: messageText })
.then((result) => {
// ...
});
Web
import { getFunctions, httpsCallable } from "firebase/functions";
const functions = getFunctions();
const addMessage = httpsCallable(functions, 'addMessage', {
timeout: 300000, // 300 seconds in milliseconds (default is 70000)
});
const result = await addMessage({ text: messageText });
Kotlin
val callable = functions.getHttpsCallable("addMessage")
callable.setTimeout(300L, TimeUnit.SECONDS)
val result = callable.call(data).await()
Java
HttpsCallableReference callable = mFunctions.getHttpsCallable("addMessage");
callable.setTimeout(300L, TimeUnit.SECONDS);
Task<HttpsCallableResult> result = callable.call(data);
Dart
final callable = FirebaseFunctions.instance.httpsCallable(
'addMessage',
options: HttpsCallableOptions(
timeout: const Duration(seconds: 300),
),
);
final result = await callable.call({
'text': text,
'push': true,
});
Рекомендуется: предотвращайте злоупотребления с помощью App Check
Перед запуском приложения включите App Check, чтобы только ваши приложения могли получать доступ к конечным точкам вызываемых функций.