Sắp xếp nhiều hàm

Khi bạn tích hợp Chức năng đám mây vào dự án, mã của bạn có thể mở rộng để chứa nhiều chức năng độc lập. Bạn có thể có quá nhiều chức năng cần đưa vào một tệp duy nhất hoặc các nhóm khác nhau có thể triển khai các nhóm chức năng khác nhau, dẫn đến nguy cơ một nhóm ghi đè hoặc vô tình xoá chức năng của nhóm khác. Chức năng đám mây cung cấp nhiều cách để sắp xếp mã nhằm giúp bạn dễ dàng điều hướng và duy trì các hàm của mình.

Sắp xếp các hàm trong cơ sở mã

Bạn có thể sử dụng thuộc tính codebase của đối tượng cấu hình hàm trong firebase.json để quản lý một tập hợp lớn các hàm trên nhiều kho lưu trữ hoặc gói con trong một chế độ thiết lập monorepo kho lưu trữ duy nhất:

# firebase.json
"functions": {
  "codebase": "my-codebase"
  # NOTE: Codebase must be less than 63 characters and can contain only
  # lowercase letters, numeric characters, underscores, and dashes.
}

Thuộc tính codebase được hỗ trợ trong Firebase CLI phiên bản 10.7.1 trở lên.

Quản lý nhiều kho lưu trữ

Thuộc tính codebase có thể giúp đơn giản hoá việc quản lý nhiều kho lưu trữ. Hãy cùng tìm hiểu trường hợp bạn có hai kho lưu trữ khác nhau để triển khai các chức năng cho cùng một dự án Firebase:

$  tree .
├── repoA
│   ├── firebase.json
│   └── functions
│       ├── index.js
│       └── package.json
└── repoB
    ├── firebase.json
    └── functions
        ├── index.js
        └── package.json

Nếu không có chú giải cơ sở mã, Giao diện dòng lệnh (CLI) của Firebase sẽ nhắc bạn xoá các hàm được xác định trong kho lưu trữ khác tại thời điểm triển khai:

$ (cd repoA && firebase deploy --only functions)
...
i  functions: preparing functions directory for uploading...
✔  functions: functions folder uploaded successfully
The following functions are found in your project but do not exist in your local source code:
        fn1FromRepoB
        fn2FromRepoB
        ...
? Would you like to proceed with deletion? Selecting no will continue the rest of the deployments. (y/N)

Bạn có thể tránh vấn đề này bằng cách thêm một chú giải cơ sở mã duy nhất vào phần cấu hình hàm của firebase.json trong mỗi kho lưu trữ dự án:

# repoA/firebase.json
"functions": {
  "codebase": "repo-a"
}

# repoB/firebase.json
"functions": {
  "codebase": "repo-b"
}

Với chú thích cơ sở mã, Giao diện dòng lệnh (CLI) của Firebase không còn nhắc bạn xoá các hàm được xác định bên ngoài kho lưu trữ tức thì của bạn:

$ (cd repoA && firebase deploy --only functions)
...
i  functions: preparing functions directory for uploading...
✔  functions: functions folder uploaded successfully
#  Gleefully ignores functions from repoB
i  functions: creating Node.js 16 function fnFromRepoA (us-central1)...
✔  Deploy Complete!

Quản lý nhiều gói nguồn (monorepo)

Thuộc tính codebase có thể giúp đơn giản hoá việc quản lý nhiều gói nguồn trong một kho lưu trữ. Hãy kiểm tra một trường hợp mà bạn có thư mục dự án firebase với các định nghĩa hàm được trải rộng trên nhiều gói con:

$  tree .
├── firebase.json
├── teamA
│   ├── index.js
│   └── package.json
└── teamB
    ├── index.js
    └── package.json

Cách thiết lập này phù hợp với các trường hợp sử dụng sau:

• Bạn đã thiết lập monorepo và có các nhóm khác nhau quản lý các định nghĩa chức năng của riêng họ trong một gói riêng biệt.
• Bạn có một hàm có phần phụ thuộc lớn bên ngoài và quá trình khởi chạy diễn ra trong thời gian dài. Bạn muốn tách biệt hàm đó với các hàm khác nhạy cảm về độ trễ.

