Gọi hàm từ ứng dụng của bạn


Chức năng đám mây dành cho SDK ứng dụng của Firebase cho phép bạn gọi các hàm 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 hàm Có thể gọi HTTP trong Chức năng đám mây, 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 hàm có thể gọi HTTP cũng 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 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 lệnh gọi có những điểm khác biệt chính so với các hàm HTTP:

  • Với tính năng có thể 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 (nếu có) sẽ tự động được đưa vào yêu cầu.
  • Trình kích hoạt này sẽ tự động giải trình tự nội dung yêu cầu và xác thực mã thông báo xác thực.

SDK Firebase dành cho Cloud Functions thế hệ 2 trở lên tương tác với các phiên bản tối thiểu của SDK ứng dụng Firebase này để hỗ trợ các hàm có thể gọi qua HTTPS:

  • Firebase SDK cho các nền tảng của Apple 10.26.0
  • Firebase SDK dành cho Android 21.0.0
  • SDK web mô-đun của Firebase 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 phần 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 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 HTTPS. Phương thức này có 2 tham số: datacontext 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) => {
    // ...
  });
  

Đối với một hàm có thể gọi và lưu tin nhắn văn bản vào Cơ sở dữ liệu theo thời gian thực, ví dụ: data có thể chứa văn bản thông báo, 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 = 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 chỉ định vị trí hàm (nếu có) và đảm bảo căn chỉnh vị trí của chức năng gọi với vị trí được đặt khi bạn khởi động SDK ở phía máy khách.

Nếu muố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ợ 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 Bật tính năng thực thi Kiểm tra ứng dụng cho Chức năng đám mây.

Đ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ể mã hoá JSON. Ví dụ: để trả về kết quả của một phép 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 mà 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 Cơ sở dữ liệu theo thời gian thực:

// 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 nhận được thông tin chi tiết hữu ích về lỗi, hãy trả về lỗi từ một thực thể có thể gọi bằng cách gửi (hoặc trả về một Promise bị từ chối cùng) một thực thể của functions.https.HttpsError. Lỗi có thuộc tính code. Thuộc tính này 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 chuỗi message, giá trị mặc định là một chuỗi trống. Các đối tượng này cũng có thể có một trường details không bắt buộc có giá trị tuỳ ý. Nếu một lỗi không phải HttpsError được gửi từ các hàm, ứng dụng khách của bạn sẽ nhận được thông báo 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ề ứ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 chỉnh 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 đố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 hàm, hãy đảm bảo rằng các vai trò IAM thích hợp đã được chỉ định cho người dùng đang chạy lệnh triển khai.

Thiết lập môi trường phát triển ứng dụng

Hãy đả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 bắt buộc vào ứng dụng.

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.

  1. Trong Xcode, khi dự án ứng dụng của bạn đang mở, hãy chuyển đến Tệp > Thêm gói.
  2. Khi được nhắc, hãy thêm kho lưu trữ SDK cho các nền tảng Firebase của Apple:
  3.   https://github.com/firebase/firebase-ios-sdk.git
  4. Chọn thư viện Chức năng đám mây.
  5. Thêm cờ -ObjC vào mục Cờ trình liên kết khác trong chế độ cài đặt bản dựng của mục tiêu.
  6. 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.

API mô-đun web

  1. 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 đây từ thiết bị đầu cuối của bạn:
    npm install firebase@10.12.1 --save
    
  2. Yêu cầu cả chức năng đám mây và chức năng cốt lõi của Firebase 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);
    

API được đặt tên trong vùng chứa tên của web

  1. Làm theo hướng dẫn để thêm Firebase vào ứng dụng web của bạn.
  2. Thêm thư viện ứng dụng cốt lõi của Firebase và 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 cung cấp dưới dạng gói npm.

  1. Chạy lệnh sau từ cửa sổ dòng lệnh của bạn:
    npm install firebase@8.10.1 --save
    
  2. Yêu cầu cả chức năng đám mây và cốt lõi của Firebase theo cách thủ công:
    const firebase = require("firebase");
    // Required for side-effects
    require("firebase/functions");
    

