Bắt đầu: viết, kiểm thử và triển khai các hàm đầu tiên

Để bắt đầu sử dụng Cloud Functions, hãy thử làm theo hướng dẫn này, hướng dẫn này bắt đầu bằng các tác vụ thiết lập bắt buộc và hướng dẫn bạn cách tạo, kiểm thử, và triển khai hai hàm có liên quan:

  • Hàm "thêm tin nhắn" hiển thị một URL chấp nhận giá trị văn bản và ghi giá trị đó vào Cloud Firestore.
  • Hàm "chuyển thành chữ hoa" kích hoạt khi ghi vào Cloud Firestore và chuyển đổi văn bản thành chữ hoa.

Sau đây là mã mẫu đầy đủ chứa các hàm:

Node.js

// The Cloud Functions for Firebase SDK to create Cloud Functions and triggers.
const {logger} = require("firebase-functions");
const {onRequest} = require("firebase-functions/https");
const {onDocumentCreated} = require("firebase-functions/firestore");

// The Firebase Admin SDK to access Firestore.
const {initializeApp} = require("firebase-admin/app");
const {getFirestore} = require("firebase-admin/firestore");

initializeApp();

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addmessage = onRequest(async (req, res) => {
  // Grab the text parameter.
  const original = req.query.text;
  // Push the new message into Firestore using the Firebase Admin SDK.
  const writeResult = await getFirestore()
      .collection("messages")
      .add({original: original});
  // Send back a message that we've successfully written the message
  res.json({result: `Message with ID: ${writeResult.id} added.`});
});

// Listens for new messages added to /messages/:documentId/original
// and saves an uppercased version of the message
// to /messages/:documentId/uppercase
exports.makeuppercase = onDocumentCreated("/messages/{documentId}", (event) => {
  // Grab the current value of what was written to Firestore.
  const original = event.data.data().original;

  // Access the parameter `{documentId}` with `event.params`
  logger.log("Uppercasing", event.params.documentId, original);

  const uppercase = original.toUpperCase();

  // You must return a Promise when performing
  // asynchronous tasks inside a function
  // such as writing to Firestore.
  // Setting an 'uppercase' field in Firestore document returns a Promise.
  return event.data.ref.set({uppercase}, {merge: true});
});

Python

# The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
from firebase_functions import firestore_fn, https_fn

# The Firebase Admin SDK to access Cloud Firestore.
from firebase_admin import initialize_app, firestore
import google.cloud.firestore

app = initialize_app()


@https_fn.on_request()
def addmessage(req: https_fn.Request) -> https_fn.Response:
    """Take the text parameter passed to this HTTP endpoint and insert it into
    a new document in the messages collection."""
    # Grab the text parameter.
    original = req.args.get("text")
    if original is None:
        return https_fn.Response("No text parameter provided", status=400)

    firestore_client: google.cloud.firestore.Client = firestore.client()

    # Push the new message into Cloud Firestore using the Firebase Admin SDK.
    _, doc_ref = firestore_client.collection("messages").add({"original": original})

    # Send back a message that we've successfully written the message
    return https_fn.Response(f"Message with ID {doc_ref.id} added.")


@firestore_fn.on_document_created(document="messages/{pushId}")
def makeuppercase(event: firestore_fn.Event[firestore_fn.DocumentSnapshot | None]) -> None:
    """Listens for new documents to be added to /messages. If the document has
    an "original" field, creates an "uppercase" field containg the contents of
    "original" in upper case."""

    # Get the value of "original" if it exists.
    if event.data is None:
        return
    try:
        original = event.data.get("original")
    except KeyError:
        # No "original" field, so do nothing.
        return

    # Set the "uppercase" field.
    print(f"Uppercasing {event.params['pushId']}: {original}")
    upper = original.upper()
    event.data.reference.update({"uppercase": upper})

Giới thiệu về hướng dẫn này

