SDK ứng dụng Cloud Functions for Firebase cho phép bạn gọi các hàm trực tiếp từ một ứng dụng Firebase. Để gọi một hàm từ ứng dụng theo cách này, hãy viết và triển khai một hàm Có thể gọi HTTP trong Cloud Functions, sau đó thêm logic ứng dụng để gọi hàm đó từ ứng dụng.
Điều quan trọng cần lưu ý là các hàm có thể gọi HTTP tương tự nhưng không giống với các hàm HTTP. Để sử dụng các hàm có thể gọi HTTP, bạn phải sử dụng SDK ứng dụng cho nền tảng của mình cùng với API phụ trợ (hoặc triển khai giao thức). Các hàm có thể gọi có những điểm khác biệt chính sau đây so với các hàm HTTP:
- Với các đối tượng có thể gọi, mã thông báo Firebase Authentication, mã thông báo FCM và mã thông báo App Check (nếu có) sẽ tự động được đưa vào các yêu cầu.
- Trình kích hoạt sẽ tự động huỷ tuần tự hoá nội dung yêu cầu và xác thực mã thông báo xác thực.
SDK Firebase cho Cloud Functions thế hệ 2 trở lên tương tác với các phiên bản SDK tối thiểu của ứng dụng Firebase sau đây để hỗ trợ các hàm Có thể gọi qua HTTPS:
- SDK Firebase cho nền tảng Apple 11.5.0
- SDK Firebase cho Android 21.1.0
- Firebase Modular Web SDK phiên bản 9.7.0
Nếu bạn muốn thêm chức năng tương tự vào một ứng dụng được xây dựng trên nền tảng không được hỗ trợ, hãy xem Thông số kỹ thuật giao thức cho https.onCall. Phần còn lại của hướng dẫn này cung cấp hướng dẫn về cách viết, triển khai và gọi hàm có thể gọi HTTP cho các nền tảng Apple, Android, web, C++ và Unity.
Viết và triển khai hàm có thể gọi
Các ví dụ về mã trong phần này dựa trên một mẫu làm quen nhanh hoàn chỉnh minh hoạ cách gửi yêu cầu đến một hàm phía máy chủ và nhận phản hồi bằng một trong các SDK ứng dụng. Để bắt đầu, hãy nhập các mô-đun bắt buộc:
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
Sử dụng trình xử lý yêu cầu cho nền tảng của bạn (functions.https.onCall) hoặc on_call để tạo hàm có thể gọi HTTPS. Phương thức này lấy một tham số yêu cầu:
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."""
Tham số request chứa dữ liệu được truyền từ ứng dụng khách cũng như ngữ cảnh bổ sung như trạng thái xác thực. Đối với một hàm có thể gọi để lưu tin nhắn văn bản vào Realtime Database, ví dụ: data có thể chứa văn bản tin nhắn cùng với thông tin xác thực trong 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", "")
Khoảng cách giữa vị trí của hàm có thể gọi và vị trí của ứng dụng gọi có thể tạo ra độ trễ mạng. Để tối ưu hoá hiệu suất, hãy cân nhắc chỉ định vị trí hàm (function location) khi có thể và đảm bảo căn chỉnh vị trí của hàm có thể gọi với vị trí được đặt khi bạn khởi chạy SDK ở phía máy khách.
Bạn có thể đính kèm chứng thực App Check để bảo vệ các tài nguyên phụ trợ khỏi hành vi sai trái, chẳng hạn như gian lận thanh toán hoặc lừa đảo. Xem nội dung Bật tính năng thực thi App Check cho Cloud Functions.
Gửi lại kết quả
Để gửi dữ liệu trở lại ứng dụng khách, hãy trả về dữ liệu có thể được mã hoá JSON. Ví dụ: để trả về kết quả của một phép cộng:
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
}
Văn bản đã được dọn dẹp từ ví dụ về văn bản tin nhắn được trả về cho cả ứng dụng khách và Realtime Database. Trong Node.js, bạn có thể thực hiện việc này một cách không đồng bộ bằng cách sử dụng lời hứa 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}
Định cấu hình CORS (Chia sẻ tài nguyên trên nhiều nguồn gốc)
Sử dụng tuỳ chọn cors để kiểm soát những nguồn gốc nào có thể truy cập vào hàm của bạn.
Theo mặc định, các hàm có thể gọi được định cấu hình CORS để cho phép các yêu cầu từ mọi nguồn gốc. Để cho phép một số yêu cầu trên nhiều nguồn gốc nhưng không phải tất cả, hãy truyền danh sách các miền hoặc biểu thức chính quy cụ thể cần được cho phép. Ví dụ:
Node.js
const { onCall } = require("firebase-functions/v2/https");
exports.getGreeting = onCall(
{ cors: [/firebase\.com$/, "https://flutter.com"] },
(request) => {
return "Hello, world!";
}
);
Để cấm các yêu cầu trên nhiều nguồn gốc, hãy đặt chính sách cors thành false.
Xử lý lỗi
Để đảm bảo ứng dụng nhận được thông tin chi tiết hữu ích về lỗi, hãy trả về lỗi từ một đối tượng có thể gọi bằng cách gửi (hoặc đối với Node.js trả về một Lời hứa bị từ chối bằng) một thực thể của functions.https.HttpsError hoặc https_fn.HttpsError.
Lỗi này có thuộc tính code có thể là một trong các giá trị được liệt kê trong gRPC
Mã trạng thái.
Các lỗi này cũng có một chuỗi message, mặc định là một chuỗi trống. Các lớp này cũng có thể có một trường details không bắt buộc với giá trị tuỳ ý. Nếu một lỗi khác ngoài lỗi HTTPS được gửi từ các hàm của bạn, thì ứng dụng của bạn sẽ nhận được lỗi với thông báo INTERNAL và mã internal.
Ví dụ: một hàm có thể gửi lỗi xác thực và xác thực dữ liệu cùng với thông báo lỗi để trả về cho ứng dụng gọi:
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.")
Triển khai hàm có thể gọi
Sau khi bạn lưu một hàm có thể gọi đã hoàn tất trong index.js, hàm này sẽ được triển khai cùng với tất cả các hàm khác khi bạn chạy firebase deploy.
Để chỉ triển khai đối tượng có thể gọi, hãy sử dụng đối số --only như minh hoạ để thực hiện triển khai một phần:
firebase deploy --only functions:addMessage
Nếu bạn gặp lỗi về quyền khi triển khai các hàm, hãy đảm bảo rằng vai trò IAM thích hợp được chỉ định cho người dùng chạy các lệnh triển khai.
Thiết lập môi trường phát triển ứng dụng
Đảm bảo bạn đáp ứng mọi điều kiện tiên quyết, sau đó thêm các phần phụ thuộc bắt buộc và thư viện ứng dụng vào ứng dụng của bạn.
iOS trở lên
Làm theo hướng dẫn để thêm Firebase vào ứng dụng Apple.
Sử dụng Trình quản lý gói Swift để cài đặt và quản lý các phần phụ thuộc Firebase.
- Trong Xcode, khi dự án ứng dụng đang mở, hãy chuyển đến File > Add Packages (Tệp > Thêm gói).
- Khi được nhắc, hãy thêm kho lưu trữ SDK của các nền tảng Apple Firebase:
- Chọn thư viện Cloud Functions.
- Thêm cờ
-ObjCvào phần Other Linker Flags (Cờ trình liên kết khác) trong phần cài đặt bản dựng của mục tiêu. - Khi hoàn tất, Xcode sẽ tự động bắt đầu phân giải và tải các phần phụ thuộc xuống ở chế độ nền.
https://github.com/firebase/firebase-ios-sdk.git
Web
- Làm theo hướng dẫn để thêm Firebase vào ứng dụng Web. Hãy nhớ chạy lệnh sau từ dòng lệnh:
npm install firebase@11.0.2 --save
Yêu cầu cả Firebase core và Cloud Functions theo cách thủ công:
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
Làm theo hướng dẫn để thêm Firebase vào ứng dụng Android.
Trong tệp Gradle (ở cấp ứng dụng) của mô-đun (thường là
<project>/<app-module>/build.gradle.ktshoặc<project>/<app-module>/build.gradle), hãy thêm phần phụ thuộc cho thư viện Cloud Functions dành cho Android. Bạn nên sử dụng Firebase Android BoM để kiểm soát việc tạo phiên bản thư viện.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") }Bằng cách sử dụng Firebase Android BoM, ứng dụng của bạn sẽ luôn sử dụng những phiên bản tương thích của thư viện Android trên Firebase.
(Phương án thay thế) Thêm phần phụ thuộc thư viện Firebase mà không sử dụng BoM
Nếu chọn không sử dụng Firebase BoM, bạn phải chỉ định từng phiên bản thư viện Firebase trong dòng phần phụ thuộc của thư viện đó.
Xin lưu ý rằng nếu sử dụng nhiều thư viện Firebase trong ứng dụng, bạn nên sử dụng BoM để quản lý các phiên bản thư viện, nhằm đảm bảo tất cả phiên bản đều tương thích.
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") }
Khởi chạy SDK ứng dụng
Khởi tạo một thực thể của 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();
Gọi hàm
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;
});
}
Xử lý lỗi trên ứng dụng
Ứng dụng sẽ nhận được lỗi nếu máy chủ gửi lỗi hoặc nếu lời hứa kết quả bị từ chối.
Nếu lỗi do hàm trả về thuộc loại function.https.HttpsError, thì ứng dụng khách sẽ nhận được lỗi code, message và details từ lỗi máy chủ. Nếu không, lỗi sẽ chứa thông báo INTERNAL và mã INTERNAL. Hãy xem hướng dẫn về cách xử lý lỗi trong hàm có thể gọi.
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;
}
});
Đề xuất: Ngăn chặn hành vi sai trái bằng App Check
Trước khi chạy ứng dụng, bạn nên bật App Check để đảm bảo rằng chỉ ứng dụng của bạn mới có thể truy cập vào các điểm cuối của hàm có thể gọi.