Pakiety SDK klienta Cloud Functions for Firebase umożliwiają wywoływanie funkcji bezpośrednio z aplikacji Firebase. Aby wywołać funkcję z aplikacji w ten sposób, napisz i wdróż funkcję wywoływaną przez HTTP w pakiecie Cloud Functions, a potem dodaj logikę klienta, aby wywołać funkcję z aplikacji.
Pamiętaj, że funkcje wywoływane przez HTTP są podobne do funkcji HTTP, ale nie identyczne. Aby używać wywoływalnych funkcji HTTP, musisz użyć pakietu SDK klienta dla swojej platformy wraz z interfejsem API zaplecza (lub zaimplementować protokół). Funkcje callable różnią się od funkcji HTTP w następujący sposób:
- W przypadku funkcji wywoływalnych tokeny Firebase Authentication, FCM i App Check (jeśli są dostępne) są automatycznie uwzględniane w żądaniach.
- Wyzwalacz automatycznie deserializuje treść żądania i weryfikuje tokeny uwierzytelniania.
Pakiet SDK Firebase dla Cloud Functions drugiej generacji lub nowszej współpracuje z tymi wersjami pakietu SDK klienta Firebase:
- Firebase Pakiet SDK dla platform Apple (wersja 11.5.0)
- Pakiet SDK Firebase dla Android 21.1.0
- Pakiet Firebase Modular Web SDK w wersji 9.7.0
Jeśli chcesz dodać podobne funkcje do aplikacji utworzonej na nieobsługiwanej platformie, zapoznaj się ze specyfikacją protokołu https.onCall. W dalszej części tego przewodnika znajdziesz instrukcje tworzenia, wdrażania i wywoływania funkcji wywoływanej przez HTTP na platformach Apple, Android, web, C++, Unity i w języku C++.
napisać i wdrażać funkcję wywołującą,
Przykłady kodu w tej sekcji są oparte na kompletnym przykładzie wprowadzenia, który pokazuje, jak wysyłać żądania do funkcji po stronie serwera i otrzymywać odpowiedzi za pomocą jednego z pakietów SDK klienta. Aby rozpocząć, zaimportuj wymagane moduły:
Node.js
// Dependencies for callable functions.
const {onCall, HttpsError} = require("firebase-functions/v2/https");
const {logger} = require("firebase-functions/v2");
// 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
Użyj elementu request handler na swojej platformie (functions.https.onCall lub on_call), aby utworzyć funkcję wywoływaną przez HTTPS. Ta metoda przyjmuje parametr żądania:
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."""
Parametr request zawiera dane przekazane z aplikacji klienckiej oraz dodatkowy kontekst, np. stan uwierzytelniania. W przypadku funkcji wywoływalnej, która zapisuje wiadomość tekstową do Realtime Database, data może zawierać tekst wiadomości wraz z informacjami uwierzytelniania w auth:
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", "")
Odległość między lokalizacją wywoływanej funkcji a lokalizacją wywołującego klienta może powodować opóźnienia sieciowe. Aby zoptymalizować wydajność, rozważ określenie lokalizacji funkcji, gdy jest to konieczne. Pamiętaj, aby dopasować lokalizację funkcji do lokalizacji określonej podczas inicjowania pakietu SDK po stronie klienta.
Opcjonalnie możesz załączyć zaświadczenie App Check, aby chronić zasoby backendu przed nadużyciami, takimi jak oszustwa związane z płatnościami czy wyłudzanie informacji. Zobacz Włączanie wymuszania App Check w przypadku Cloud Functions.
Wysyłanie wyniku
Aby wysłać dane z powrotem do klienta, zwracaj dane, które można zakodować w formacie JSON. Na przykład, aby zwrócić wynik operacji dodawania:
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
}
Oczyszczony tekst z przykładu tekstu wiadomości jest zwracany zarówno do klienta, jak i do Realtime Database. W Node.js można to zrobić asynchronicznie za pomocą obietnicy JavaScript:
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}
Konfigurowanie CORS (współdzielenie zasobów pomiędzy serwerami z różnych domen)
Użyj opcji cors, aby określić, które źródła mogą uzyskiwać dostęp do funkcji.
Domyślnie funkcje wywoływane mają skonfigurowaną zasadę CORS, która zezwala na żądania ze wszystkich źródeł. Aby zezwolić na niektóre żądania między domenami, ale nie na wszystkie, prześlij listę konkretnych domen lub wyrażeń regularnych, które powinny być dozwolone. Przykład:
Node.js
const { onCall } = require("firebase-functions/v2/https");
exports.getGreeting = onCall(
{ cors: [/firebase\.com$/, "https://flutter.com"] },
(request) => {
return "Hello, world!";
}
);
Aby zabronić żądań między domenami, ustaw zasadę cors na false.
Obsługa błędów
Aby zapewnić klientowi przydatne informacje o błędach, zwracaj błędy z funkcji wywoływalnej, rzucając instancją functions.https.HttpsError lub https_fn.HttpsError (w przypadku Node.js zwracającą obietnicę odrzuconą za pomocą).
Błąd ma atrybut code, który może być jedną z wartości wymienionych w gRPC Kodach stanu.
Błędy zawierają też ciąg message, który domyślnie jest pusty. Może ono też zawierać opcjonalne pole details z dowolną wartością. Jeśli z Twoich funkcji zostanie wyrzucony błąd inny niż HTTPS, Twój klient otrzyma zamiast tego błąd z komunikatem INTERNAL i kodem internal.
Funkcja może na przykład zwracać błędy weryfikacji danych i uwierzytelniania, przekazując klientowi wywołującemu komunikaty o błędach:
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.")
Wdrażanie wywoływanej funkcji
Po zapisaniu w funkcji index.js gotowej funkcji wywoływalnej zostanie ona wdrożona wraz z wszystkimi innymi funkcjami podczas wykonywania funkcji firebase deploy.
Aby wdrożyć tylko funkcję wywoływaną, użyj argumentu --only, jak pokazano poniżej, aby wykonać częściowe wdrożenie:
firebase deploy --only functions:addMessage
Jeśli podczas wdrażania funkcji wystąpią błędy uprawnień, sprawdź, czy użytkownik uruchamiający polecenia wdrażania ma przypisane odpowiednie role uprawnień.
Konfigurowanie środowiska programistycznego klienta
Sprawdź, czy spełniasz wymagania wstępne, a potem dodaj do aplikacji wymagane zależności i biblioteki klienta.
iOS+
Postępuj zgodnie z instrukcjami, aby dodać Firebase do aplikacji Apple.
Do instalacji zależności Firebase i zarządzania nimi możesz używać menedżera pakietów Swift.
- Po otwarciu projektu aplikacji w Xcode wybierz Plik > Dodaj pakiety.
- Gdy pojawi się prośba, dodaj repozytorium pakietu SDK Firebase na platformy Apple:
- Wybierz bibliotekę Cloud Functions.
- Dodaj flagę
-ObjCdo sekcji Inne flagi linkera w ustawieniach kompilacji docelowej. - Gdy to zrobisz, Xcode automatycznie zacznie wyszukiwać i pobierać zależności w tle.
https://github.com/firebase/firebase-ios-sdk.git
Web
- Postępuj zgodnie z instrukcjami, aby dodać Firebase do aplikacji internetowej. W terminalu uruchom to polecenie:
npm install firebase@11.0.2 --save
Ręcznie wymagaj zarówno podstawowej usługi Firebase, jak i usługi Cloud Functions:
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
Wykonaj instrukcje, aby dodać Firebase do aplikacji na Androida.
W pliku Gradle modułu (na poziomie aplikacji) (zwykle
<project>/<app-module>/build.gradle.ktslub<project>/<app-module>/build.gradle) dodaj zależność z biblioteką Cloud Functions na Androida. Zalecamy używanie Firebase Android BoM do kontrolowania wersji biblioteki.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") }Dzięki użyciu Firebase Android BoMaplikacja zawsze będzie używać zgodnych wersji bibliotek Firebase na Androida.
(Alternatywnie) Dodaj zależności biblioteki Firebase bez używania pakietu BoM
Jeśli zdecydujesz się nie używać Firebase BoM, musisz określić każdą wersję biblioteki Firebase w jej wierszu zależności.
Jeśli w aplikacji używasz kilku bibliotek Firebase, zdecydowanie zalecamy korzystanie z BoM do zarządzania wersjami bibliotek. Dzięki temu wszystkie wersje będą ze sobą zgodne.
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") }
Inicjowanie pakietu SDK klienta
Inicjalizacja instancji Cloud Functions:
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+KTX
private lateinit var functions: FirebaseFunctions // ... functions = Firebase.functions
Java
private FirebaseFunctions mFunctions; // ... mFunctions = FirebaseFunctions.getInstance();
Wywołanie funkcji
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;
});
}
Obsługa błędów po stronie klienta
Klient otrzyma błąd, jeśli serwer wyrzucił błąd lub jeśli powstała obietnica została odrzucona.
Jeśli błąd zwrócony przez funkcję jest typu function.https.HttpsError, klient otrzymuje błąd code, message i details z błędu serwera. W przeciwnym razie błąd zawiera komunikat INTERNAL i kod INTERNAL. Zapoznaj się ze wskazówkami dotyczącymi obsługi błędów w funkcji wywoływanej.
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;
}
});
Zalecane: zapobieganie nadużyciom za pomocą funkcji App Check
Zanim uruchomisz aplikację, włącz App Check, aby mieć pewność, że tylko Twoje aplikacje będą miały dostęp do punktów końcowych funkcji wywoływalnych.