Chúng tôi đã chọn Cloud Firestore và các hàm được kích hoạt bằng HTTP cho mẫu này, một phần là vì bạn có thể kiểm thử kỹ lưỡng các trình kích hoạt nền này thông qua Firebase Local Emulator Suite. Bộ công cụ này cũng hỗ trợ Realtime Database, Cloud Storage, PubSub, Auth và các trình kích hoạt có thể gọi bằng HTTP. Bạn có thể kiểm thử tương tác các loại trình kích hoạt nền khác chẳng hạn như Remote Config và trình kích hoạt TestLab, bằng cách sử dụng các bộ công cụ không được mô tả trên trang này.

Các phần sau đây của hướng dẫn này trình bày chi tiết các bước cần thiết để tạo, kiểm thử và triển khai mẫu.

Tạo dự án Firebase

Bạn mới sử dụng Firebase hoặc Cloud

Hãy làm theo các bước sau nếu bạn mới sử dụng Firebase hoặc Google Cloud.
Bạn cũng có thể làm theo các bước này nếu muốn tạo một dự án Firebase hoàn toàn mới (và dự án cơ bản của dự án đó).Google Cloud

  1. Đăng nhập vào Firebase bảng điều khiển.
  2. Nhấp vào nút để tạo một dự án Firebase mới.
  3. Trong trường văn bản, hãy nhập tên dự án.

    Nếu thuộc một Google Cloud tổ chức, bạn có thể chọn thư mục mà bạn tạo dự án.

  4. Nếu được nhắc, hãy xem xét và chấp nhận các điều khoản của Firebase, sau đó nhấp vào Tiếp tục.
  5. (Không bắt buộc) Bật tính năng trợ giúp AI trong bảng điều khiển Firebase (được gọi là "Gemini trong Firebase"). Tính năng này có thể giúp bạn bắt đầu và đơn giản hoá quy trình phát triển.
  6. (Không bắt buộc) Thiết lập Google Analytics cho dự án của bạn. Việc này giúp mang lại trải nghiệm tối ưu khi sử dụng các sản phẩm Firebase sau: Firebase A/B Testing, Cloud Messaging, Crashlytics, In-App MessagingRemote Config (bao gồm cả tính năng Cá nhân hoá).

    Chọn một tài khoản Google Analytics hiện có hoặc tạo một tài khoản mới. Nếu bạn tạo một tài khoản mới, hãy chọn vị trí báo cáo Analytics, sau đó chấp nhận các cài đặt cách chia sẻ dữ liệu và Google Analytics điều khoản cho dự án của bạn.

  7. Nhấp vào Tạo dự án.

Firebase tạo dự án, cung cấp một số tài nguyên ban đầu và bật các API quan trọng. Khi quá trình hoàn tất, bạn sẽ được chuyển đến trang tổng quan cho dự án Firebase của mình trong bảng điều khiển Firebase.

Dự án trên đám mây hiện có

Hãy làm theo các bước sau nếu bạn muốn bắt đầu sử dụng Firebase với một dự án hiện có Google Cloud. Tìm hiểu thêm và khắc phục sự cố về việc "thêm Firebase" vào một dự án Google Cloud hiện có.

  1. Đăng nhập vào bảng điều khiển của Firebase Firebase bằng tài khoản cho phép bạn truy cập vào dự án Google Cloud hiện có.
  2. Nhấp vào nút để tạo một dự án Firebase mới.
  3. Ở cuối trang, hãy nhấp vào Thêm Firebase vào dự án trên đám mây của Google Cloud.
  4. Trong trường văn bản, hãy bắt đầu nhập tên dự án của dự án hiện có, sau đó chọn dự án trong danh sách hiển thị.
  5. Nhấp vào Mở dự án.
  6. Nếu được nhắc, hãy xem xét và chấp nhận các điều khoản của Firebase, sau đó nhấp vào Tiếp tục.
  7. (Không bắt buộc) Bật tính năng trợ giúp AI trong bảng điều khiển Firebase (được gọi là "Gemini trong Firebase"). Tính năng này có thể giúp bạn bắt đầu và đơn giản hoá quy trình phát triển.
  8. (Không bắt buộc) Thiết lập Google Analytics cho dự án của bạn. Việc này giúp mang lại trải nghiệm tối ưu khi sử dụng các sản phẩm Firebase sau: Firebase A/B Testing, Cloud Messaging, Crashlytics, In-App MessagingRemote Config (bao gồm cả tính năng Cá nhân hoá).

    Chọn một tài khoản Google Analytics hiện có hoặc tạo một tài khoản mới. Nếu bạn tạo một tài khoản mới, hãy chọn vị trí báo cáo Analytics, sau đó chấp nhận các cài đặt cách chia sẻ dữ liệu và Google Analytics điều khoản cho dự án của bạn.

  9. Nhấp vào Thêm Firebase.

