Cloud Functions for Firebase istemci SDK'ları, işlevleri doğrudan bir Firebase uygulamasından çağırmanıza olanak tanır. Bir işlevi uygulamanızdan bu şekilde çağırmak için Cloud Functions içinde bir HTTP çağrılabilir işlevi yazıp dağıtın ve ardından işlevi uygulamanızdan çağırmak için istemci mantığı ekleyin.
HTTP çağrılabilir işlevlerinin HTTP işlevlerine benzer olduğunu ancak aynı olmadığını unutmayın. HTTP çağrılabilir işlevlerini kullanmak için platformunuzun istemci SDK'sını arka uç API'siyle birlikte kullanmanız (veya protokolü uygulamanız) gerekir. Çağrılabilir işlevler, HTTP işlevlerinden şu temel farklarla ayrılır:
- Çağrılabilir işlevler kullanıldığında Firebase Authentication jetonları, FCM jetonları ve App Check jetonları (varsa) isteklere otomatik olarak dahil edilir.
- Tetikleyici, istek gövdesini otomatik olarak seri durumdan çıkarır ve kimlik doğrulama jetonlarını doğrular.
Cloud Functions 2. nesil ve sonraki sürümler için Firebase SDK'sı, HTTPS çağrılabilir işlevlerini desteklemek için aşağıdaki Firebase istemci SDK'sı minimum sürümleriyle birlikte çalışır:
- Apple platformları için Firebase SDK'sı 13.0.0
- Firebase için Android SDK'sı 23.0.0
- Firebase Modüler Web SDK'sı 9.7.0 sürümü
Desteklenmeyen bir platformda oluşturulmuş bir uygulamaya benzer işlevler eklemek istiyorsanız https.onCall için Protokol Spesifikasyonu'na bakın. Bu kılavuzun geri kalanında Apple platformları, Android, web, C++ ve Unity için HTTP çağrılabilir işlevinin nasıl yazılacağı, dağıtılacağı ve çağrılacağıyla ilgili talimatlar verilmektedir.
Çağrılabilir işlevi yazma ve dağıtma
HTTPS çağrılabilir işlevi oluşturmak için functions.https.onCall kullanın. Bu yöntem iki parametre alır: data ve isteğe bağlı context:
// Saves a message to the Firebase Realtime Database but sanitizes the // text by removing swearwords. exports.addMessage = functions.https.onCall((data, context) => { // ... });
Örneğin, bir kısa mesajı Realtime Database veritabanına kaydeden çağrılabilir bir işlevde data, mesaj metnini içerebilir. context parametreleri ise kullanıcı kimlik doğrulama bilgilerini temsil eder:
// 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;
Çağrılabilir işlevin konumu ile çağrıyı yapan istemcinin konumu arasındaki mesafe, ağ gecikmesine neden olabilir. Performansı optimize etmek için uygun durumlarda işlev konumunu belirtmeyi ve çağrılabilir işlevin konumunu, istemci tarafında SDK'yı başlattığınızda ayarlanan konumla eşleştirmeyi unutmayın.
İsterseniz arka uç kaynaklarınızı faturalandırma sahtekarlığı veya kimlik avı gibi kötüye kullanımlardan korumaya yardımcı olmak için bir App Check onayı ekleyebilirsiniz. Cloud Functions için App Check yaptırımını etkinleştirme başlıklı makaleyi inceleyin.
Sonuç geri gönderiliyor
Verileri istemciye geri göndermek için JSON olarak kodlanabilen verileri döndürün. Örneğin, bir toplama işleminin sonucunu döndürmek için:
// returning result.
return {
firstNumber: firstNumber,
secondNumber: secondNumber,
operator: "+",
operationResult: firstNumber + secondNumber,
};
Eşzamansız bir işlemden sonra veri döndürmek için bir promise döndürün. Promise tarafından döndürülen veriler istemciye geri gönderilir. Örneğin, çağrılabilir işlevin Realtime Database konumuna yazdığı temizlenmiş metni döndürebilirsiniz:
// 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};
})
Hataları işleme
İstemcinin faydalı hata ayrıntıları almasını sağlamak için functions.https.HttpsError örneği oluşturarak (veya reddedilen bir Promise döndürerek) çağrılabilir işlevden hata döndürün.
Hatanın, functions.https.HttpsError adresinde listelenen değerlerden biri olabilecek bir code özelliği vardır.
Hatalarda ayrıca varsayılan olarak boş bir dize olan message dizesi de bulunur. Ayrıca isteğe bağlı bir details alanı ve rastgele bir değer de içerebilirler. İşlevlerinizden HttpsError dışında bir hata döndürülürse istemciniz INTERNAL mesajını ve internal kodunu içeren bir hata alır.
Örneğin, bir işlev, çağıran istemciye döndürülecek hata mesajlarıyla birlikte veri doğrulama ve kimlik doğrulama hataları verebilir:
// 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.");
}
Çağrılabilir işlevi dağıtma
Tamamlanmış bir çağrılabilir işlevi index.js içine kaydettikten sonra firebase deploy komutunu çalıştırdığınızda bu işlev diğer tüm işlevlerle birlikte dağıtılır.
Yalnızca çağrılabilir işlevi dağıtmak için --only bağımsız değişkenini kullanarak kısmi dağıtım yapın:
firebase deploy --only functions:addMessage
İşlevleri dağıtırken izin hatalarıyla karşılaşırsanız dağıtım komutlarını çalıştıran kullanıcıya uygun IAM rollerinin atandığından emin olun.
İstemci geliştirme ortamınızı ayarlama
Ön koşulları karşıladığınızdan emin olun, ardından gerekli bağımlılıkları ve istemci kitaplıklarını uygulamanıza ekleyin.
iOS+
Firebase'i Apple uygulamanıza ekleme talimatlarını uygulayın.
Firebase bağımlılıklarını yüklemek ve yönetmek için Swift Package Manager'ı kullanın.
Firebase SDK'larını Apple projenize eklemenin farklı yollarını öğrenmek için- Xcode'da uygulama projeniz açıkken File > Add Packages'a (Dosya > Paket Ekle) gidin.
- İstendiğinde Firebase Apple platformları SDK deposunu ekleyin:
- Cloud Functions kitaplığını seçin.
- Hedefinizin derleme ayarlarının Other Linker Flags (Diğer Bağlayıcı İşaretleri) bölümüne
-ObjCişaretini ekleyin. - İşlem tamamlandığında Xcode, arka planda bağımlılıklarınızı otomatik olarak çözmeye ve indirmeye başlar.
https://github.com/firebase/firebase-ios-sdk.git
Web
- Firebase'i web uygulamanıza ekleme talimatlarını uygulayın. Terminalinizden aşağıdaki komutu çalıştırdığınızdan emin olun:
npm install firebase@13.0.0 --save
Hem Firebase Core hem de Cloud Functions için manuel olarak zorunlu kılın:
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
- Web uygulamanıza Firebase ekleme talimatlarını uygulayın.
- Firebase çekirdeğini ve Cloud Functions istemci kitaplıklarını uygulamanıza ekleyin:
<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'sı, npm paketi olarak da kullanılabilir.
- Terminalinizden aşağıdaki komutu çalıştırın:
npm install firebase@8.10.1 --save
- Hem Firebase Core hem de Cloud Functions için manuel olarak zorunlu kılın:
const firebase = require("firebase"); // Required for side-effects require("firebase/functions");
Kotlin
Firebase'i Android uygulamanıza ekleme talimatlarını uygulayın.
Modülünüzün (uygulama düzeyinde) Gradle dosyasında (genellikle
<project>/<app-module>/build.gradle.ktsveya<project>/<app-module>/build.gradle) Android için Cloud Functions kitaplığına olan bağımlılığı ekleyin. Kitaplık sürümünü kontrol etmek için Firebase Android BoM kullanmanızı öneririz.dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:35.0.2")) // 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 kullanarak uygulamanızın her zaman Firebase Android kitaplıklarının uyumlu sürümlerini kullanmasını sağlayabilirsiniz.
(Alternatif) BoM kullanmadan Firebase kitaplığı bağımlılıklarını ekleme
Firebase BoM kullanmamayı tercih ederseniz her Firebase kitaplığı sürümünü kendi bağımlılık satırında belirtmeniz gerekir.
Uygulamanızda birden fazla Firebase kitaplığı kullanıyorsanız kitaplık sürümlerini yönetmek için BoM kullanmanızı önemle tavsiye ederiz. Bu sayede tüm sürümlerin uyumlu olmasını sağlayabilirsiniz.
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:23.0.0") }
Java
Firebase'i Android uygulamanıza ekleme talimatlarını uygulayın.
Modülünüzün (uygulama düzeyinde) Gradle dosyasında (genellikle
<project>/<app-module>/build.gradle.ktsveya<project>/<app-module>/build.gradle) Android için Cloud Functions kitaplığına olan bağımlılığı ekleyin. Kitaplık sürümünü kontrol etmek için Firebase Android BoM kullanmanızı öneririz.dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:35.0.2")) // 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 kullanarak uygulamanızın her zaman Firebase Android kitaplıklarının uyumlu sürümlerini kullanmasını sağlayabilirsiniz.
(Alternatif) BoM kullanmadan Firebase kitaplığı bağımlılıklarını ekleme
Firebase BoM kullanmamayı tercih ederseniz her Firebase kitaplığı sürümünü kendi bağımlılık satırında belirtmeniz gerekir.
Uygulamanızda birden fazla Firebase kitaplığı kullanıyorsanız kitaplık sürümlerini yönetmek için BoM kullanmanızı önemle tavsiye ederiz. Bu sayede tüm sürümlerin uyumlu olmasını sağlayabilirsiniz.
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:23.0.0") }
Dart
Flutter uygulamanıza Firebase ekleme talimatlarını uygulayın.
Eklentiyi yüklemek için Flutter projenizin kök dizininden aşağıdaki komutu çalıştırın:
flutter pub add cloud_functionsİşlem tamamlandıktan sonra Flutter uygulamanızı yeniden derleyin:
flutter runYüklendikten sonra, Dart kodunuza aktararak
cloud_functionseklentisine erişebilirsiniz:import 'package:cloud_functions/cloud_functions.dart';
C++
Android ile C++ için:
- Firebase'i C++ projenize ekleme talimatlarını uygulayın.
firebase_functionskitaplığınıCMakeLists.txtdosyanıza ekleyin.
Apple platformlarında C++ için:
- Firebase'i C++ projenize ekleme talimatlarını uygulayın.
- Cloud Functions kapsülünü
Podfiledosyanıza ekleyin:pod 'Firebase/Functions'
- Dosyayı kaydedin ve ardından şu komutu çalıştırın:
pod install
- Firebase C++ SDK'sından Firebase çekirdeğini ve Cloud Functions çerçevelerini Xcode projenize ekleyin.
firebase.frameworkfirebase_functions.framework
Unity
- Firebase'i Unity projenize ekleme talimatlarını uygulayın.
- Firebase Unity SDK'sındaki
FirebaseFunctions.unitypackageöğesini Unity projenize ekleyin.
İstemci SDK'sını başlatma
Cloud Functions örneğini başlatın:
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;
İşlevi çağırma
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;
});
}
İstemcideki hataları işleme
Sunucu bir hata verirse veya sonuçta elde edilen promise reddedilirse istemci bir hata alır.
İşlev tarafından döndürülen hata function.https.HttpsError türündeyse istemci, sunucu hatasından code, message ve details hatasını alır. Aksi takdirde hata, INTERNAL mesajını ve INTERNAL kodunu içerir. Çağrılabilir işlevinizdeki hataları nasıl ele alacağınızla ilgili kılavuzu inceleyin.
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;
}
});
İstemci zaman aşımı ayarlama
Varsayılan olarak Cloud Functions istemci SDK'ları, çağrılabilir istekler için 70 saniyelik bir zaman aşımı süresi kullanır. Çağrılabilir bir işlevin tamamlanması 70 saniyeden uzun sürerse istemci SDK'sı, daha uzun bir sunucu tarafı zaman aşımı yapılandırmış olsanız bile isteği DEADLINE_EXCEEDED (deadline-exceeded) hatasıyla sonlandırır.
Uzun süre çalışan çağrılabilir işlevleri desteklemek için hem sunucuda hem de istemcide zaman aşımını artırmanız gerekir:
- Sunucu tarafı işlev zaman aşımını artırın (Zaman aşımını ve bellek ayırmayı ayarlama bölümüne bakın).
- Uygulamanızda çağrılabilir referansı yapılandırırken istemci tarafı zaman aşımını artırın:
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,
});
Önerilir: App Check ile kötüye kullanımı önleyin
Uygulamanızı kullanıma sunmadan önce, yalnızca uygulamalarınızın çağrılabilir işlev uç noktalarınıza erişebilmesini sağlamak için App Check'yi etkinleştirmeniz gerekir.