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'te 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 ancak aynı olmadığını unutmayın. HTTP'de ç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ılabilirler, HTTP işlevlerinden şu temel farklılıklara sahiptir:
- Çağırılabilir öğelerde, Firebase Authentication jetonları, FCM jetonları ve App Check jetonları (varsa) isteklere otomatik olarak dahil edilir.
- Tetikleyici, istek gövdesini otomatik olarak dize dışına çıkarır ve kimlik doğrulama jetonlarını doğrular.
2. nesil ve sonraki model Cloud Functions için Firebase SDK'sı, HTTPS çağrılabilir işlevleri desteklemek üzere aşağıdaki Firebase istemci SDK'sı minimum sürümleriyle birlikte çalışır:
- Apple platformları için Firebase SDK'sı 11.5.0
- Android 21.1.0 için Firebase SDK'sı
- Firebase Modüler Web SDK'sı 9.7.0 sürümü
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 işlev yazma, dağıtma ve çağırma talimatları verilmiştir.
Çağırılabilir işlevi yazıp dağıtma
HTTPS çağrılabilir işlevi oluşturmak için functions.https.onCall
simgesini 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 alanına kaydeden bir çağrılabilir işlev iç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ılabilir işlevin konumu ile arayan istemcinin konumu arasındaki mesafe ağ gecikmesi oluşturabilir. Performansı optimize etmek için, geçerli olduğu durumlarda fonksiyon konumunu belirtmeyi düşünün ve çağrılabilir öğenin konumunu, istemci tarafında SDK'yı başlattığınızda 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ımlara karşı korumaya yardımcı olması için bir App Check tasdiki ekleyebilirsiniz. Cloud Functions için App Check yaptırımını etkinleştirme başlıklı makaleyi inceleyin.
Sonucu geri gönderme
Verileri istemciye geri göndermek için JSON kodlanabilen 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 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 alanına 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 yararlı hata ayrıntıları almasını sağlamak için functions.https.HttpsError
örneği atarak (veya reddedilen bir Promise döndürerek) bir çağrılabilir öğeden hataları döndürün.
Hata, functions.https.HttpsError
adresinde listelenen değerlerden biri olabilecek bir code
özelliğine sahiptir.
Hatalarda, varsayılan olarak boş bir dize olan message
dizesi de bulunur. İsteğe bağlı olarak, rastgele bir değere sahip bir details
alanına da sahip olabilirler. İşlevlerinizden HttpsError
dışında bir hata atılırsa bunun yerine müşterinize INTERNAL
mesajı ve internal
kodu içeren bir hata gönderilir.
Örneğin, bir işlev, çağıran istemciye döndürülecek hata mesajlarıyla veri doğrulama ve kimlik doğrulama hataları atabilir:
// 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
'ü çalıştırdığınızda bu işlev diğer tüm işlevlerle birlikte dağıtılır.
Yalnızca çağrılabilir öğeyi dağıtmak için kısmi dağıtımlar gerçekleştirmek üzere gösterildiği gibi --only
bağımsız değişkenini kullanı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
Tüm ön koşulları karşıladığınızdan emin olduktan sonra uygulamanıza gerekli bağımlılıkları ve istemci kitaplıklarını ekleyin.
iOS+
Firebase'i Apple uygulamanıza ekleme talimatlarını uygulayın.
Firebase bağımlılarını yüklemek ve yönetmek için Swift Package Manager'ı kullanın.
Firebase SDK'larını Apple projenize eklemenin farklı yolları (ör. doğrudan çerçeveleri içe aktarma ve CocoaPods kullanma) hakkında bilgi edinmek için- Xcode'da, uygulamanız açıkken Dosya > Paket Ekle'ye gidin.
- İstendiğinde Firebase Apple platformları SDK deposunu ekleyin:
- Cloud Functions kitaplığını seçin.
-ObjC
işaretini, hedefinizin derleme ayarlarının Diğer Bağlantı Oluşturucu İşaretleri bölümüne ekleyin.- İşlem tamamlandığında Xcode, arka planda bağımlıları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. Terminalinizde aşağıdaki komutu çalıştırdığınızdan emin olun:
npm install firebase@11.0.2 --save
Hem Firebase Core'u 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.
- Firebase çekirdek 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.
- Terminalinizde aşağıdaki komutu çalıştırın:
npm install firebase@8.10.1 --save
- Hem Firebase Core'u 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üzeyi) Gradle dosyanıza (genellikle
<project>/<app-module>/build.gradle.kts
veya<project>/<app-module>/build.gradle
) Android için Cloud Functions kitaplığının bağımlılığını ekleyin. Kitaplık sürümlendirmesini kontrol etmek için Firebase Android BoM simgesini kullanmanızı öneririz.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 kullanıldığında uygulamanız Firebase Android kitaplıklarının daima uyumlu sürümlerini kullanır.
(Alternatif) BoM
Firebase BoM kullanmamayı seçerseniz her Firebase kitaplık 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. Bu, tüm sürümlerin uyumlu olmasını sağlar.
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'i Android uygulamanıza ekleme talimatlarını uygulayın.
Modül (uygulama düzeyi) Gradle dosyanıza (genellikle
<project>/<app-module>/build.gradle.kts
veya<project>/<app-module>/build.gradle
) Android için Cloud Functions kitaplığının bağımlılığını ekleyin. Kitaplık sürümlendirmesini kontrol etmek için Firebase Android BoM simgesini kullanmanızı öneririz.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 kullanıldığında uygulamanız Firebase Android kitaplıklarının daima uyumlu sürümlerini kullanır.
(Alternatif) BoM
Firebase BoM kullanmamayı seçerseniz her Firebase kitaplık 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. Bu, tüm sürümlerin uyumlu olmasını sağlar.
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'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 oluşturun:
flutter run
Yükledikten sonra
cloud_functions
eklentisini Dart kodunuza içe aktararak 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.
- Cloud Functions kapsülünü
Podfile
'inize ekleyin:pod 'Firebase/Functions'
- Dosyayı kaydedin ve şunu çalıştırın:
pod install
- Firebase C++ SDK'sından Firebase çekirdeğini 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
'yi 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+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ğı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+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;
});
}
İstemcide hataları işleme
Sunucu bir hata atarsa veya sonuçta ortaya çıkan söz reddedilirse istemci bir hata alır.
İşlev tarafından döndürülen hata function.https.HttpsError
türüne sahipse istemci, sunucu hatasından code
, message
ve details
hatalarını alır. Aksi takdirde hata mesajında INTERNAL
ve INTERNAL
kodu yer alır. Çağırılabilir işlevinizde hataları nasıl ele alacağınızla ilgili yönergeleri 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+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: 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 seçeneğini etkinleştirmeniz gerekir.