Firebase thêm Firebase vào dự án hiện có của bạn. Khi quá trình hoàn tất, bạn sẽ được chuyển đến trang tổng quan cho dự án Firebase của mình trong bảng điều khiển Firebase.

Thiết lập môi trường và Firebase CLI

Node.js

Bạn cần có môi trường Node.js để viết các hàm, và cần có Firebase CLI để triển khai các hàm vào thời gian chạy Cloud Functions. Để cài đặt Node.js và npm, Trình quản lý phiên bản Node bạn nên sử dụng.

Sau khi cài đặt Node.js và npm, hãy cài đặt Firebase CLI thông qua phương thức mà bạn muốn. Để cài đặt CLI thông qua npm, hãy sử dụng:

npm install -g firebase-tools

Lệnh này cài đặt lệnh firebase có sẵn trên toàn cầu. Nếu lệnh không thành công, bạn có thể cần thay đổi quyền npm. Để cập nhật lên phiên bản firebase-tools mới nhất, hãy chạy lại cùng một lệnh.

Python

Bạn cần có môi trường Python để viết các hàm và cần có Firebase CLI để triển khai các hàm vào thời gian chạy Cloud Functions. Bạn nên sử dụng venv để tách biệt các phần phụ thuộc. Các phiên bản Python từ 3.10 đến 3.13 được hỗ trợ, trong đó 3.13 là thời gian chạy mặc định.

Sau khi cài đặt Python, hãy cài đặt CLIFirebase thông qua phương thức mà bạn muốn.

Chạy dự án của bạn

Khi bạn khởi động Firebase SDK cho Cloud Functions, bạn sẽ tạo một dự án trống chứa các phần phụ thuộc và một số mã mẫu tối thiểu. Nếu đang sử dụng Node.js, bạn có thể chọn TypeScript hoặc JavaScript để tạo các hàm. Để phục vụ mục đích của hướng dẫn này, bạn cũng cần khởi động Cloud Firestore.

Cách khởi động dự án:

  1. Chạy firebase login để đăng nhập qua trình trình duyệt và xác thực Firebase CLI.
  2. Chuyển đến thư mục dự án Firebase.
  3. Chạy firebase init firestore. Đối với hướng dẫn này, bạn có thể chấp nhận các giá trị mặc định khi được nhắc về các quy tắc và tệp chỉ mục của Firestore. Nếu bạn chưa sử dụng Cloud Firestore trong dự án này, bạn cũng cần chọn chế độ bắt đầu và vị trí cho Firestore như mô tả trong phần Bắt đầu sử dụng Cloud Firestore.
  4. Chạy firebase init functions. CLI nhắc bạn chọn một cơ sở mã hiện có hoặc khởi động và đặt tên cho một cơ sở mã mới. Khi bạn mới bắt đầu, một cơ sở mã duy nhất ở vị trí mặc định là đủ; sau này, khi quá trình triển khai mở rộng, bạn có thể muốn sắp xếp các hàm trong cơ sở mã.
  5. CLI cung cấp cho bạn các lựa chọn sau để hỗ trợ ngôn ngữ:

    • JavaScript
    • TypeScript
    • Python

    Đối với hướng dẫn này, hãy chọn JavaScript hoặc Python. Để tạo bằng TypeScript, hãy xem bài viết Viết hàm bằng TypeScript.

  6. CLI cung cấp cho bạn một lựa chọn để cài đặt các phần phụ thuộc. Bạn có thể từ chối lựa chọn này nếu muốn quản lý các phần phụ thuộc theo cách khác.

Sau khi các lệnh này hoàn tất thành công, cấu trúc dự án của bạn sẽ như sau:

Node.js

