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 Chức năng đám mây, hãy thử làm theo hướng dẫn này. Phần hướng dẫn này bắt đầu từ các tác vụ thiết lập bắt buộc, cho đến việc tạo, kiểm thử và triển khai hai chức năng liên quan:

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

Chúng tôi đã chọn Cloud Firestore và các hàm JavaScript được kích hoạt qua HTTP cho mẫu này một phần vì bạn có thể kiểm thử kỹ lưỡng các điều kiện kích hoạt trong nền này thông qua Bộ công cụ mô phỏng cục bộ 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à điều kiện kích hoạt có thể gọi HTTP. Các loại điều kiện kích hoạt trong nền khác như Cấu hình từ xa, Phòng thí nghiệm và điều kiện kích hoạt Analytics đều có thể được kiểm thử theo cách tương tác bằng cách sử dụng các bộ 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 và kiểm tra mã, hãy chuyển đến phần Xem lại mã mẫu hoàn chỉnh.

Tạo 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 Google Cloud hiện có, hãy nhập tên dự án hoặc chọn dự án đó trên trình đơn thả xuống.

    • Để tạo 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, giúp bạn có đượ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à các đ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 một dự án hiện có trên Google Cloud).

Firebase tự động cấp phép các 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à Giao diện dòng lệnh (CLI) của Firebase

Bạn sẽ cần có môi trường Node.js để viết các hàm và cần có Giao diện dòng lệnh (CLI) của Firebase để triển khai các hàm cho thời gian chạy Chức năng đám mây. Để 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 bạn muốn dùng. Để cài đặt CLI qua npm, hãy dùng:

npm install -g firebase-tools

Thao tác này sẽ cài đặt lệnh firebase có thể sử dụng 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 mới nhất của firebase-tools, hãy chạy lại cùng một lệnh đó.

Khởi chạy dự án của bạn

Khi khởi chạy Firebase SDK cho Chức năng đám mây, 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 chọn TypeScript hoặc JavaScript cho các hàm kết hợp. Để phục vụ mục đích 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 qua trình duyệt và xác thực Giao diện dòng lệnh (CLI) của Firebase.
  2. Chuyển đến thư mục dự án Firebase của bạn.
  3. Chạy firebase init firestore. Trong 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 chưa sử dụng Cloud Firestore trong dự án này, bạn cũng cần chọn chế độ khởi động 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 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 nên 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ữ:

    Để xem 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 với 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 thì bạn sẽ 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, 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 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 chức năng đám mây và mô-đun SDK quản trị bằng cách sử dụng câu lệnh của Nút require. 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();

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

Firebase CLI tự động cài đặt Firebase và Firebase SDK cho các mô-đun Nút chức năng đá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.` });
});

Hàm addMessage() là một điểm cuối HTTP. Mọi yêu cầu đến kết quả điểm cuối trong các đối tượng Request (Yêu cầu) và Response (Phản hồi) kiểu ExpressJS, đều đượ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 một phản hồi nhanh nhất có thể và trì hoãn công việc bằng cách sử dụ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 });
  });

Hàm makeUppercase() thực thi khi Cloud Firestore được ghi vào. Hàm ref.set xác định tài liệu để nghe. Vì lý do về hiệu suất, bạn nên trả lời càng cụ thể càng tốt.

Dấu ngoặc nhọn (ví dụ: {documentId}) là ký tự đại diện "tham số" bao quanh sẽ hiển thị dữ liệu trùng 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ư các sự kiện Cloud Firestore không đồng bộ. Hàm callback sẽ trả về một null, một Object hoặc Promise. Nếu bạn không trả về giá trị nào, hàm sẽ hết thời gian chờ, báo hiệu lỗi và sẽ được thử lại. Xem phần Đồng bộ hóa, không đồng bộ và hứa hẹn.

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

Bộ công cụ mô phỏng cục bộ Firebase cho phép bạn xây dựng và kiểm thử các ứng dụng trên máy cục bộ của mình thay vì triển khai cho 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 vì nó giúp giảm rủi ro do lỗi lập trình có thể gây ra 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 hàm:

  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. Tệp 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 để 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(). Tệp này sẽ có dạ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 có thể khác trên máy cục bộ.
  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. Nếu muốn, bạn có thể thay đổi thông báo "chữ hoa" thành một thông báo tuỳ chỉnh.

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

  5. Xem hiệu ứng của các hàm trong giao diện người dùng của Emulator Suite:

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

      i functions: Beginning execution of "addMessage"

      i functions: Beginning execution of "makeUppercase"

    2. Trong thẻ Firestore, bạn sẽ thấy tài liệu chứa thông báo gốc cũng như phiên bản viết hoa của thông báo (nếu ban đầu là "chữ hoa", bạn sẽ thấy "ví dụ

Triển khai hàm trong môi trường sản xuất

Sau khi các chức năng của bạn 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 đang sử dụng Gói giá linh hoạt. Xem giá của Cloud Functions.

Để hoàn tất phần 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, Giao diện dòng lệnh (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ủa bạn cũng như một khu vực cho hàm HTTP. Mặc dù hiện tại bạn không cần phải lo lắng về điều này, nhưng một số hàm HTTP thực tế nên chỉ định vị trí để giảm thiểu độ trễ mạng.

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

  2. Sử dụng kết quả URL addMessage() do CLI cung cấp, 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 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. Sự kiện ghi này kích hoạt makeUppercase(), sự kiện này sẽ viết phiên bản viết 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 bạn cần xoá hàm đang trong quá trình phát triển hoặc chính thức, hãy sử dụng Firebase CLI.

Trong phiên bản chính thức, bạn nê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 sẽ chạy. Hãy xem phần Kiểm soát hành vi điều chỉnh theo 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

Dưới đây là functions/index.js đã hoàn chỉnh, chứa các hàm addMessage()makeUppercase(). Các hàm này cho phép bạn truyền một tham số đến một điểm cuối HTTP sẽ ghi giá trị vào Cloud Firestore, sau đó biến đổi thông số đó bằng cách viết hoa tất 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 });
  });

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

Để tìm hiểu thêm về Chức năng đám mây, bạn cũng có thể làm như sau: