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 11.5.0
- Firebase SDK для Android 21.1.0
- Модульный веб-SDK Firebase версии 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};
})
Обработка ошибок
Чтобы гарантировать, что клиент получит полезную информацию об ошибках, возвращайте ошибки из вызываемого объекта, выдавая (или возвращая обещание, отклоненное с помощью) экземпляр 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 и управления ими.
- В Xcode, открыв проект приложения, выберите «Файл» > «Добавить пакеты» .
- При появлении запроса добавьте репозиторий Firebase SDK для платформ Apple:
- Выберите библиотеку Cloud Functions .
- Добавьте флаг
-ObjCв раздел «Другие флаги компоновщика» настроек сборки вашей цели. - По завершении Xcode автоматически начнет разрешать и загружать ваши зависимости в фоновом режиме.
https://github.com/firebase/firebase-ios-sdk.git
Web
- Следуйте инструкциям, чтобы добавить Firebase в свое веб-приложение . Обязательно запустите следующую команду со своего терминала:
npm install firebase@11.0.2 --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.6.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:21.1.0") }
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.6.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:21.1.0") }
Dart
Следуйте инструкциям, чтобы добавить Firebase в ваше приложение Flutter .
Из корня вашего проекта Flutter выполните следующую команду, чтобы установить плагин:
flutter pub add cloud_functionsПосле завершения перестройте приложение Flutter:
flutter runПосле установки вы можете получить доступ к плагину
cloud_functions, импортировав его в свой код Dart:import 'package:cloud_functions/cloud_functions.dart';
С++
Для 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
-
Единство
- Следуйте инструкциям, чтобы добавить Firebase в свой проект Unity .
- Добавьте
FirebaseFunctions.unitypackageиз Firebase Unity SDK в свой проект Unity.
Инициализируйте клиентский SDK
Инициализируйте экземпляр Cloud Functions :
Быстрый
lazy var functions = Functions.functions()
Цель-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+KTX
private lateinit var functions: FirebaseFunctions // ... functions = Firebase.functions
Java
private FirebaseFunctions mFunctions; // ... mFunctions = FirebaseFunctions.getInstance();
Dart
final functions = FirebaseFunctions.instance;
С++
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
}
}
Цель-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+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
}
}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;
С++
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]
}
// ...
}
Цель-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+KTX
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);
}
С++
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 , чтобы гарантировать, что только ваши приложения могут получить доступ к конечным точкам вызываемых функций.