myproject
+- .firebaserc    # Hidden file that helps you quickly switch between
|                 # projects with `firebase use`
|
+- firebase.json  # Describes properties for your project
|
+- functions/     # Directory containing all your functions code
      |
      +- .eslintrc.json  # Optional file containing rules for JavaScript linting.
      |
      +- package.json  # npm package file describing your Cloud Functions code
      |
      +- index.js      # Main source file for your Cloud Functions code
      |
      +- node_modules/ # Directory where your dependencies (declared in
                        # package.json) are installed

Đối với Node.js, tệp package.json được tạo trong quá trình khởi động chứa một khoá quan trọng: "engines": {"node": "18"}. Khoá này chỉ định phiên bản Node.js để viết và triển khai các hàm. Bạn có thể chọn các phiên bản được hỗ trợ khác.

Python

myproject
+- .firebaserc    # Hidden file that helps you quickly switch between
|                 # projects with `firebase use`
|
+- firebase.json  # Describes properties for your project
|
+- functions/     # Directory containing all your functions code
      |
      +- main.py      # Main source file for your Cloud Functions code
      |
      +- requirements.txt  #  List of the project's modules and packages 
      |
      +- venv/ # Directory where your dependencies are installed

Nhập các mô-đun bắt buộc và khởi động một ứng dụng

Sau khi hoàn tất các tác vụ thiết lập, bạn có thể mở thư mục nguồn và bắt đầu thêm mã như mô tả trong các phần sau. Đối với mẫu này, dự án của bạn phải nhập các mô-đun Cloud Functions và SDK dành cho quản trị viên. Thêm các dòng như sau vào tệp nguồn:

Node.js

// The Cloud Functions for Firebase SDK to create Cloud Functions and triggers.
const {logger} = require("firebase-functions");
const {onRequest} = require("firebase-functions/https");
const {onDocumentCreated} = require("firebase-functions/firestore");

// The Firebase Admin SDK to access Firestore.
const {initializeApp} = require("firebase-admin/app");
const {getFirestore} = require("firebase-admin/firestore");

initializeApp();

Python

# The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
from firebase_functions import firestore_fn, https_fn

# The Firebase Admin SDK to access Cloud Firestore.
from firebase_admin import initialize_app, firestore
import google.cloud.firestore

app = initialize_app()

Các dòng này tải các mô-đun bắt buộc và khởi động một thực thể ứng dụng admin mà từ đó có thể thực hiện các thay đổi Cloud Firestore. Bất cứ nơi nào có hỗ trợ SDK dành cho quản trị viên, chẳng hạn như đối với FCM, Authentication, và Firebase Realtime Database, SDK này đều cung cấp một cách mạnh mẽ để tích hợp Firebase bằng Cloud Functions.

Firebase CLI tự động cài đặt SDK của Firebase dành cho quản trị viên và Firebase SDK cho các mô-đun Cloud Functions khi bạn khởi động dự án. Để biết thêm thông tin về cách thêm thư viện của bên thứ ba vào dự án, hãy xem phần Xử lý các phần phụ thuộc.

Thêm hàm "thêm tin nhắn"

Đối với hàm "thêm tin nhắn", hãy thêm các dòng sau vào tệp nguồn:

Node.js

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addmessage = onRequest(async (req, res) => {
  // Grab the text parameter.
  const original = req.query.text;
  // Push the new message into Firestore using the Firebase Admin SDK.
  const writeResult = await getFirestore()
      .collection("messages")
      .add({original: original});
  // Send back a message that we've successfully written the message
  res.json({result: `Message with ID: ${writeResult.id} added.`});
});

Python

@https_fn.on_request()
def addmessage(req: https_fn.Request) -> https_fn.Response:
    """Take the text parameter passed to this HTTP endpoint and insert it into
    a new document in the messages collection."""
    # Grab the text parameter.
    original = req.args.get("text")
    if original is None:
        return https_fn.Response("No text parameter provided", status=400)

    firestore_client: google.cloud.firestore.Client = firestore.client()

    # Push the new message into Cloud Firestore using the Firebase Admin SDK.
    _, doc_ref = firestore_client.collection("messages").add({"original": original})

    # Send back a message that we've successfully written the message
    return https_fn.Response(f"Message with ID {doc_ref.id} added.")

