透過應用程式呼叫函式


Cloud Functions for Firebase 用戶端 SDK 可讓您直接從 Firebase 應用程式呼叫函式。如要以這種方式從應用程式呼叫函式,請在 Cloud Functions 中編寫及部署 HTTP 可呼叫函式,然後新增用戶端邏輯,從應用程式呼叫該函式。

請特別注意,HTTP 可呼叫的函式相似,但「並非」HTTP 函式。如要使用 HTTP 呼叫函式,您必須將平台的用戶端 SDK 與後端 API 搭配使用 (或實作通訊協定)。可呼叫項目與 HTTP 函式有下列主要差異:

  • 透過可呼叫項目,Firebase 驗證權杖、FCM 權杖和 App Check 權杖 (如有) 會自動加入要求中。
  • 觸發條件會自動將要求主體還原序列化,並驗證驗證權杖。

Cloud Functions (第 2 代及更高版本) 與下列 Firebase 用戶端 SDK 最低版本互通,支援 HTTPS 呼叫函式:

  • Apple 平台適用的 Firebase SDK 10.26.0
  • Android 21.0.0 適用的 Firebase SDK
  • Firebase Modular Web SDK 9.7.0 版

如果要為在不支援的平台上建構的應用程式新增類似功能,請參閱 https.onCall 的通訊協定規格。本指南的其餘部分說明如何編寫、部署及呼叫適用於 Apple 平台、Android、網頁、C++ 和 Unity 的 HTTP 呼叫函式。

編寫及部署可呼叫的函式

使用 functions.https.onCall 建立可透過 HTTPS 呼叫的函式。這個方法使用兩個參數:data,和選用的 context

  // Saves a message to the Firebase Realtime Database but sanitizes the
  // text by removing swearwords.
  exports.addMessage = functions.https.onCall((data, context) => {
    // ...
  });
  

如果是將文字訊息儲存至即時資料庫的可呼叫函式,data 可能包含訊息文字,context 參數則代表使用者驗證資訊:

// 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;

呼叫函式位置和呼叫用戶端位置之間的距離可能會造成網路延遲。如要最佳化效能,請考慮在適用的情況下指定函式位置,並務必在用戶端初始化 SDK 時,將可呼叫的位置與設定的位置保持一致。

或者,您也可以附加 App Check 認證,協助防止後端資源遭到濫用,例如帳單詐欺或網路釣魚。請參閱為 Cloud Functions 啟用 App Check 強制執行功能

傳回結果

如要將資料傳回用戶端,請傳回 JSON 編碼的資料。例如,要傳回加總運算的結果:

// returning result.
return {
  firstNumber: firstNumber,
  secondNumber: secondNumber,
  operator: "+",
  operationResult: firstNumber + secondNumber,
};

如要在非同步作業後傳回資料,請傳回 promise。承諾傳回的資料會傳回用戶端。舉例來說,您可以傳回可呼叫函式寫入即時資料庫的經過處理的文字:

// 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};
})

處理錯誤

為確保用戶端能取得實用的錯誤詳細資料,請擲回 (或傳回使用 functions.https.HttpsError 的拒絕承諾並拒絕承諾) 的可呼叫錯誤,藉此傳回可呼叫的錯誤。錯誤含有 code 屬性,可以是 functions.https.HttpsError 所列的其中一個值。這些錯誤也包含 message 字串,預設為空白字串。也可能是選用的 details 欄位和任意值。如果函式擲回 HttpsError 以外的錯誤,您的用戶端會改為收到包含 INTERNAL 訊息和 internal 代碼的錯誤。

例如,函式可以擲回資料驗證和驗證錯誤與錯誤訊息,以傳回呼叫用戶端:

// 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.");
}

部署可呼叫函式

index.js 中儲存已完成的可呼叫函式後,當您執行 firebase deploy 時,該函式就會與其他所有函式一起部署。如果只要部署可呼叫,請使用如下所示的 --only 引數執行部分部署

firebase deploy --only functions:addMessage

如果您在部署函式時遇到權限錯誤,請務必將適當的 IAM 角色指派給執行部署指令的使用者。

設定用戶端開發環境

請先確認您符合所有必要條件,然後在應用程式中加入必要的依附元件和用戶端程式庫。

iOS+

按照操作說明將 Firebase 新增至 Apple 應用程式

