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, bắt đầu từ các thao tác thiết lập bắt buộc và trải qua quá trình tạo, kiểm thử và triển khai 2 chức năng có liên quan:

  • Hàm "add message" (thêm thông báo) 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 "viết hoa" kích hoạt khi Cloud Firestore ghi và chuyển đổi văn bản thành chữ hoa.

Chúng tôi đã chọn các hàm JavaScript được kích hoạt bởi Cloud Firestore và HTTP cho mẫu này một phần vì các điều kiện kích hoạt ở chế độ nền này có thể được kiểm thử kỹ lưỡng thông qua Bộ trình mô phỏng cục bộ của Firebase. Bộ công cụ này cũng hỗ trợ Cơ sở dữ liệu theo thời gian thực, PubSub, Xác thực và các điều kiện kích hoạt có thể gọi HTTP. Tất cả các loại điều kiện kích hoạt trong nền khác như Cấu hình từ xa, TestLab và Analytics đều có thể được kiểm thử theo cách tương tác bằng cách sử dụng các tập hợp công cụ không được mô tả trong trang này.

Các phần sau 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. Nếu bạn chỉ muốn chạy mã và kiểm tra, hãy chuyển đến phần Xem lại mã mẫu hoàn chỉnh.

Tạo một dự án Firebase

  1. Trong bảng điều khiển của Firebase, hãy nhấp vào Thêm dự án.

    • Để thêm tài nguyên Firebase vào một dự án hiện có trên Google Cloud, hãy nhập tên dự án hoặc chọn tên dự án đó trong trình đơn thả xuống.

    • Để tạo một dự án mới, hãy nhập tên dự án mà bạn muốn. Bạn cũng có thể tuỳ ý chỉnh sửa mã dự án xuất hiện bên dưới tên dự án.

  2. Nếu được nhắc, hãy xem xét và chấp nhận các điều khoản của Firebase.

  3. Nhấp vào Tiếp tục.

  4. (Không bắt buộc) Thiết lập Google Analytics cho dự án của bạn để có thể có trải nghiệm tối ưu khi sử dụng bất kỳ sản phẩm Firebase nào sau đây:

    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 chế độ cài đặt cách chia sẻ dữ liệu và điều khoản của Google Analytics cho dự án của bạn.

  5. Nhấp vào Tạo dự án (hoặc Thêm Firebase, nếu bạn đang sử dụng dự án hiện có trên Google Cloud).

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

Thiết lập Node.js và Firebase CLI

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 trong thời gian chạy Cloud Functions. Để cài đặt Node.js và npm, bạn nên sử dụng Trình quản lý phiên bản nút.

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

npm install -g firebase-tools

Thao tác này sẽ cài đặt lệnh Firebase có sẵn trên toàn cầu. Nếu lệnh này 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 lệnh đó.

Khởi chạy dự án

Khi khởi chạy 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, đồng thời bạn sẽ chọn TypeScript hoặc JavaScript để kết hợp các hàm. Trong phạm vi của hướng dẫn này, bạn cũng cần khởi chạy Cloud Firestore.

Cách khởi chạy dự án:

  1. Chạy firebase login để đăng nhập thông qua trình duyệt và xác thực CLI Firebase.
  2. Chuyển đến thư mục dự án Firebase của bạn.
  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 trên Firestore. Nếu chưa sử dụng Cloud Firestore trong dự án này, bạn cũng cần chọn chế độ và vị trí bắt đầu cho Firestore như mô tả trong bài viết Bắt đầu sử dụng Cloud Firestore.
  4. Chạy firebase init functions. CLI sẽ nhắc bạn chọn cơ sở mã hiện có hoặc khởi chạy và đặt tên cho một cơ sở mã mới. Khi bạn mới bắt đầu, chỉ cần một cơ sở mã ở vị trí mặc định là đủ; sau này, khi quá trình triển khai mở rộng, bạn có thể sắp xếp các hàm trong cơ sở mã.

  5. CLI cung cấp cho bạn hai tuỳ chọn hỗ trợ ngôn ngữ:

    Đối với hướng dẫn này, hãy chọn JavaScript.

  6. CLI cung cấp cho bạn tuỳ chọn cài đặt các phần phụ thuộc có npm. Bạn có thể từ chối nếu muốn quản lý các phần phụ thuộc theo cách khác. Tuy nhiên, nếu từ chối, bạn cần chạy npm install trước khi mô phỏng hoặc triển khai các hàm.

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ẽ có dạng như sau:

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

Tệp package.json được tạo trong quá trình khởi chạy chứa một khoá quan trọng: "engines": {"node": "16"}. Thao tác này sẽ 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.

Nhập các mô-đun bắt buộc và khởi chạy ứ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 Hàm đám mây và SDK quản trị bằng cách sử dụng câu lệnh require của Nút. Thêm các dòng như sau vào tệp index.js:

// The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
const functions = require('firebase-functions/v1');

// The Firebase Admin SDK to access Firestore.
const admin = require("firebase-admin");
admin.initializeApp();
index.js

Các dòng này tải các mô-đun firebase-functions và firebase-admin, đồng thời khởi động một thực thể ứng dụng admin mà từ đó bạn có thể thực hiện các thay đổi trên Cloud Firestore. Bất cứ khi nào có dịch vụ hỗ trợ SDK dành cho quản trị viên, chẳng hạn như cho FCM, Xác thực và Cơ sở dữ liệu theo thời gian thực của Firebase, tính năng này sẽ mang đến một cách hiệu quả để tích hợp Firebase bằng Cloud Functions.