Hàm "thêm tin nhắn" là một điểm cuối HTTP. Mọi yêu cầu đến điểm cuối dẫn đến các đối tượng yêu cầu và phản hồi được truyền đến trình xử lý yêu cầu cho nền tảng của bạn (onRequest() hoặc on_request).

Các hàm HTTP là đồng bộ (tương tự như các hàm có thể gọi), vì vậy, bạn nên gửi phản hồi càng nhanh càng tốt và trì hoãn công việc bằng Cloud Firestore. Hàm HTTP "thêm tin nhắn" truyền một giá trị văn bản đến điểm cuối HTTP và chèn giá trị đó vào cơ sở dữ liệu theo đường dẫn /messages/:documentId/original.

Thêm hàm "chuyển thành chữ hoa"

Đối với hàm "chuyển thành chữ hoa", hãy thêm các dòng sau vào tệp nguồn:

Node.js

// Listens for new messages added to /messages/:documentId/original
// and saves an uppercased version of the message
// to /messages/:documentId/uppercase
exports.makeuppercase = onDocumentCreated("/messages/{documentId}", (event) => {
  // Grab the current value of what was written to Firestore.
  const original = event.data.data().original;

  // Access the parameter `{documentId}` with `event.params`
  logger.log("Uppercasing", event.params.documentId, original);

  const uppercase = original.toUpperCase();

  // You must return a Promise when performing
  // asynchronous tasks inside a function
  // such as writing to Firestore.
  // Setting an 'uppercase' field in Firestore document returns a Promise.
  return event.data.ref.set({uppercase}, {merge: true});
});

Python

@firestore_fn.on_document_created(document="messages/{pushId}")
def makeuppercase(event: firestore_fn.Event[firestore_fn.DocumentSnapshot | None]) -> None:
    """Listens for new documents to be added to /messages. If the document has
    an "original" field, creates an "uppercase" field containg the contents of
    "original" in upper case."""

    # Get the value of "original" if it exists.
    if event.data is None:
        return
    try:
        original = event.data.get("original")
    except KeyError:
        # No "original" field, so do nothing.
        return

    # Set the "uppercase" field.
    print(f"Uppercasing {event.params['pushId']}: {original}")
    upper = original.upper()
    event.data.reference.update({"uppercase": upper})

Hàm "chuyển thành chữ hoa" thực thi khi Cloud Firestore được ghi vào, xác định tài liệu để theo dõi. Vì lý do hiệu suất, bạn nên mô tả càng cụ thể càng tốt.

Dấu ngoặc nhọn (ví dụ: {documentId}) bao quanh "tham số", ký tự đại diện hiển thị dữ liệu được so khớp trong lệnh gọi lại. Cloud Firestore kích hoạt lệnh gọi lại bất cứ khi nào có tin nhắn mới được thêm.

Trong Node.js, các hàm dựa trên sự kiện như sự kiện Cloud Firestore là không đồng bộ. Hàm callback phải trả về null, Đối tượng, hoặc một Promise. Nếu bạn không trả về gì, hàm sẽ hết thời gian chờ, báo hiệu lỗi và được thử lại. Xem phần Đồng bộ, Không đồng bộ và Promise.

Mô phỏng quá trình thực thi các hàm

Firebase Local Emulator Suite cho phép bạn tạo và kiểm thử ứng dụng trên máy cục bộ thay vì triển khai vào một dự án Firebase. Bạn nên kiểm thử cục bộ trong quá trình phát triển, một phần là vì việc này giúp giảm nguy cơ từ các lỗi lập trình có thể phát sinh chi phí trong môi trường sản xuất (ví dụ: vòng lặp vô hạn).

