Cloud Functions for Firebase 用戶端 SDK 可讓您直接從 Firebase 應用程式呼叫函式。如要以這種方式從應用程式呼叫函式，請在 Cloud Functions 中編寫和部署 HTTP 可呼叫函式，然後新增用戶端邏輯，從應用程式呼叫函式。
請注意，HTTP 可呼叫函式與 HTTP 函式相似，但「不相同」。如要使用 HTTP 可呼叫函式，您必須將平台的用戶端 SDK 與後端 API (或導入通訊協定) 搭配使用。可呼叫元件與 HTTP 函式的主要差異如下：
- 使用可呼叫功能時，Firebase 驗證權杖、FCM 權杖和 App Check 權杖 (如有) 會自動納入要求中。
- 觸發條件會自動反序列化要求主體並驗證驗證權杖。
Cloud Functions (第 2 代) 以上的 Firebase SDK 可與下列 Firebase 用戶端 SDK 最低版本互通，以支援 HTTPS 呼叫函式：
- Apple SDK 10.28.0 版
- Android 21.0.0 專用 Firebase SDK
- Firebase 模組化 Web SDK 9.7.0 版
如要新增類似功能，以使用不受支援的平台建構的應用程式，請參閱 https.onCall 的通訊協定規格。本指南的其餘部分會說明如何編寫、部署及呼叫適用於 Apple 平台、Android、網頁、C++ 和 Unity 的 HTTP 可呼叫函式。
編寫及部署可呼叫函式
本節中的程式碼範例是以完整的快速入門導覽課程範例為基礎，示範如何將要求傳送至伺服器端函式，以及使用其中一個 Client SDK 取得回應。如要開始，請匯入必要的模組：
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
使用平台 (functions.https.onCall) 或 on_call 的要求處理常式建立 HTTPS 可呼叫函式。這個方法接受要求參數：
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."""
request 參數包含從用戶端應用程式傳送的資料，以及驗證狀態等其他背景資訊。如為可將簡訊儲存至即時資料庫的可呼叫函式，例如 data 可能包含訊息文字，以及 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", "")
可呼叫函式位置與呼叫用戶端位置之間的距離可能會導致網路延遲。為達到最佳效能，請考慮在適用情況下指定函式位置，並在用戶端初始化 SDK 時，確定可呼叫的位置與設定的位置一致。
或者，您也可以附加 App Check 認證，避免後端資源遭到濫用，例如帳單詐欺或網路釣魚。請參閱「啟用 Cloud Functions 的 App Check 強制執行功能」一節。
正在傳回結果
如要將資料傳回用戶端，請傳回可採用 JSON 編碼的資料。例如，傳回加總運算的結果：
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
}
訊息文字範例中的經過處理的文字內容都會傳回用戶端和即時資料庫。在 Node.js 中，您可以利用 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}
設定 CORS (跨源資源共享)
使用 cors 選項控管哪些來源可存取函式。
根據預設，可呼叫函式的 CORS 會設定為允許來自所有來源的要求。如要允許部分跨來源要求 (而非所有要求)，請傳送應允許的特定網域或規則運算式清單。例如：
Node.js
const { onCall } = require("firebase-functions/v2/https");
exports.getGreeting = onCall(
{ cors: [/firebase\.com$/, "https://flutter.com"] },
(request) => {
return "Hello, world!";
}
);
如要禁止跨來源要求，請將 cors 政策設為 false。
處理錯誤
為確保用戶端取得實用的錯誤詳細資料，請擲回 (或針對傳回 Promise 且傳回 Promise 物件，即 functions.https.HttpsError 或 https_fn.HttpsError 例項) 的方式，從可呼叫傳回錯誤。錯誤具有 code 屬性，可能是 gRPC 狀態碼中列出的其中一個值。錯誤也包含 message 字串，預設為空字串。以及含有任意值的 details 欄位。如果函式擲回 HTTPS 錯誤以外的錯誤，您的用戶端會改為收到訊息 INTERNAL 和程式碼 internal 的錯誤訊息。
例如，函式可能會將含有錯誤訊息的資料驗證和驗證錯誤擲回呼叫用戶端：
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.")
部署可呼叫函式
在 index.js 中儲存已完成的可呼叫函式後，系統會在您執行 firebase deploy 時，將其與其他所有函式一起部署。如果只要部署可呼叫的項目，請使用 --only 引數執行部分部署，如下所示：
firebase deploy --only functions:addMessage
如果您在部署函式時遇到權限錯誤，請確定已將適當的 IAM 角色指派給執行部署指令的使用者。
設定用戶端開發環境
請確認符合所有必要條件，然後將必要的依附元件和用戶端程式庫加入應用程式。
iOS+
按照操作說明將 Firebase 新增至 Apple 應用程式。
使用 Swift Package Manager 安裝及管理 Firebase 依附元件。
- 在 Xcode 中保持開啟應用程式專案，然後依序點選「File」>「Add Packages」。
- 在系統提示時，新增 Firebase Apple 平台 SDK 存放區：
- 選擇 Cloud Functions 程式庫。
- 在目標建構設定的「Other Linker Flags」部分中新增
-ObjC標記。 - 完成後，Xcode 會自動開始在背景解析並下載依附元件。
https://github.com/firebase/firebase-ios-sdk.git
Web
- 按照操作說明將 Firebase 新增至網頁應用程式。請務必從終端機執行下列指令：
npm install firebase@10.12.2 --save
手動同時需要 Firebase Core 和 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 裝置
在模組 (應用程式層級) Gradle 檔案 (通常是
<project>/<app-module>/build.gradle.kts或<project>/<app-module>/build.gradle) 中，新增 Android 適用的 Cloud Functions 程式庫的依附元件。建議您使用 Firebase Android BoM 控管程式庫的版本管理。dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.1.1")) // 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") }只要使用 Firebase Android BoM，您的應用程式就會一律使用相容的 Firebase Android 程式庫版本。
(替代做法) 新增 Firebase 程式庫依附元件，「不」使用 BoM
如果選擇不使用 Firebase BoM，就必須在依附元件行中指定每個 Firebase 程式庫版本。
請注意，如果您在應用程式中使用多個 Firebase 程式庫，強烈建議您使用 BoM 來管理程式庫版本，以確保所有版本都相容。
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") }
初始化用戶端 SDK
初始化 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();
呼叫函式
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;
});
}
處理用戶端上的錯誤
如果伺服器擲回錯誤，或產生的承諾遭拒，用戶端就會收到錯誤訊息。
如果函式傳回的錯誤類型為 function.https.HttpsError，則用戶端會收到伺服器錯誤中的 code、message 和 details 錯誤。否則，錯誤會包含訊息 INTERNAL 和 INTERNAL 代碼。請參閱指南，瞭解如何處理可呼叫函式中的錯誤。
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;
}
});
建議做法：使用 App Check 防範濫用行為
在啟動應用程式之前，請先啟用 App Check，確保只有您的應用程式可以存取可呼叫的函式端點。