Kotlin+KTX

  1. Làm theo hướng dẫn để thêm Firebase vào ứng dụng Android.

  2. Trong tệp Gradle mô-đun (cấp ứng dụng) (thường là <project>/<app-module>/build.gradle.kts hoặc <project>/<app-module>/build.gradle), hãy thêm phần phụ thuộc cho thư viện Cloud Functions 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.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")
    }
    

    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 Android Firebase.

    (Thay thế) Thêm các 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 BoM của Firebase, bạn phải chỉ định từng phiên bản thư viện Firebase trong dòng phần phụ thuộc tương ứng.

    Xin lưu ý rằng nếu sử dụng nhiều thư viện Firebase trong ứng dụng của mình, 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 mọi 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.0.0")
    }
    
    Bạn đang tìm một mô-đun thư viện dành riêng cho Kotlin? Kể từ tháng 10 năm 2023 (Firebase BoM 32.5.0), cả nhà phát triển Kotlin và Java đều có thể sử dụng mô-đun thư viện chính (để biết thông tin chi tiết, hãy xem phần Câu hỏi thường gặp về sáng kiến này).

Java

  1. Làm theo hướng dẫn để thêm Firebase vào ứng dụng Android.

  2. Trong tệp Gradle mô-đun (cấp ứng dụng) (thường là <project>/<app-module>/build.gradle.kts hoặc <project>/<app-module>/build.gradle), hãy thêm phần phụ thuộc cho thư viện Cloud Functions 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.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")
    }
    

    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 Android Firebase.

    (Thay thế) Thêm các 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 BoM của Firebase, bạn phải chỉ định từng phiên bản thư viện Firebase trong dòng phần phụ thuộc tương ứng.

    Xin lưu ý rằng nếu sử dụng nhiều thư viện Firebase trong ứng dụng của mình, 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 mọi 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.0.0")
    }
    
    Bạn đang tìm một mô-đun thư viện dành riêng cho Kotlin? Kể từ tháng 10 năm 2023 (Firebase BoM 32.5.0), cả nhà phát triển Kotlin và Java đều có thể sử dụng mô-đun thư viện chính (để biết thông tin chi tiết, hãy xem phần Câu hỏi thường gặp về sáng kiến này).

Dart

  1. Làm theo hướng dẫn để thêm Firebase vào ứng dụng Flutter của bạn.

  2. 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_functions
    
  3. Sau khi hoàn tất, hãy tạo lại ứng dụng Flutter:

    flutter run
    
  4. Sau khi cài đặt, bạn có thể truy cập trình bổ trợ cloud_functions bằ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++ dành cho Android:

  1. Làm theo hướng dẫn để thêm Firebase vào dự án C++ của bạn.
  2. Thêm thư viện firebase_functions vào tệp CMakeLists.txt.

Đối với C++ với các nền tảng của Apple:

  1. Làm theo hướng dẫn để thêm Firebase vào dự án C++ của bạn.
  2. Thêm nhóm Chức năng đám mây vào Podfile:
    pod 'Firebase/Functions'
  3. Lưu tệp, rồi chạy:
    pod install
  4. Thêm khung nền tảng Firebase và khung Cloud Functions từ SDK C++ của Firebase vào dự án Xcode của bạn.
    • firebase.framework
    • firebase_functions.framework

Unity

  1. Làm theo hướng dẫn để thêm Firebase vào dự án Unity của bạn.
  2. Thêm FirebaseFunctions.unitypackage từ 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];

API được đặt tên trong vùng chứa tên của 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();

API mô-đun 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();

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

API được đặt tên trong vùng chứa tên của web

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

API mô-đun 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 máy khách

Ứng dụng sẽ nhận được thông báo lỗi nếu máy chủ báo lỗi hoặc nếu lời hứa phát sinh bị từ chối.

Nếu lỗi mà hàm trả về thuộc loại function.https.HttpsError, thì máy khách sẽ nhận được lỗi code, messagedetails từ lỗi 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"];
  }
  // ...
}

API được đặt tên trong vùng chứa tên của 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;
    // ...
  });

API mô-đun 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;
  }
});

Trước khi chạy ứng dụng, bạn nên bật tính năng Kiểm tra ứng dụng để đảm bảo rằng chỉ các ứng dụng của mình mới có thể truy cập vào điểm cuối của hàm có thể gọi.