使用 Swift Package Manager 安裝及管理 Firebase 依附元件。

  1. 在 Xcode 中,開啟應用程式專案,然後依序點選「File」>「Add Packages」
  2. 出現提示時,新增 Firebase Apple 平台 SDK 存放區:
  3.   https://github.com/firebase/firebase-ios-sdk.git
  4. 選擇 Cloud Functions 程式庫。
  5. -ObjC 旗標新增至目標建構設定中的「Other Linker Flags」區段。
  6. 完成後,Xcode 就會自動開始在背景中解析並下載依附元件。

網路模組 API

  1. 按照操作說明將 Firebase 新增至您的網頁應用程式。請務必從終端機執行下列指令:
    npm install firebase@10.12.1 --save
    
  2. 手動需要 Firebase 核心和 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);
    

網路命名空間 API

  1. 按照操作說明將 Firebase 新增至網頁應用程式
  2. 將 Firebase 核心和 Cloud Functions 用戶端程式庫新增至您的應用程式:
    <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>
    

Cloud Functions SDK 也可以做為 npm 套件使用。

  1. 從終端機執行下列指令:
    npm install firebase@8.10.1 --save
    
  2. 手動需要 Firebase 核心和 Cloud Functions:
    const firebase = require("firebase");
    // Required for side-effects
    require("firebase/functions");
    

Kotlin+KTX

  1. 按照操作說明將 Firebase 新增至 Android 應用程式

  2. 模組 (應用程式層級) 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.0.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")
    }
    

    如果使用 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")
    }
    
    在尋找 Kotlin 專用的程式庫模組嗎?2023 年 10 月 (Firebase BoM 32.5.0) 起,Kotlin 和 Java 開發人員都可以依賴主程式庫模組 (詳情請參閱這項計畫的常見問題)。

Java

  1. 按照操作說明將 Firebase 新增至 Android 應用程式

  2. 模組 (應用程式層級) 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.0.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")
    }
    

    如果使用 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")
    }
    
    在尋找 Kotlin 專用的程式庫模組嗎?2023 年 10 月 (Firebase BoM 32.5.0) 起,Kotlin 和 Java 開發人員都可以依賴主程式庫模組 (詳情請參閱這項計畫的常見問題)。

Dart

  1. 按照操作說明將 Firebase 新增至 Flutter 應用程式

  2. 在 Flutter 專案的根目錄中執行下列指令,即可安裝外掛程式:

    flutter pub add cloud_functions
    
  3. 完成後,請重新建構 Flutter 應用程式:

    flutter run
    
  4. 安裝完成後,您就可以在 Dart 程式碼中匯入 cloud_functions 外掛程式,以存取這個外掛程式:

    import 'package:cloud_functions/cloud_functions.dart';
    

C++

適用於 Android 的 C++

  1. 按照操作說明將 Firebase 新增至 C++ 專案
  2. firebase_functions 程式庫新增至 CMakeLists.txt 檔案。

適用於適用於 Apple 平台的 C++

  1. 按照操作說明將 Firebase 新增至 C++ 專案
  2. 將 Cloud Functions Pod 新增到 Podfile
    pod 'Firebase/Functions'
  3. 儲存檔案,然後執行:
    pod install
  4. 將 Firebase 核心和 Cloud Functions 架構從 Firebase C++ SDK 新增至 Xcode 專案。
    • firebase.framework
    • firebase_functions.framework

Unity

  1. 按照操作說明將 Firebase 新增至 Unity 專案
  2. FirebaseFunctions.unitypackageFirebase Unity SDK 新增到 Unity 專案。

初始化用戶端 SDK

初始化 Cloud Functions 的執行個體:

Swift

lazy var functions = Functions.functions()

Objective-C

@property(strong, nonatomic) FIRFunctions *functions;
// ...
self.functions = [FIRFunctions functions];

網路命名空間 API

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();

網路模組 API

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();

Dart

final functions = FirebaseFunctions.instance;

C++

firebase::functions::Functions* functions;
// ...
functions = firebase::functions::Functions::GetInstance(app);

Unity

functions = Firebase.Functions.DefaultInstance;

呼叫函式

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"];
}];

網路命名空間 API

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    var sanitizedMessage = result.data.text;
  });

網路模組 API

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 類型,則用戶端會收到伺服器錯誤中的 codemessagedetails 錯誤。否則,錯誤會包含 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"];
  }
  // ...
}

網路命名空間 API

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;
    // ...
  });

網路模組 API

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,確保只有應用程式可以存取可呼叫函式端點。