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 của bạn theo cách này, hãy viết và triển khai một hàm HTTP có thể gọi trong Cloud Functions, sau đó thêm logic ứng dụng để gọi hàm từ ứng dụng của bạn.
Bạn cần lưu ý rằng các hàm có thể gọi qua 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 qua 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). Hàm có thể gọi có những điểm khác biệt chính sau đây so với hàm HTTP:
- Với các hàm 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 tự động giải 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ệ thứ 2 trở lên tương thích với các phiên bản SDK ứng dụng Firebase tối thiểu sau đây để hỗ trợ các hàm có thể gọi qua HTTPS:
- SDK Firebase cho nền tảng Apple 13.0.0
- SDK Firebase cho Android 23.0.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 một nền tảng không được hỗ trợ, hãy xem Thông số kỹ thuật của 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 một hàm có thể gọi HTTP cho các nền tảng của Apple, Android, web, C++ và Unity.
Viết và triển khai hàm có thể gọi
Sử dụng functions.https.onCall để tạo một hàm có thể gọi qua HTTPS. Phương thức này
có hai tham số: data và context (không bắt buộc):
// Saves a message to the Firebase Realtime Database but sanitizes the // text by removing swearwords. exports.addMessage = functions.https.onCall((data, context) => { // ... });
Ví dụ: đối với một hàm có thể gọi để lưu tin nhắn văn bản vào Realtime Database, data có thể chứa văn bản tin nhắn, trong khi các tham số context đại diện cho thông tin xác thực người dùng:
// 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;
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 việc chỉ định vị trí hàm nếu có thể và đảm bảo điều chỉnh vị trí của hàm có thể gọi cho phù hợp với vị trí được đặt khi bạn khởi chạy SDK ở phía máy khách.
Nếu muốn, bạn có thể đính kèm một chứng thực App Check để giúp bảo vệ tài nguyên phụ trợ của bạn khỏi hành vi sai trái, chẳng hạn như lừa đảo qua giao dịch thanh toán hoặc lừa đảo. Xem phần Bật chế độ thực thi App Check cho Cloud Functions.
Đang gửi lại kết quả
Để gửi dữ liệu trở lại ứng dụng, hãy trả về dữ liệu có thể được mã hoá JSON. Ví dụ: để trả về kết quả của phép cộng:
// returning result.
return {
firstNumber: firstNumber,
secondNumber: secondNumber,
operator: "+",
operationResult: firstNumber + secondNumber,
};
Để trả về dữ liệu sau một thao tác không đồng bộ, hãy trả về một lời hứa. Dữ liệu do lời hứa trả về sẽ được gửi lại cho ứng dụng. Ví dụ: bạn có thể trả về văn bản đã dọn dẹp mà hàm có thể gọi đã ghi vào Realtime Database:
// 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};
})
Xử lý lỗi
Để đảm bảo ứng dụng khách nhận được thông tin chi tiết hữu ích về lỗi, hãy trả về lỗi từ một hàm có thể gọi bằng cách gửi (hoặc trả về một Lời hứa bị từ chối bằng) một thực thể của functions.https.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ê tại functions.https.HttpsError.
Lỗi cũng có một chuỗi message, mặc định là một chuỗi trống. Các sự kiện này cũng có thể có một trường details không bắt buộc với một giá trị tuỳ ý. Nếu một lỗi không phải HttpsError đượ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 kèm theo thông báo INTERNAL và mã internal.
Ví dụ: một hàm có thể gửi lỗi xác thực dữ liệu và lỗi xác thực kèm theo thông báo lỗi để trả về cho ứng dụng gọi:
// 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.");
}
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 đó 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 hàm 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 lệnh triển khai.
Thiết lập môi trường phát triển ứng dụng khách
Đả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 và thư viện ứng dụng cần thiết vào ứng dụng của bạn.
iOS+
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 của Firebase.
- Trong Xcode, khi dự án ứng dụng của bạn đ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 Firebase cho nền tảng của Apple:
- 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 chế độ 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 của bạn 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 của bạn. Hãy nhớ chạy lệnh sau từ thiết bị đầu cuối:
npm install firebase@13.0.0 --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);
Web
- Làm theo hướng dẫn để thêm Firebase vào ứng dụng web của bạn.
- Thêm thư viện ứng dụng Cloud Functions và Firebase Core vào ứng dụng của bạn:
<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>
SDK Cloud Functions cũng được cung cấp dưới dạng gói npm.
- Chạy lệnh sau trong dòng lệnh:
npm install firebase@8.10.1 --save
- Yêu cầu cả Firebase Core và Cloud Functions theo cách thủ công:
const firebase = require("firebase"); // Required for side-effects require("firebase/functions");
Kotlin
Làm theo hướng dẫn để thêm Firebase vào ứng dụng Android của bạn.
Trong tệp Gradle (ở cấp ứng dụng) trong 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: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") }
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.
(Cách khác) 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 phiên bản đó.
Xin lưu ý rằng nếu bạn 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 rằng 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:23.0.0") }
Java
Làm theo hướng dẫn để thêm Firebase vào ứng dụng Android của bạn.
Trong tệp Gradle (ở cấp ứng dụng) trong 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: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") }
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.
(Cách khác) 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 phiên bản đó.
Xin lưu ý rằng nếu bạn 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 rằng 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:23.0.0") }
Dart
Làm theo hướng dẫn để thêm Firebase vào ứng dụng Flutter.
Từ thư mục gốc của dự án Flutter, hãy chạy lệnh sau để cài đặt trình bổ trợ:
flutter pub add cloud_functionsSau khi hoàn tất, hãy tạo lại ứng dụng Flutter:
flutter runSau khi cài đặt, bạn có thể truy cập vào trình bổ trợ
cloud_functionsbằng cách nhập trình bổ trợ đó vào mã Dart:import 'package:cloud_functions/cloud_functions.dart';
C++
Đối với C++ với Android:
- Làm theo hướng dẫn để thêm Firebase vào dự án C++ của bạn.
- Thêm thư viện
firebase_functionsvào tệpCMakeLists.txt.
Đối với C++ với nền tảng của Apple:
- Làm theo hướng dẫn để thêm Firebase vào dự án C++ của bạn.
- Thêm pod Cloud Functions vào
Podfile:pod 'Firebase/Functions'
- Lưu tệp, sau đó chạy:
pod install
- Thêm khung Firebase Core và Cloud Functions từ Firebase C++ SDK vào dự án Xcode của bạn.
firebase.frameworkfirebase_functions.framework
Unity
- Làm theo hướng dẫn để thêm Firebase vào dự án Unity của bạn.
- Thêm
FirebaseFunctions.unitypackagetừ Firebase Unity SDK vào dự án Unity của bạn.
Khởi chạy SDK ứng dụng
Khởi động 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
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
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;
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
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 khách
Ứ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 sẽ nhận được lỗi code, message và details từ lỗi phía máy chủ. Nếu không, lỗi sẽ chứa thông báo INTERNAL và mã INTERNAL. 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
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;
}
});
Đặt thời gian chờ của ứng dụng khách
Theo mặc định, SDK ứng dụng Cloud Functions sử dụng thời gian chờ 70 giây cho các yêu cầu có thể gọi. Nếu một hàm có thể gọi mất hơn 70 giây để hoàn tất, thì SDK ứng dụng sẽ chấm dứt yêu cầu kèm theo lỗi DEADLINE_EXCEEDED (deadline-exceeded), ngay cả khi bạn đã định cấu hình thời gian chờ phía máy chủ dài hơn.
Để hỗ trợ các hàm có thể gọi chạy trong thời gian dài, bạn phải tăng thời gian chờ trên cả máy chủ và máy khách:
- Tăng thời gian chờ của hàm phía máy chủ (xem phần Đặt thời gian chờ và phân bổ bộ nhớ).
- Tăng thời gian chờ phía máy khách khi định cấu hình tham chiếu có thể gọi trong ứng dụng:
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,
});
Nên dùng: 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.