Pakiety SDK klienta Cloud Functions dla Firebase umożliwiają wywoływanie funkcji bezpośrednio z i aplikacja Firebase. Aby wywołać funkcję z aplikacji w ten sposób, wpisz i wdróż funkcję funkcję wywoływaną przez HTTP w Cloud Functions; a potem dodaj logikę klienta, aby wywoływać tę funkcję z poziomu aplikacji.
Pamiętaj, że funkcje wywoływania przez HTTP są podobne, ale inną niż w przypadku funkcji HTTP. Aby używać funkcji wywoływanych przez HTTP, użyj pakietu SDK klienta na swojej platformie razem z API backendu (lub zaimplementuj protokół). Połączenia telefoniczne mają te klucze różnica w stosunku do funkcji HTTP:
- W przypadku elementów wywoływanych tokeny uwierzytelniania Firebase, tokeny FCM i tokeny Sprawdzania aplikacji (jeśli są dostępne) są automatycznie uwzględniane w żądaniach.
- Aktywator automatycznie zmienia treść żądania i weryfikuje tokeny uwierzytelniania.
Pakiet SDK Firebase dla Cloud Functions (2 generacji lub wyższej) współpracuje z tym klientem Firebase Minimalne wersje pakietu SDK obsługujące funkcje wywoływane przez HTTPS:
- Pakiet SDK Firebase dla platform Apple 10.29.0
- Pakiet SDK Firebase na Androida 21.0.0
- Modułowy pakiet SDK Firebase w wersji 9.7.0
Jeśli chcesz dodać podobne funkcje do aplikacji opartej na nieobsługiwanej
więcej informacji można znaleźć w specyfikacji protokołu dla: https.onCall
. W pozostałej części tego przewodnika znajdziesz informacje na temat
instrukcje dotyczące pisania, wdrażania i wywoływania
funkcję wywoływaną przez HTTP na platformach Apple, urządzeniach z Androidem, w internecie, w C++ i Unity.
Tworzenie i wdrażanie funkcji wywoływanej
Przykładowe kody w tej sekcji opierają się na pełnym krótki przewodnik – przykład który pokazuje, jak wysyłać żądania do funkcji po stronie serwera i pobierać przy użyciu 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 modułu obsługi żądań na swojej platformie (functions.https.onCall
)
lub on_call
)
, by utworzyć wywoływaną funkcję 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 przekazywane z aplikacji klienckiej, a także dodatkowy kontekst, taki jak stan uwierzytelniania. W przypadku funkcji wywoływanej, która zapisuje wiadomość tekstową w bazie danych czasu rzeczywistego,
Na przykład data
może zawierać tekst wiadomości wraz z informacjami uwierzytelniającymi
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ą funkcji, którą można wywołać, a lokalizacją może powodować opóźnienia w sieci. Aby zoptymalizować skuteczność: możesz podać lokalizację funkcji, gdzie i upewnij się, że lokalizacja dzwoniącego jest zgodna z lokalizacją, ustawiana podczas inicjowania pakietu SDK po stronie klienta.
Opcjonalnie możesz dołączyć atest Sprawdzania aplikacji, aby lepiej chronić zasobów backendu przed nadużyciami takimi jak oszustwo związane z płatnościami czy wyłudzanie informacji. Zobacz Włącz wymuszanie Sprawdzania aplikacji w Cloud Functions.
Odbieram wynik
Aby wysłać dane z powrotem do klienta, zwróć dane, które można zakodować w formacie JSON. Dla: 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ładowego tekstu wiadomości jest zwracany zarówno do klienta, jak i do bazy danych czasu rzeczywistego. W Node.js można to zrobić asynchronicznie przy użyciu 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}
Skonfiguruj CORS (współdzielenie zasobów pomiędzy serwerami z różnych domen)
Aby określić, które źródła mają dostęp do Twojej funkcji, użyj opcji cors
.
Domyślnie funkcje możliwe do wywołania mają skonfigurowane CORS tak, aby zezwalać na żądania ze wszystkich źródeł. Aby zezwolić na niektóre żądania z innych domen, ale nie wszystkie, przekaż listę określone domeny lub wyrażenia regularne, 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ć wysyłania żądań z innych domen, ustaw zasadę cors
na false
.
Obsługa błędów
Aby klient otrzymał przydatne szczegóły błędu, zwróć błędy z funkcji wywoływanej
przez zgłoszenie (lub w przypadku Node.js zwrócenia obietnicy odrzuconej z) wystąpieniem
functions.https.HttpsError
lub https_fn.HttpsError
.
Błąd ma atrybut code
, który może być jedną z wartości wymienionych w gRPC
Kody stanu.
Błędy zawierają też domyślny ciąg znaków message
.
na pusty ciąg znaków. Mogą też mieć opcjonalne pole details
z parametrem
dowolną wartość. Jeśli z funkcji zostanie zgłoszony błąd inny niż błąd HTTPS,
Twój klient otrzyma błąd z komunikatem INTERNAL
i kodem
internal
Na przykład funkcja może generować błędy sprawdzania poprawności danych i uwierzytelniania z komunikatami o błędach w celu zwrócenia do klienta wywołującego:
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 funkcji wywoływanej
Gdy zapiszesz zakończoną funkcję wywoływaną w elemencie index.js
,
jest wdrażany razem ze wszystkimi innymi funkcjami po uruchomieniu firebase deploy
.
Aby wdrożyć tylko obiekt możliwy do wywołania, użyj argumentu --only
zgodnie z przedstawionym przykładem
wdrożenia częściowe:
firebase deploy --only functions:addMessage
Jeśli podczas wdrażania funkcji wystąpią błędy uprawnień, upewnij się, odpowiednie role uprawnień są przypisaną do użytkownika wykonującego polecenia wdrożeniowe.
Konfigurowanie środowiska programistycznego klienta
Sprawdź, czy spełniasz wymagania wstępne, a następnie dodaj wymagane zależności bibliotek klienta do aplikacji.
iOS+
Wykonaj instrukcje dodawania Firebase do aplikacji Apple.
Użyj menedżera pakietów Swift, aby zainstalować zależności Firebase i nimi zarządzać.
- W Xcode po otwarciu projektu aplikacji przejdź do File > Dodaj pakiety.
- Gdy pojawi się prośba, dodaj repozytorium SDK platform Apple Platform SDK Firebase:
- Wybierz bibliotekę Cloud Functions.
- Dodaj flagę
-ObjC
do sekcji Inne flagi łączące w ustawieniach kompilacji celu. - Po zakończeniu Xcode automatycznie rozpocznie rozpoznawanie i pobieranie lub zależności w tle.
https://github.com/firebase/firebase-ios-sdk.git
Web
- Postępuj zgodnie z instrukcjami, aby:
dodaj Firebase do swojej aplikacji internetowej. Pamiętaj o uruchomieniu
następujące polecenie z terminala:
npm install firebase@10.12.4 --save
Ręcznie wymagają zarówno podstawowych funkcji Firebase, jak i 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
Postępuj zgodnie z instrukcjami, aby: dodaj Firebase do swojej aplikacji na Androida.
w pliku Gradle (na poziomie aplikacji) modułu, (zwykle
<project>/<app-module>/build.gradle.kts
lub<project>/<app-module>/build.gradle
), dodaj zależność z biblioteką Cloud Functions na Androida. Zalecamy użycie metody Funkcja BoM Firebase na Androida aby kontrolować obsługę wersji biblioteki.dependencies { // 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") }
Korzystając z BM Firebase Android BoM, Twoja aplikacja zawsze używa zgodnych wersji bibliotek Firebase na Androida.
(Wersja alternatywna) Dodawanie zależności biblioteki Firebase bez korzystania z BM
Jeśli nie chcesz używać Firebase BoM, musisz określić każdą wersję biblioteki Firebase w wierszu zależności.
Pamiętaj, że jeśli używasz wielu bibliotek Firebase w swojej aplikacji, zalecamy korzystanie z BoM do zarządzania wersjami biblioteki, dzięki czemu wszystkie wersje
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") }
Zainicjuj pakiet SDK klienta
Zainicjuj instancję 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łaj funkcję
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 otrzymuje błąd, jeśli serwer zwrócił błąd lub obiecane wyniki zostały odrzucone.
Jeśli błąd zwrócony przez funkcję jest typu function.https.HttpsError
,
wtedy klient otrzyma błąd code
, message
i details
z
wystąpił błąd serwera. W przeciwnym razie błąd będzie zawierał komunikat INTERNAL
oraz
kod INTERNAL
. Zapoznaj się ze wskazówkami
błędów obsługi w funkcji możliwej do wywołania.
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 dzięki Sprawdzaniu aplikacji
Zanim opublikujesz aplikację, włącz Sprawdzanie aplikacji. aby mieć pewność, że tylko aplikacje będą miały dostęp do punktów końcowych funkcji, które można wywołać.