Chức năng đám mây cho SDK ứng dụng khách Firebase cho phép bạn gọi các chức năng trực tiếp 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 HTTPS Callable trong Cloud Functions, sau đó thêm logic ứng dụng khách để gọi hàm từ ứng dụng của bạn.
Điều quan trọng cần lưu ý là các chức năng có thể gọi HTTPS tương tự nhưng không giống với các chức năng HTTP. Để sử dụng các chức năng có thể gọi HTTPS, bạn phải sử dụng SDK ứng dụng khách cho nền tảng của mình cùng với API phụ trợ functions.https (hoặc triển khai giao thức). Có thể gọi có những điểm khác biệt chính so với các hàm HTTP:
- Với khả năng gọi, mã thông báo Xác thực Firebase, mã thông báo FCM và mã thông báo Kiểm tra ứng dụng, khi có sẵn, sẽ tự động được đưa vào yêu cầu.
- Trình kích hoạt
functions.https.onCalltự động giải mã nội dung yêu cầu và xác thực mã thông báo xác thực.
SDK Firebase cho các chức năng đám mây v0.9.1 và cao hơn tương tác với các phiên bản tối thiểu SDK ứng dụng khách Firebase này để hỗ trợ các chức năng HTTPS Callable:
- SDK Firebase dành cho các nền tảng của Apple 9.2.0
- SDK Firebase dành cho Android 20.1.0
- SDK JavaScript của Firebase 8.10.1
- Firebase Modular Web SDK phiên bản 9.0
Nếu bạn muốn thêm chức năng tương tự vào ứng dụng được xây dựng trên nền tảng không được hỗ trợ, hãy xem Đặc 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 một hàm có thể gọi HTTPS 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
Sử dụng functions.https.onCall để tạo một hàm có thể gọi HTTPS. Phương thức này nhận hai tham số: data và context tùy chọn:
// 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 Cơ sở dữ liệu thời gian thực, data có thể chứa văn bản tin nhắn, trong khi các tham số context biểu thị thông tin xác thực của người dùng:
// Message text passed from the client.
const text = data.text;
// Authentication / user information is automatically added to the request.
const uid = context.auth.uid;
const name = context.auth.token.name || null;
const picture = context.auth.token.picture || null;
const email = context.auth.token.email || null;
Khoảng cách giữa vị trí của chức năng có thể gọi và vị trí của ứng dụng khách đang gọi có thể tạo ra độ trễ mạng. Để tối ưu hóa hiệu suất, hãy xem xét chỉ định vị trí chức năng nếu có thể và đảm bảo điều chỉnh vị trí của có thể gọi với vị trí đã đặt khi bạn khởi chạy SDK ở phía máy khách.
Theo tùy chọn, bạn có thể đính kèm chứng thực Kiểm tra ứng dụng để giúp bảo vệ tài nguyên phụ trợ của bạn khỏi bị lạm dụng, chẳng hạn như gian lận thanh toán hoặc lừa đảo. Xem Bật thực thi Kiểm tra ứng dụng cho Chức năng đám mây .
Gửi lại kết quả
Để gửi dữ liệu trở lại máy khách, hãy trả lại dữ liệu có thể được mã hóa JSON. Ví dụ, để trả về kết quả của một phép toán cộng:
// returning result.
return {
firstNumber: firstNumber,
secondNumber: secondNumber,
operator: '+',
operationResult: firstNumber + secondNumber,
};
Để trả về dữ liệu sau một hoạt động không đồng bộ, hãy trả về một lời hứa. Dữ liệu được trả về bởi lời hứa sẽ được gửi lại cho khách hàng. Ví dụ: bạn có thể trả về văn bản được làm sạch mà hàm có thể gọi đã ghi vào Cơ sở dữ liệu thời gian thực:
// Saving the new message to the Realtime Database.
const sanitizedMessage = sanitizer.sanitizeText(text); // Sanitize the message.
return admin.database().ref('/messages').push({
text: sanitizedMessage,
author: { uid, name, picture, email },
}).then(() => {
console.log('New Message written');
// Returning the sanitized message to the client.
return { text: sanitizedMessage };
})
Xử lý lỗi
Để đảm bảo máy khách nhận được thông tin chi tiết về lỗi hữu ích, hãy trả về lỗi từ một lệnh có thể gọi bằng cách ném (hoặc trả lại Lời hứa bị từ chối với) một phiên bản của functions.https.HttpsError . Lỗi 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 . Các lỗi cũng có một message chuỗi, mặc định là một chuỗi rỗng. Chúng cũng có thể có trường details tùy chọn với giá trị tùy ý. Nếu một lỗi không phải HttpsError được tạo ra từ các chức năng của bạn, thay vào đó, ứng dụng khách 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ể đưa ra các lỗi xác thực và xác thực dữ liệu với các thông báo lỗi để trả về ứng dụng khách đang gọi:
// Checking attribute.
if (!(typeof text === 'string') || text.length === 0) {
// Throwing an HttpsError so that the client gets the error details.
throw new functions.https.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 (!context.auth) {
// Throwing an HttpsError so that the client gets the error details.
throw new functions.https.HttpsError('failed-precondition', 'The function must be called ' +
'while authenticated.');
}
Triển khai chức năng có thể gọi
Sau khi bạn lưu một hàm có thể gọi hoàn chỉnh trong index.js , nó 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 . Để triển khai chỉ có thể gọi, hãy sử dụng đối số --only như được hiển thị để thực hiện triển khai từng phần :
firebase deploy --only functions:addMessage
Nếu bạn gặp lỗi quyền khi triển khai các chức năng, hãy đảm bảo rằng các vai trò IAM thích hợp được gán cho người dùng đang chạy các lệnh triển khai.
Thiết lập môi trường phát triển khách hàng của bạn
Đảm bảo rằng bạn đáp ứng bất kỳ điều kiện tiên quyết nào, sau đó thêm các phụ thuộc bắt buộc và thư viện ứng dụng khách 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 của bạn .
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 điều hướng đến Tệp> Thêm gói .
- Khi được nhắc, hãy thêm kho lưu trữ SDK nền tảng Apple Firebase:
- Chọn thư viện Chức năng đám mây.
- Khi hoàn tất, Xcode sẽ tự động bắt đầu giải quyết và tải xuống các phần phụ thuộc của bạn trong nền.
https://github.com/firebase/firebase-ios-sdk
Web version 9
- Làm theo hướng dẫn để thêm Firebase vào ứng dụng Web của bạn . Đảm bảo chạy lệnh sau từ thiết bị đầu cuối của bạn:
npm install firebase@9.8.4 --save
Yêu cầu thủ công cả lõi Firebase và Chức năng đám mây:
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 version 8
- Làm theo hướng dẫn để thêm Firebase vào ứng dụng Web của bạn .
- Thêm lõi Firebase và thư viện máy khách Chức năng đám mây 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 chức năng đám mây cũng có sẵn dưới dạng gói npm.
- Chạy lệnh sau từ thiết bị đầu cuối của bạn:
npm install firebase@8.10.1 --save
- Yêu cầu thủ công cả lõi Firebase và Chức năng đám mây:
const firebase = require("firebase"); // Required for side-effects require("firebase/functions");
Java
Làm theo hướng dẫn để thêm Firebase vào ứng dụng Android của bạn .
Sử dụng Firebase Android BoM , khai báo sự phụ thuộc cho thư viện Cloud Functions Android trong tệp Gradle mô-đun (cấp ứng dụng) của bạn (thường là
app/build.gradle).dependencies { // Import the BoM for the Firebase platform implementation platform('com.google.firebase:firebase-bom:30.2.0') // Declare 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 các phiên bản tương thích của thư viện Firebase Android.
(Thay thế) Khai báo các phụ thuộc thư viện Firebase mà không cần sử dụng BoM
Nếu bạn 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ụ thuộc của nó.
Lưu ý rằng nếu bạn sử dụng nhiều thư viện Firebase trong ứng dụng của mình, chúng tôi thực sự khuyên bạn nên sử dụng BoM để quản lý các phiên bản thư viện, điều này đảm bảo rằng tất cả các phiên bản đều tương thích.
dependencies { // Declare 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:20.1.0' }
Kotlin+KTX
Làm theo hướng dẫn để thêm Firebase vào ứng dụng Android của bạn .
Sử dụng Firebase Android BoM , khai báo sự phụ thuộc cho thư viện Cloud Functions Android trong tệp Gradle mô-đun (cấp ứng dụng) của bạn (thường là
app/build.gradle).dependencies { // Import the BoM for the Firebase platform implementation platform('com.google.firebase:firebase-bom:30.2.0') // Declare 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-ktx' }Bằng cách sử dụng Firebase Android BoM , ứng dụng của bạn sẽ luôn sử dụng các phiên bản tương thích của thư viện Firebase Android.
(Thay thế) Khai báo các phụ thuộc thư viện Firebase mà không cần sử dụng BoM
Nếu bạn 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ụ thuộc của nó.
Lưu ý rằng nếu bạn sử dụng nhiều thư viện Firebase trong ứng dụng của mình, chúng tôi thực sự khuyên bạn nên sử dụng BoM để quản lý các phiên bản thư viện, điều này đảm bảo rằng tất cả các phiên bản đều tương thích.
dependencies { // Declare 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-ktx:20.1.0' }
Dart
Làm theo hướng dẫn để thêm Firebase vào ứng dụng Flutter của bạn .
Từ thư mục gốc của dự án Flutter của bạn, hãy chạy lệnh sau để cài đặt plugin:
flutter pub add cloud_functionsSau khi hoàn tất, hãy xây dựng lại ứng dụng Flutter của bạn:
flutter runSau khi cài đặt, bạn có thể truy cập plugin
cloud_functionsbằng cách nhập nó vào mã Dart của bạn: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.txtcủa bạn.
Đối với C ++ với nền tảng Apple :
- Làm theo hướng dẫn để thêm Firebase vào dự án C ++ của bạn .
- Thêm nhóm Chức năng đám mây vào
Podfilecủa bạn:pod 'Firebase/Functions'
- Lưu tệp, sau đó chạy:
pod install
- Thêm lõi Firebase và các khung Chức năng đám mây từ SDK Firebase C ++ vào dự án Xcode của bạn.
-
firebase.framework -
firebase_functions.framework
-
Đoàn kết
- Làm theo hướng dẫn để thêm Firebase vào dự án Unity của bạn .
- Thêm
FirebaseFunctions.unitypackagetừ SDK Firebase Unity vào dự án Unity của bạn.
Khởi tạo SDK máy khách
Khởi tạo một phiên bản của Chức năng đám mây:
Nhanh
lazy var functions = Functions.functions()
Objective-C
@property(strong, nonatomic) FIRFunctions *functions;
// ...
self.functions = [FIRFunctions functions];
Web version 8
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 version 9
const app = initializeApp({
projectId: '### CLOUD FUNCTIONS PROJECT ID ###',
apiKey: '### FIREBASE API KEY ###',
authDomain: '### FIREBASE AUTH DOMAIN ###',
});
const functions = getFunctions(app);
Java
private FirebaseFunctions mFunctions; // ... mFunctions = FirebaseFunctions.getInstance();
Kotlin+KTX
private lateinit var functions: FirebaseFunctions // ... functions = Firebase.functions
Dart
final functions = FirebaseFunctions.instance;
C ++
firebase::functions::Functions* functions;
// ...
functions = firebase::functions::Functions::GetInstance(app);
Đoàn kết
functions = Firebase.Functions.DefaultInstance;
Gọi hàm
Nhanh
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 version 8
var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({ text: messageText })
.then((result) => {
// Read result of the Cloud Function.
var sanitizedMessage = result.data.text;
});
Web version 9
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;
});
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;
}
});
}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
}
}Dart
final result =
await FirebaseFunctions.instance.httpsCallable('addMessage').call();
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);
}
Đoàn kết
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 máy khách
Máy khách nhận được lỗi nếu máy chủ gặp 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ì máy khách sẽ nhận được code lỗi, message và thông tin details từ lỗi máy chủ. Nếu không, lỗi chứa thông báo INTERNAL và mã INTERNAL . Xem hướng dẫn để biết cách xử lý lỗi trong chức năng có thể gọi của bạn.
Nhanh
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 version 8
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 version 9
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;
// ...
});
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();
}
}
}
});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
}
}
}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);
// ...
Đoàn kết
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;
}
});
Khuyến nghị: Ngăn chặn lạm dụng với Kiểm tra ứng dụng
Trước khi khởi chạy ứng dụng của mình, bạn nên bật Kiểm tra ứng dụng để giúp đả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 chức năng có thể gọi của bạn.