Cloud Functions for Firebase istemci SDK'ları, işlevleri doğrudan Firebase uygulaması. Uygulamanızdan bir işlevi bu şekilde çağırmak için yazma ve dağıtma Cloud Functions içinde bir HTTP Çağrılabilir işlevi ve 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şlevleriyle aynı değildir. HTTP çağrılabilir işlevlerini kullanmak için arka uç API'sini kullanın (veya protokolü uygulayın). Aranabilir cihazlarda bu tuşlar bulunur ve HTTP işlevlerinden farkı:
- Çağrılanabilir öğelerle, Firebase Authentication jetonlar, FCM jetonlar ve App Check jetonlar varsa 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ü için Firebase SDK'sı bu Firebase istemcisiyle birlikte çalışıyor HTTPS çağrılabilir işlevlerini desteklemek için minimum SDK sürümleri:
- Apple platformları 11.0.0 için Firebase SDK'sı
- Android 21.0.0 için Firebase SDK'sı
- Firebase Modüler Web SDK'sı v. 9.7.0
Desteklenmeyen bir sürüme sahip bir uygulamaya benzer işlevler eklemek
https.onCall
için Protokol Spesifikasyonu'na bakın. Bu kılavuzun geri kalanında
Yazma, dağıtma ve çağırmaya ilişkin talimatlar
Apple platformları, Android, web, C++ ve Unity için HTTP çağrılabilir işlevi.
Çağrılabilir işlevi yazma ve dağıtma
functions.https.onCall
kullanın
işlevini 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 cihazına kısa mesaj kaydeden çağrılabilir bir işlev için
örneğin, data
mesaj metnini içerebilirken context
Parametreler kullanıcı kimlik doğrulaması 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ılanabilir işlevin konumu ile konum arasındaki mesafe bağlantısında gecikme yaşanabilir. Performansı optimize etmek için bir işlev konumunu ve arayanın konumunu konum ile aynı hizaya getirdiğinizden emin olun SDK'yı başlattığınızda ayarlanır tarafını da kullanabilirsiniz.
İsteğe bağlı olarak, hesabınızın korunmasına yardımcı olmak için bir App Check onayı ekleyebilirsiniz. faturalandırma sahtekarlığı veya kimlik avı gibi kötüye kullanıma karşı arka uç kaynakları. Görüntüleyin Cloud Functions için App Check yaptırımını etkinleştirin.
Sonucu geri gönderme
Verileri istemciye geri göndermek için JSON kodlu veriler döndürün. Örneğin, örneği: 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. Veriler yine müşteriye gönderilir. Örneğin, çağrılabilir işlevin Realtime Database öğesine yazdığı temizlenmiş metni döndürebilir:
// 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ını aldığından emin olmak için çağrılanabilir bir cihazdan hata döndürün
bunun bir örneğini göndererek (veya
functions.https.HttpsError
Hata, listelenen değerlerden biri olabilecek bir code
özelliği içeriyor.
functions.https.HttpsError
.
Hatalarda ayrıca, varsayılan olarak ayarlanan message
dizesi de bulunur.
kullanabilirsiniz. Ayrıca, isteğe bağlı bir details
alanı da
isteğe bağlı değer. Fonksiyonlarınızdan HttpsError
dışında bir hata atılırsa
istemciniz bunun yerine INTERNAL
mesajı ve kodu içeren bir hata alıyor
internal
.
Örneğin, bir işlev veri doğrulama ve kimlik doğrulama hataları gönderebilir hata mesajlarıyla birlikte arayan istemciye geri dönün:
// 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 tamamlanmış 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 şu şekilde kullanın:
kısmi dağıtımlar:
firebase deploy --only functions:addMessage
İşlevleri dağıtırken izin hatalarıyla karşılaşırsanız şunların sağlandığından emin olun: uygun IAM rollerini kullanıcıya atanır.
İstemci geliştirme ortamınızı ayarlama
Tüm ön koşulları karşıladığınızdan emin olun, ardından gerekli bağımlılıkları eklemeniz gerekir.
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 Dosya > Paket Ekle'yi tıklayın.
- İ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.- İşlemi tamamladığınızda, Xcode otomatik olarak arka planda tutmalarını sağlayabilirsiniz.
https://github.com/firebase/firebase-ios-sdk.git.
Web
- Talimatları uygulayarak
Firebase'i web uygulamanıza ekleyin. Tüm
terminalinizden aşağıdaki komutu kullanın:
npm install firebase@10.13 --save
Hem Firebase Core'u hem de Cloud Functions API'yi 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
- Talimatları uygulayarak Firebase'i web uygulamanıza ekleyin.
- Firebase çekirdeği ve Cloud Functions istemci kitaplıklarını
uygulama:
<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'u hem de Cloud Functions API'yi manuel olarak zorunlu kılın:
const firebase = require("firebase"); // Required for side-effects require("firebase/functions");
Kotlin+KTX
Talimatları uygulayarak Firebase'i Android uygulamanıza ekleyin.
Modül (uygulama düzeyinde) Gradle dosyanızda (genellikle
<project>/<app-module>/build.gradle.kts
veya<project>/<app-module>/build.gradle
), Android için Cloud Functions kitaplığına bağımlılığı ekleyin. Şunu kullanmanızı öneririz: Firebase Android BoM Kitaplık'ta sürüm oluşturmayı kontrol etmek içindependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.1.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 kullanıldığında, Uygulamanız her zaman Firebase Android kitaplıklarının uyumlu sürümlerini kullanacaktır.
(Alternatif) Firebase kitaplığı bağımlılıklarını kullanmadan BoM
Firebase BoM kullanmamayı seçerseniz her Firebase kitaplığı sürümünü belirtmeniz gerekir değerini alır.
Uygulamanızda birden çok Firebase kitaplığı kullanıyorsanız, kitaplık sürümlerini yönetmek için BoM kullanmanızı öneririz. Bu, tüm sürümlerin uyumlu olduğundan emin olun.
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
Talimatları uygulayarak Firebase'i Android uygulamanıza ekleyin.
Modül (uygulama düzeyinde) Gradle dosyanızda (genellikle
<project>/<app-module>/build.gradle.kts
veya<project>/<app-module>/build.gradle
), Android için Cloud Functions kitaplığına bağımlılığı ekleyin. Şunu kullanmanızı öneririz: Firebase Android BoM Kitaplık'ta sürüm oluşturmayı kontrol etmek içindependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.1.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 kullanıldığında, Uygulamanız her zaman Firebase Android kitaplıklarının uyumlu sürümlerini kullanacaktır.
(Alternatif) Firebase kitaplığı bağımlılıklarını kullanmadan BoM
Firebase BoM kullanmamayı seçerseniz her Firebase kitaplığı sürümünü belirtmeniz gerekir değerini alır.
Uygulamanızda birden çok Firebase kitaplığı kullanıyorsanız, kitaplık sürümlerini yönetmek için BoM kullanmanızı öneririz. Bu, tüm sürümlerin uyumlu olduğundan emin olun.
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
Talimatları uygulayarak Firebase'i Flutter uygulamanıza ekleyin.
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
Yüklendikten sonra
cloud_functions
uygulamasına erişebilirsiniz eklentisine eklemeniz gerekir:import 'package:cloud_functions/cloud_functions.dart';
C++
Android ile C++ için:
- Talimatları uygulayarak Firebase'i C++ projenize ekleyin.
firebase_functions
kitaplığınıCMakeLists.txt
dosyanıza ekleyin.
Apple platformlarıyla C++ için:
- Talimatları uygulayarak Firebase'i C++ projenize ekleyin.
- Cloud Functions kapsülünü
Podfile
cihazınıza ekleyin:pod 'Firebase/Functions'
- Dosyayı kaydedin, ardından şunu çalıştırın:
pod install
. - Şu sayfadan Firebase temel ve Cloud Functions çerçevelerini ekleyin:
Xcode projenize Firebase C++ SDK ekleyin.
firebase.framework
firebase_functions.framework
Unity
- Talimatları uygulayarak Firebase'i Unity projenize ekleyin.
- Firebase Unity SDK'sından
FirebaseFunctions.unitypackage
öğesini şuraya ekleyin: derleyip toparlarsınız.
İ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 verdiyse veya sonucunda vaat edilenler reddedilmiştir.
İşlev function.https.HttpsError
türündeyse
istemci code
, message
ve details
hatasını
sunucu hatası. Aksi takdirde hata, INTERNAL
mesajını ve
kod INTERNAL
. Aşağıdakiler için kılavuza bakın:
hataları işleyebilir.
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;
}
});
App Check ile kötüye kullanımı önleyin
Uygulamanızı kullanıma sunmadan önce App Check özelliğini etkinleştirmeniz gerekir. çağrılabilir işlev uç noktalarınıza yalnızca uygulamalarınızın erişebildiğinden emin olun.