Cloud Functions for Firebase istemci SDK'ları, işlevleri doğrudan Firebase uygulamasından çağırmanıza olanak tanır. Uygulamanızdan bir işlevi bu şekilde çağırmak için Cloud Functions'ta bir HTTP Çağrılabilir işlevi yazıp dağıtın. Ardından, işlevi uygulamanızdan çağırmak için istemci mantığı ekleyin.
HTTP çağrılabilir işlevlerinin benzer olduğunu ancak HTTP işlevlerine aynı olmadığını aklınızda bulundurun. HTTP çağrılabilir işlevleri kullanmak için arka uç API ile birlikte platformunuzun istemci SDK'sını kullanmanız (veya protokolü uygulamanız) gerekir. Çağrılanabilir öğelerin HTTP işlevlerinden farkı vardır:
- Kullanılabilir olduğunda, çağrılabilirler, Firebase Authentication jetonları, FCM jetonları ve Uygulama Kontrolü jetonları ile isteklere otomatik olarak dahil edilir.
- Tetikleyici, istek gövdesinde otomatik olarak seri durumdan çıkar ve kimlik doğrulama jetonlarını doğrular.
Cloud Functions 2. nesil ve üst sürümleri için Firebase SDK'sı, HTTPS çağrılabilir işlevlerini desteklemek için şu Firebase istemci SDK'sı minimum sürümleriyle birlikte çalışır:
- Apple platformlar için Firebase SDK'sı 10.28.0
- Android 21.0.0 için Firebase SDK'sı
- Firebase Modüler Web SDK'sı v. 9.7.0
Desteklenmeyen bir platformda oluşturulan 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 bir işlevi yazma, dağıtma ve çağırma hakkında talimatlar sağlanmaktadır.
Çağrılabilir işlevi yazma ve dağıtma
HTTPS çağrılabilir bir işlev 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) => { // ... });
Realtime Database'e kısa mesaj kaydeden çağrılabilir bir işlev söz konusu olduğunda örneğin, data
mesaj metnini içerebilirken context
parametreleri kullanıcı kimlik doğrulama bilgilerini temsil edebilir:
// 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ılanabilir işlevin konumu ile arayan istemcinin konumu arasındaki mesafe, ağ gecikmesi oluşturabilir. Performansı optimize etmek için uygun olan durumlarda işlev konumunu belirtmeyi düşünün ve istemci tarafında SDK'yı başlatırken çağrılabilirin konumunu ayarlanan konumla uyumlu hale getirdiğinizden emin olun.
İsteğe bağlı olarak, arka uç kaynaklarınızı faturalandırma sahtekarlığı veya kimlik avı gibi kötüye kullanımlardan korumaya yardımcı olması için bir Uygulama Kontrolü onayı ekleyebilirsiniz. Cloud Functions için Uygulama Kontrolü'nün zorunlu kılınmasını etkinleştirme bölümüne bakın.
Sonucu geri gönderme
Verileri istemciye geri göndermek için JSON kodlu veriler 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 söz döndürün. Vaat ile döndürülen veriler müşteriye geri gönderilir. Örneğin, çağrılabilir işlevin Realtime Database'e 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ı aldığından emin olmak için functions.https.HttpsError
örneği göndererek (veya bir Promise ile birlikte reddedilen Promise döndürerek) çağrılabilir bir kullanıcıdan hata döndürün.
Hatanın, functions.https.HttpsError
adresinde listelenen değerlerden biri olabilecek bir code
özelliği var.
Hatalarda ayrıca, varsayılan olarak boş bir dizeye karşılık gelen bir message
dizesi bulunur. Ayrıca, isteğe bağlı bir değere sahip isteğe bağlı details
alanı da olabilir. İşlevlerinizden HttpsError
dışında bir hata atılırsa istemciniz bunun yerine INTERNAL
mesajını ve internal
kodunu içeren bir hata alır.
Örneğin, bir işlev çağıran istemciye dönmek için hata mesajlarıyla birlikte veri doğrulama ve kimlik doğrulama hataları gönderebilir:
// 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
index.js
içinde tamamlanan bir çağrılabilir işlevi kaydettikten sonra, firebase deploy
çalıştırdığınızda diğer tüm işlevlerle birlikte dağıtılır.
Yalnızca çağrılabilir öğeyi dağıtmak için --only
bağımsız değişkenini kullanarak kısmi dağıtımlar gerçekleştirin:
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 ve üzeri
Firebase'i Apple uygulamanıza ekleme talimatlarını uygulayın.
Firebase bağımlılıklarını yükleyip yönetmek için Swift Package Manager'ı kullanın.
- Xcode'da, uygulamanız açıkken File > Add Packages'a (Dosya > Paket Ekle) gidin.
- İstendiğinde Firebase Apple platformlar SDK deposunu ekleyin:
- Cloud Functions kitaplığını seçin.
-ObjC
işaretini, hedefinizin derleme ayarlarındaki Diğer Bağlayıcı İşaretleri bölümüne ekleyin.- İşlem tamamlandığında Xcode, arka planda bağımlılıklarınızı otomatik olarak çözümlemeye ve indirmeye başlar.
https://github.com/firebase/firebase-ios-sdk.git
Web
- Firebase'i web uygulamanıza ekleme talimatlarını uygulayın. Terminalden şu komutu çalıştırdığınızdan emin olun:
npm install firebase@10.12.3 --save
Hem Firebase Core hem de Cloud Functions'ı 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
- Firebase'i web uygulamanıza ekleme talimatlarını uygulayın.
- Uygulamanıza Firebase temel ve Cloud Functions istemci kitaplıklarını 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 şu komutu çalıştırın:
npm install firebase@8.10.1 --save
- Hem Firebase Core hem de Cloud Functions'ı manuel olarak zorunlu kılın:
const firebase = require("firebase"); // Required for side-effects require("firebase/functions");
Kotlin+KTX
Firebase'i Android uygulamanıza ekleme talimatlarını uygulayın.
Modül (uygulama düzeyinde) Gradle dosyanıza (genellikle
<project>/<app-module>/build.gradle.kts
veya<project>/<app-module>/build.gradle
), Android için Cloud Functions kitaplığına yönelik bağımlılığı ekleyin. Kitaplık sürümünü kontrol etmek için Firebase Android BoM'u kullanmanızı öneririz.dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.1.1")) // 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 kullanıldığında uygulamanız Firebase Android kitaplıklarının her zaman uyumlu sürümlerini kullanır.
(Alternatif) BoM'u kullanmadan Firebase kitaplığı bağımlılıklarını ekleme
Firebase BoM'yi kullanmamayı seçerseniz her Firebase kitaplığı sürümünü 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. Böylece tüm sürümlerin uyumlu olması sağlanır.
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.0.0") }
Java
Firebase'i Android uygulamanıza ekleme talimatlarını uygulayın.
Modül (uygulama düzeyinde) Gradle dosyanıza (genellikle
<project>/<app-module>/build.gradle.kts
veya<project>/<app-module>/build.gradle
), Android için Cloud Functions kitaplığına yönelik bağımlılığı ekleyin. Kitaplık sürümünü kontrol etmek için Firebase Android BoM'u kullanmanızı öneririz.dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.1.1")) // 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 kullanıldığında uygulamanız Firebase Android kitaplıklarının her zaman uyumlu sürümlerini kullanır.
(Alternatif) BoM'u kullanmadan Firebase kitaplığı bağımlılıklarını ekleme
Firebase BoM'yi kullanmamayı seçerseniz her Firebase kitaplığı sürümünü 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. Böylece tüm sürümlerin uyumlu olması sağlanır.
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.0.0") }
Dart
Firebase'i Flutter uygulamanıza ekleme talimatlarını uygulayın.
Flutter projenizin kök dizininden aşağıdaki komutu çalıştırarak eklentiyi yükleyin:
flutter pub add cloud_functions
İşlem tamamlandığında Flutter uygulamanızı yeniden derleyin:
flutter run
Uzantıyı yükledikten sonra, Dart kodunuza içe aktararak
cloud_functions
eklentisine 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_functions
kitaplığınıCMakeLists.txt
dosyanıza ekleyin.
Apple platformlarıyla C++ için:
- Firebase'i C++ projenize ekleme talimatlarını uygulayın.
Podfile
öğenize Cloud Functions kapsülünü ekleyin:pod 'Firebase/Functions'
- Dosyayı kaydedin ve şunu çalıştırın:
pod install
- Firebase C++ SDK'sındaki Firebase temel ve Cloud Functions çerçevelerini Xcode projenize ekleyin.
firebase.framework
firebase_functions.framework
Unity
- Firebase'i Unity projenize ekleme talimatlarını uygulayın.
- Firebase Unity SDK'sından
FirebaseFunctions.unitypackage
öğesini Unity projenize ekleyin.
İstemci SDK'sını başlatma
Bir 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+KTX
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ğırın
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+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;
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 bildirirse veya sonuç olarak verilen söz reddedilirse istemci hata alır.
İşlev 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ın nasıl işleneceği ile ilgili yol gösterici bilgilere bakın.
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+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);
}
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;
}
});
Önerilen: Uygulama Kontrolü ile kötüye kullanımı önleme
Uygulamanızı başlatmadan önce, çağrılabilir işlev uç noktalarınıza yalnızca uygulamalarınızın erişebildiğinden emin olmak için Uygulama Kontrolü'nü etkinleştirmeniz gerekir.