Cách mô phỏng các hàm:

  1. Chạy firebase emulators:start và kiểm tra đầu ra cho URL của Emulator Suite UI. Giá trị mặc định là localhost:4000, nhưng có thể được lưu trữ trên một cổng khác trên máy của bạn. Nhập URL đó vào trình duyệt để mở Emulator Suite UI.

  2. Kiểm tra đầu ra của lệnh firebase emulators:start cho URL của hàm HTTP. URL này sẽ có dạng tương tự như http://localhost:5001/MY_PROJECT/us-central1/addMessage, ngoại trừ:

    1. MY_PROJECT sẽ được thay thế bằng mã dự án của bạn.
    2. Cổng có thể khác trên máy cục bộ của bạn.
  3. Thêm chuỗi truy vấn ?text=uppercaseme vào cuối URL của hàm. URL này sẽ có dạng như sau: http://localhost:5001/MY_PROJECT/us-central1/addMessage?text=uppercaseme. Bạn có thể thay đổi thông báo "uppercaseme" thành một thông báo tuỳ chỉnh message.

  4. Tạo một tin nhắn mới bằng cách mở URL trong một thẻ mới trong trình duyệt.

  5. Xem hiệu ứng của các hàm trong Emulator Suite UI:

    1. Trong thẻ Nhật ký, bạn sẽ thấy nhật ký mới cho biết các hàm HTTP đã chạy thành công:

      i functions: Beginning execution of "addMessage"

      i functions: Beginning execution of "makeUppercase"

    2. Trong thẻ Firestore, bạn sẽ thấy một tài liệu chứa tin nhắn gốc cũng như phiên bản chữ hoa của tin nhắn (nếu tin nhắn gốc là "uppercaseme", bạn sẽ thấy "UPPERCASEME").

Triển khai các hàm vào môi trường phát hành công khai

Sau khi các hàm hoạt động như mong muốn trong trình mô phỏng, bạn có thể tiến hành triển khai, kiểm thử và chạy các hàm đó trong môi trường sản xuất. Xin lưu ý rằng để triển khai trong môi trường sản xuất, dự án của bạn phải sử dụng gói giá Blaze. Xem Cloud Functions giá.

Để hoàn tất hướng dẫn này, hãy triển khai các hàm rồi thực thi các hàm đó.

  1. Chạy lệnh này để triển khai các hàm:

     firebase deploy --only functions
     

    Sau khi bạn chạy lệnh này, Firebase CLI sẽ xuất URL cho mọi điểm cuối hàm HTTP. Trong thiết bị đầu cuối, bạn sẽ thấy một dòng như sau:

    Function URL (addMessage): https://us-central1-MY_PROJECT.cloudfunctions.net/addMessage
    

    URL chứa mã dự án cũng như một khu vực cho hàm HTTP. Mặc dù bạn không cần lo lắng về vấn đề này ngay bây giờ, nhưng một số hàm HTTP phát hành công khai nên chỉ định một vị trí để giảm thiểu độ trễ mạng.

    Nếu bạn gặp lỗi truy cập như "Không thể cho phép truy cập vào dự án," hãy thử kiểm tra bí danh dự án.

  2. Sử dụng đầu ra URL của CLI, thêm tham số truy vấn văn bản, và mở tham số đó trong trình duyệt:

    https://us-central1-MY_PROJECT.cloudfunctions.net/addMessage?text=uppercasemetoo
    

    Hàm thực thi và chuyển hướng trình duyệt đến Firebase bảng điều khiển tại vị trí cơ sở dữ liệu nơi chuỗi văn bản được lưu trữ. Sự kiện ghi này kích hoạt hàm "chuyển thành chữ hoa", hàm này ghi phiên bản chữ hoa của chuỗi.

Sau khi triển khai và thực thi các hàm, bạn có thể xem nhật ký trong bảng điều khiển Google Cloud. Nếu cần xoá các Functions trong quá trình phát triển hoặc phát hành công khai, hãy sử dụng Firebase CLI.

Trong môi trường sản xuất, bạn có thể muốn tối ưu hoá hiệu suất hàm và kiểm soát chi phí bằng cách đặt số lượng tối thiểu và tối đa của các thực thể để chạy. Xem phần Kiểm soát hành vi mở rộng quy mô để biết thêm thông tin về các tuỳ chọn thời gian chạy này.

Các bước tiếp theo

Trong tài liệu này, bạn có thể tìm hiểu thêm về cách quản lý các hàm cho Cloud Functions cũng như cách xử lý tất cả các loại sự kiện được Cloud Functionshỗ trợ.

Để tìm hiểu thêm về Cloud Functions, bạn cũng có thể làm như sau: