管理多個函式

將 Cloud Functions 整合到專案中時，程式碼可以擴展到包含許多獨立函式。您可能有太多函式，在單一檔案中容納得太多，或者不同團隊可能會部署不同的功能群組，造成一個團隊覆寫或意外刪除其他團隊的職責。Cloud Functions 提供不同的整理程式碼方式，可讓您更輕鬆地瀏覽及維護函式。

整理程式碼集中的函式

您可以在 firebase.json 中使用函式設定物件的 codebase 屬性，在單一存放區單存放區設定中，管理多個存放區或子套件的大量函式：

# 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.
}

Firebase CLI v10.7.1 以上版本支援 codebase 屬性，

管理多個存放區

codebase 屬性有助於簡化多個存放區的管理作業。讓我們看看在下列情況中，您有兩個不同的存放區會將函式部署至同一個 Firebase 專案：

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

如果沒有程式碼集註解，Firebase CLI 會在部署時提示您刪除在其他存放區中定義的函式：

$ (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)

如要避免這個問題，請在每個專案存放區的 firebase.json 函式設定區段中，新增專屬的程式碼集註解：

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

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

透過程式碼集註解，Firebase CLI 不會再提示您刪除直接存放區外定義的函式：

$ (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!

管理多個來源套件 (單聲道)

codebase 屬性有助於簡化在單一存放區中管理多個來源套件的情形。讓我們看看您的 Firebase 專案目錄，且函式定義分散在數個子套件中：

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

這種設定適合下列用途：

• 您擁有 monorepo 設定，而且在獨立的套件中，由不同團隊管理自己的函式定義。
• 您有一個函式具有繁重的外部依附元件，而且需要長時間執行初始化作業，並想將該函式與其他易受延遲影響的函式分開。

如要支援這類 monrepo 設定，請在 firebase.json 中定義多個函式設定：

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

透過這項設定，Firebase CLI 會透過單一部署指令，部署所有套件的函式：

$ 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)...
...

您也可以部署特定的程式碼集：

$ 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)...
...

在多個檔案中寫入函式

開始使用 Cloud Functions 時，您可能會將前幾個函式放在單一檔案中：

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!")

並使用超過幾項功能，可能變得難以管理。您可改為將每個函式的所有邏輯放在各自的檔案中，並將來源檔案做為匯出項目清單：

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

將函式分組

在許多專案中，函式可以分成邏輯群組，這些邏輯群組應一起部署及維護。例如，您可能有一個用於回報指標的函式群組：

metrics.js

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

將這些函式匯出到 index.js 檔案時，您可以把這些函式放入一個群組：

index.js

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

部署後，函式將加上其群組名稱的前置字串，因此在這個範例中，函式的名稱會是 metrics-usageStats 和 metrics-nightlyReport。

部署函式時，您可以將動作限制為單一群組：

firebase deploy --only functions:metrics

後續步驟

如要進一步瞭解 Cloud Functions，請參閱：

• 處理依附元件。
• 管理函式部署和執行階段選項。