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
Bu bölümdeki kod örnekleri, sunucu tarafı işlevine nasıl istek gönderileceğini ve istemci SDK'larından birini kullanarak nasıl yanıt alınacağını gösteren eksiksiz bir hızlı başlangıç örneğine dayanmaktadır. Başlamak için gerekli modülleri içe aktarın:
Node.js
// Dependencies for callable functions.
const {onCall, HttpsError} = require("firebase-functions/https");
const {logger} = require("firebase-functions");
// Dependencies for the addMessage function.
const {getDatabase} = require("firebase-admin/database");
const sanitizer = require("./sanitizer");
Python
# Dependencies for callable functions.
from firebase_functions import https_fn, options
# Dependencies for writing to Realtime Database.
from firebase_admin import db, initialize_app
Dart (deneysel)
// Dependencies for callable functions.
import 'package:firebase_functions/firebase_functions.dart';
HTTPS çağrılabilir işlevi oluşturmak için platformunuzun istek işleyicisini kullanın. Bu yöntem bir istek parametresi alır:
Node.js
// Saves a message to the Firebase Realtime Database but sanitizes the
// text by removing swearwords.
exports.addmessage = onCall((request) => {
// ...
});
Python
@https_fn.on_call()
def addmessage(req: https_fn.CallableRequest) -> Any:
"""Saves a message to the Firebase Realtime Database but sanitizes the text
by removing swear words."""
Dart (deneysel)
// Adds two numbers to each other.
firebase.https.onCall(name: 'addNumbers', (request, response) async {
request parametresi, istemci uygulamasından aktarılan verilerin yanı sıra kimlik doğrulama durumu gibi ek bağlam bilgilerini içerir. Örneğin, bir kısa mesajı Realtime Database veritabanına kaydeden çağrılabilir bir işlev için data, mesaj metninin yanı sıra auth içinde kimlik doğrulama bilgilerini içerebilir:
Node.js
// 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;
Python
# Message text passed from the client.
text = req.data["text"]
# Authentication / user information is automatically added to the request.
uid = req.auth.uid
name = req.auth.token.get("name", "")
picture = req.auth.token.get("picture", "")
email = req.auth.token.get("email", "")
Dart (deneysel)
// Numbers passed from the client.
final data = request.data as Map<String, Object?>?;
final firstNumber = data?['firstNumber'];
final secondNumber = data?['secondNumber'];
// Authentication / user information is automatically added to the request.
final uid = request.auth?.uid;
final token = request.auth?.token;
final name = token?['name'];
final picture = token?['picture'];
final email = token?['email'];
// Use variables to suppress 'unused' lint warnings
print(
'User details: uid=$uid, name=$name, picture=$picture, email=$email',
);
Ç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.
Sonucu geri gönderme
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:
Node.js
// returning result.
return {
firstNumber: firstNumber,
secondNumber: secondNumber,
operator: "+",
operationResult: firstNumber + secondNumber,
};
Python
return {
"firstNumber": first_number,
"secondNumber": second_number,
"operator": "+",
"operationResult": first_number + second_number,
}
Dart (deneysel)
// returning result.
return CallableResult({
'firstNumber': firstNumber,
'secondNumber': secondNumber,
'operator': '+',
'operationResult': firstNumber + secondNumber,
});
Mesaj metni örneğindeki temizlenmiş metin hem istemciye hem de Realtime Database'e döndürülür. Node.js'de bu işlem, JavaScript promise kullanılarak eşzamansız olarak yapılabilir:
Node.js
// 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};
})
Python
# Saving the new message to the Realtime Database.
sanitized_message = sanitize_text(text) # Sanitize message.
db.reference("/messages").push(
{ # type: ignore
"text": sanitized_message,
"author": {"uid": uid, "name": name, "picture": picture, "email": email},
}
)
print("New message written")
# Returning the sanitized message to the client.
return {"text": sanitized_message}
İşleviniz bir değer döndürmelidir. Node.js kullanıyorsanız bir değerle çözümlenen bir Promise döndürmelidir. Aksi takdirde işlev, veriler istemciye geri gönderilmeden önce sonlandırılabilir. Yönergeler için İşlevleri sonlandırma bölümüne bakın.
Akış sonuçlarını gönderme ve alma
Çağrılabilir işlevlerde, akış sonuçlarını işlemek için mekanizmalar bulunur. Akış gerektiren bir kullanım alanınız varsa çağrılabilir istekte akışı yapılandırabilir ve ardından işlevi çağırmak için istemci SDK'sındaki uygun yöntemi kullanabilirsiniz.
Canlı yayın sonuçlarını gönderme
Zaman içinde oluşturulan sonuçları (ör. birkaç ayrı API isteğinden veya üretken yapay zeka API'sinden) verimli bir şekilde aktarmak için çağrılabilir isteğinizdeki acceptsStreaming özelliğini kontrol edin. Bu özellik true olarak ayarlandığında sonuçları response.sendChunk() ile istemciye geri aktarabilirsiniz.
Örneğin, bir uygulamanın birden fazla konum için hava durumu tahmini verilerini alması gerekiyorsa çağrılabilir işlev, tüm tahmin istekleri çözümlenene kadar beklemek yerine her konumun tahminini ayrı ayrı akış yanıtı isteyen istemcilere gönderebilir:
exports.getForecast = onCall(async (request, response) => { if (request.data?.locations?.length < 1) { throw new HttpsError("invalid-argument", "Missing locations to forecast"); } // fetch forecast data for all requested locations const allRequests = request.data.locations.map( async ({latitude, longitude}) => { const forecast = await weatherForecastApi(latitude, longitude); const result = {latitude, longitude, forecast}; // clients that support streaming will have each // forecast streamed to them as they complete if (request.acceptsStreaming) { response.sendChunk(result); } return result; }, ); // Return the full set of data to all clients return Promise.all(allRequests); });
response.sendChunk() işlevinin çalışma şeklinin, istemcinin isteğiyle ilgili belirli ayrıntılara bağlı olduğunu unutmayın:
İstemci akış yanıtı isterse:
response.sendChunk(data)veri parçasını hemen gönderir.İstemci, akış yanıtı istemezse:
response.sendChunk()bu çağrı için herhangi bir işlem yapmaz. Tüm veriler hazır olduğunda yanıtın tamamı gönderilir.
İstemcinin akış yanıtı isteyip istemediğini belirlemek için request.acceptsStreaming özelliğini kontrol edin. Örneğin, request.acceptsStreaming
false ise istemci artımlı bir teslimat beklemediğinden, özellikle tek tek parçaları hazırlama veya göndermeyle ilgili kaynak yoğun işleri atlamaya karar verebilirsiniz.
Canlı sonuçları alma
Tipik bir senaryoda istemci, .stream yöntemiyle akış isteğinde bulunur ve ardından sonuçları iterasyonla işler:
Swift
func listenToWeatherForecast() async throws {
isLoading = true
defer { isLoading = false }
Functions
.functions(region: "us-central1")
let getForecast: Callable<WeatherRequest, StreamResponse<WeatherResponse, [WeatherResponse]>> = Functions.functions().httpsCallable("getForecast")
let request = WeatherRequest(locations: locations)
let stream = try getForecast.stream(request)
for try await response in stream {
switch response {
case .message(let singleResponse):
weatherData["\(singleResponse.latitude),\(singleResponse.longitude)"] = singleResponse
case .result(let arrayOfResponses):
for response in arrayOfResponses {
weatherData["\(response.latitude),\(response.longitude)"] = response
}
print("Stream ended.")
return
}
}
}
Web
// Get the callable by passing an initialized functions SDK.
const getForecast = httpsCallable(functions, "getForecast");
// Call the function with the `.stream()` method to start streaming.
const { stream, data } = await getForecast.stream({
locations: favoriteLocations,
});
// The `stream` async iterable returned by `.stream()`
// will yield a new value every time the callable
// function calls `sendChunk()`.
for await (const forecastDataChunk of stream) {
// update the UI every time a new chunk is received
// from the callable function
updateUi(forecastDataChunk);
}
// The `data` promise resolves when the callable
// function completes.
const allWeatherForecasts = await data;
finalizeUi(allWeatherForecasts);
stream eşzamansız yinelenebilir öğesini gösterildiği gibi döngüye alın. data vaadinin beklenmesi, istemciye isteğin tamamlandığını gösterir.
Kotlin
// Get the callable by passing an initialized functions SDK.
val getForecast = functions.getHttpsCallable("getForecast");
// Call the function with the `.stream()` method and convert it to a flow
getForecast.stream(
mapOf("locations" to favoriteLocations)
).asFlow().collect { response ->
when (response) {
is StreamResponse.Message -> {
// The flow will emit a [StreamResponse.Message] value every time the
// callable function calls `sendChunk()`.
val forecastDataChunk = response.message.data as Map<String, Any>
// Update the UI every time a new chunk is received
// from the callable function
updateUI(
forecastDataChunk["latitude"] as Double,
forecastDataChunk["longitude"] as Double,
forecastDataChunk["forecast"] as Double,
)
}
is StreamResponse.Result -> {
// The flow will emit a [StreamResponse.Result] value when the
// callable function completes.
val allWeatherForecasts = response.result.data as List<Map<String, Any>>
finalizeUI(allWeatherForecasts)
}
}
}
asFlow() uzantı işlevini kullanmak için org.jetbrains.kotlinx:kotlinx-coroutines-reactive kitaplığını uygulamanın build.gradle(.kts) dosyasına bağımlılık olarak ekleyin.
Java
// Get the callable by passing an initialized functions SDK.
HttpsCallableReference getForecast = mFunctions.getHttpsCallable("getForecast");
getForecast.stream(
new HashMap<String, Object>() {{
put("locations", favoriteLocations);
}}
).subscribe(new Subscriber<StreamResponse>() {
@Override
public void onSubscribe(Subscription subscription) {
subscription.request(Long.MAX_VALUE);
}
@Override
public void onNext(StreamResponse streamResponse) {
if (streamResponse instanceof StreamResponse.Message) {
// The flow will emit a [StreamResponse.Message] value every time the
// callable function calls `sendChunk()`.
StreamResponse.Message response = (StreamResponse.Message) streamResponse;
Map<String, Object> forecastDataChunk =
(Map<String, Object>) response.getMessage().getData();
// Update the UI every time a new chunk is received
// from the callable function
updateUI(
(double) forecastDataChunk.get("latitude"),
(double) forecastDataChunk.get("longitude"),
(double) forecastDataChunk.get("forecast")
);
} else if(streamResponse instanceof StreamResponse.Result) {
// The flow will emit a [StreamResponse.Result] value when the
// callable function completes.
StreamResponse.Result response = (StreamResponse.Result) streamResponse;
List<Map<String, Object>> allWeatherForecasts =
(List<Map<String, Object>>) response.getResult().getData();
finalizeUI();
}
}
@Override
public void onError(Throwable throwable) {
// an error occurred in the function
}
@Override
public void onComplete() {
}
});
CORS'yi (merkezler arası kaynak paylaşımı) yapılandırma
İşlevinize hangi kaynakların erişebileceğini kontrol etmek için cors seçeneğini kullanın.
Varsayılan olarak, çağrılabilir işlevlerde CORS, tüm kaynaklardan gelen isteklere izin verecek şekilde yapılandırılır. Tüm çapraz kaynak isteklerine değil de yalnızca bazılarına izin vermek için izin verilmesi gereken belirli alan adlarının veya normal ifadelerin listesini iletin. Örneğin:
Node.js
const { onCall } = require("firebase-functions/v2/https");
exports.getGreeting = onCall(
{ cors: [/firebase\.com$/, "https://flutter.com"] },
(request) => {
return "Hello, world!";
}
);
Python
from firebase_functions import https_fn, options
@https_fn.on_call(
cors=options.CorsOptions(
cors_origins=[r"firebase\.com$", r"https://flutter\.com"],
cors_methods=["get", "post"],
)
)
def say_hello(req: https_fn.CallableRequest) -> Any:
return "Hello world!"
Dart (deneysel)
import 'package:firebase_functions/firebase_functions.dart';
void main(List<String> args) {
fireUp(args, (firebase) {
firebase.https.onCall(
name: 'getGreeting',
options: CallableOptions(
cors: Cors([RegExp(r'^https:\/\/firebase\.com$'), 'https://flutter.com']),
),
(request) async {
return CallableResult('Hello, world!');
},
);
});
}
Çapraz kaynak isteklerini yasaklamak için cors politikasını false olarak ayarlayın.
Hataları işleme
İstemcinin faydalı hata ayrıntıları almasını sağlamak için functions.https.HttpsError veya https_fn.HttpsError örneği oluşturarak (veya Node.js için reddedilen bir Promise döndürerek) çağrılabilir bir işlevden hata döndürün.
Hatanın, gRPC durum kodlarında listelenen değerlerden biri olabilen 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 HTTPS hatası 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:
Node.js
// 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.");
}
Python
# Checking attribute.
if not isinstance(text, str) or len(text) < 1:
# Throwing an HttpsError so that the client gets the error details.
raise https_fn.HttpsError(
code=https_fn.FunctionsErrorCode.INVALID_ARGUMENT,
message=(
'The function must be called with one argument, "text",'
" containing the message text to add."
),
)
# Checking that the user is authenticated.
if req.auth is None:
# Throwing an HttpsError so that the client gets the error details.
raise https_fn.HttpsError(
code=https_fn.FunctionsErrorCode.FAILED_PRECONDITION,
message="The function must be called while authenticated.",
)
Dart (deneysel)
// Checking that attributes are present and are numbers.
if (firstNumber is! num || secondNumber is! num) {
// Throwing an HttpsError so that the client gets the error details.
throw InvalidArgumentError(
'The function must be called with two arguments "firstNumber" and "secondNumber" which must both be numbers.',
);
}
Ç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);
Android
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") }
İ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
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();
İş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.