Để hỗ trợ thiết lập monrepo như thế này, hãy xác định nhiều cấu hình hàm trong firebase.json:

"functions": [
  {
    "source": "teamA",
    "codebase": "team-a"
  },
  {
    "source": "teamB",
    "codebase": "team-b"
  },
]

Với cấu hình này, Giao diện dòng lệnh (CLI) của Firebase triển khai hàm từ tất cả các gói thông qua một lệnh triển khai duy nhất:

$ firebase deploy --only functions
i  deploying functions
i  functions: preparing codebase team-a for deployment
i  functions: preparing codebase team-b for deployment
i  functions: creating Node.js 16 function team-a:helloATeam(us-central1)...
i  functions: creating Node.js 16 function team-b:helloBTeam(us-central1)...
...

Bạn cũng có thể triển khai một cơ sở mã cụ thể:

$ firebase deploy --only functions:team-b
i  deploying functions
i  functions: preparing codebase team-b for deployment
i  functions: updating Node.js 16 function team-b:helloBTeam(us-central1)...
...

Viết các hàm trong nhiều tệp

Khi bắt đầu sử dụng Chức năng đám mây, bạn có thể đặt một số hàm đầu tiên vào một tệp duy nhất:

const functions = require('firebase-functions');
exports.foo = functions.https.onRequest((request, response) => {
  // ...
});
exports.bar = functions.https.onRequest((request, response) => {
  // ...
});

from firebase_functions import https_fn

@https_fn.on_request()
def foo(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello foo!")

@https_fn.on_request()
def bar(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello bar!")

Việc sử dụng quá một vài chức năng có thể gây khó khăn cho việc quản lý. Thay vào đó, bạn có thể đặt tất cả logic cho từng hàm vào tệp riêng và sử dụng tệp nguồn làm danh sách dữ liệu xuất:

const functions = require('firebase-functions');
exports.foo = functions.https.onRequest((request, response) => {
  // ...
});

const functions = require('firebase-functions');
exports.bar = functions.https.onRequest((request, response) => {
  // ...
});

const foo = require('./foo');
const bar = require('./bar');
exports.foo = foo.foo;
exports.bar = bar.bar;

from firebase_functions import https_fn

@https_fn.on_request()
def foo(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello foo!")

from firebase_functions import https_fn

@https_fn.on_request()
def bar(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello foo!")

from fn_impl.foo import *
from fn_impl.bar import *

my-project
├── firebase.json
└── functions
    ├── fn_impl
    │   ├── __init__.py
    │   ├── foo.py
    │   └── bar.py
    ├── main.py
    └── requirements.txt

Hàm nhóm

Trong nhiều dự án, các hàm có thể được phân tách thành các nhóm logic cần được triển khai và duy trì cùng nhau. Ví dụ: bạn có thể có một nhóm hàm dùng để báo cáo các chỉ số:

metrics.js

const functions = require('firebase-functions');
exports.usageStats = functions.https.onRequest((request, response) => {
  // ...
});
exports.nightlyReport = functions.https.onRequest((request, response) => {
  // ...
});

Bạn có thể đặt các hàm này vào một nhóm khi xuất chúng trong tệp index.js:

index.js

// Export both functions from metrics.js in the "metrics" group:
//  - metrics-usageStats
//  - metrics-nightlyReport
exports.metrics = require('./metrics');

Khi được triển khai, các hàm sẽ có tiền tố là tên của nhóm. Vì vậy, trong ví dụ này, các hàm sẽ có tên là metrics-usageStats và metrics-nightlyReport.

Khi triển khai các hàm, bạn có thể giới hạn thao tác cho một nhóm:

firebase deploy --only functions:metrics

Các bước tiếp theo

Để tìm hiểu thêm về Chức năng đám mây, hãy xem:

• Xử lý phần phụ thuộc.
• Quản lý việc triển khai hàm và các tuỳ chọn thời gian chạy.