Firebase CLI sẽ tự động cài đặt Firebase và SDK Firebase cho các mô-đun Nút đám mây khi bạn khởi chạy dự án. Để thêm thư viện của bên thứ ba vào dự án, bạn có thể sửa đổi package.json và chạy npm install. Để biết thêm thông tin, hãy xem bài viết Xử lý phần phụ thuộc.

Thêm hàm addMessage()

Đối với hàm addMessage(), hãy thêm các dòng sau vào index.js:

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addMessage = functions.https.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 admin
    .firestore()
    .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.` });
});
index.js

Hàm addMessage() là một điểm cuối HTTP. Bất kỳ yêu cầu nào đến điểm cuối đều dẫn đến các đối tượng Yêu cầu và Phản hồi kiểu ExpressJS, được truyền đến lệnh gọi lại onRequest().

Các hàm HTTP có tính đồ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 nhanh nhất có thể và trì hoãn công việc bằng Cloud Firestore. Hàm HTTP addMessage() 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 makeUppercase()

Đối với hàm makeUppercase(), hãy thêm các dòng sau vào index.js:

// Listens for new messages added to /messages/:documentId/original and creates an
// uppercase version of the message to /messages/:documentId/uppercase
exports.makeUppercase = functions.firestore
  .document("/messages/{documentId}")
  .onCreate((snap, context) => {
    // Grab the current value of what was written to Firestore.
    const original = snap.data().original;

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

    const uppercase = original.toUpperCase();

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

Hàm makeUppercase() thực thi khi được ghi vào Cloud Firestore. Hàm ref.set xác định tài liệu cần nghe. Vì lý do liên quan đến hiệu suất, bạn nên đưa ra thông tin 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 đã so khớp trong lệnh gọi lại.

Cloud Firestore kích hoạt lệnh gọi lại onCreate() mỗi khi có tin nhắn mới được thêm.

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

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

Bộ mô phỏng cục bộ Firebase 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 cho 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 vì tính năng này giúp giảm rủi ro 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ụ: một vòng lặp vô hạn).

Cách mô phỏng các hàm của bạn:

  1. Chạy firebase emulators:start và kiểm tra kết quả cho URL của giao diện người dùng Bộ mô phỏng. Thuộc tính này 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 của bạn để mở giao diện người dùng của Bộ mô phỏng.

  2. Kiểm tra kết quả của lệnh firebase emulators:start cho URL của hàm HTTP addMessage(). Thao tác này sẽ giống 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 trên máy cục bộ có thể khác.

  3. Thêm chuỗi truy vấn ?text=uppercaseme vào cuối URL của hàm. Mã 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 thông báo tuỳ chỉnh (không bắt buộc).

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

  5. Xem hiệu ứng của các hàm trong giao diện người dùng của Bộ mô phỏng:

    1. Trong thẻ Logs (Nhật ký), bạn sẽ thấy các nhật ký mới cho biết các hàm addMessage() và makeUppercase() đã chạy:

      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 thư gốc cũng như phiên bản được viết hoa của thư (nếu ban đầu thư được viết hoa là "chữ hoa", thì bạn sẽ thấy chữ "viết trên CHỮ IN HOA").

Triển khai các chức năng trong môi trường sản xuất

Khi các chức năng 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 chức năng đó trong môi trường phát hành chính thức. Xin lưu ý rằng để triển khai cho môi trường thời gian chạy Node.js 14 được đề xuất, dự án của bạn phải sử dụng Gói giá linh hoạt. Xem giá của Cloud Functions.

Để hoàn tất hướng dẫn, hãy triển khai các hàm rồi thực thi addMessage() để kích hoạt makeUppercase().

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

     firebase deploy --only functions

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

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

    URL này chứa mã dự án cũng như một khu vực dành 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 chính thức cần chỉ định một location (vị trí) để giảm thiểu độ trễ mạng.

    Nếu bạn gặp lỗi truy cập, chẳng hạn như "Không thể uỷ quyền truy cập vào dự án", hãy thử kiểm tra tình trạng chồng phổ của dự án.

  2. Sử dụng URL addMessage() do CLI xuất ra, thêm một tham số truy vấn văn bản rồi mở tham số đó trong trình duyệt:

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

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

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

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

Xem lại mã mẫu hoàn chỉnh

Đây là functions/index.js đã hoàn chỉnh chứa các hàm addMessage() và makeUppercase(). Các hàm này cho phép bạn chuyển một thông số đến điểm cuối HTTP để ghi giá trị vào Cloud Firestore, sau đó chuyển đổi thông số đó bằng cách viết hoa tất cả các ký tự trong chuỗi.

// The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
const functions = require('firebase-functions/v1');

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

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addMessage = functions.https.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 admin
    .firestore()
    .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 creates an
// uppercase version of the message to /messages/:documentId/uppercase
exports.makeUppercase = functions.firestore
  .document("/messages/{documentId}")
  .onCreate((snap, context) => {
    // Grab the current value of what was written to Firestore.
    const original = snap.data().original;

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

    const uppercase = original.toUpperCase();

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

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ý hàm cho Cloud Functions cũng như cách xử lý tất cả các loại sự kiện mà Cloud Functions hỗ trợ.

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