如何在GCP NodeJS Cloud Functions中最优共享通用模块？

1. 打包为私有npm包 #

将通用代码封装成独立的npm包，发布到GCP Artifact Registry的私有npm仓库中。每个Cloud Functions项目只需在package.json中声明该包为依赖，部署时会自动拉取并安装。

• 操作要点：
  • 初始化npm包：在通用代码目录执行npm init，完善包信息
  • 配置Artifact Registry npm仓库：在项目根目录添加.npmrc文件，指向GCP的私有仓库地址
  • 发布包：执行npm publish完成上传
  • 函数项目中安装：npm install @your-gcp-project/your-common-lib，之后即可通过require('@your-gcp-project/your-common-lib')引用

2. 使用Cloud Functions层（Layers） #

利用GCP Cloud Functions的层功能，将通用代码打包为共享层，多个函数可关联同一层复用代码。

• 操作要点：
  • 按规范组织层目录：创建nodejs/node_modules/your-common-code结构，将通用代码放入对应目录
  • 打包为zip：将nodejs目录打包成zip文件（注意不要包含外层文件夹）
  • 上传层：在GCP控制台或通过gcloud命令上传zip为新层
  • 关联函数：创建或更新函数时，选择该层作为依赖，代码中直接require('your-common-code')即可引用（层代码挂载在/opt/nodejs/node_modules）

3. Git子模块管理（团队协作场景） #

若所有Cloud Functions代码通过Git管理，可将通用代码放在独立Git仓库，通过Git子模块引入到各个函数项目中。

• 操作要点：
  • 创建通用代码独立仓库：将复用代码提交到单独的Git仓库
  • 引入子模块：在函数项目根目录执行git submodule add <通用仓库地址> ./common
  • 部署同步：部署时Git会自动拉取子模块最新代码，函数中通过相对路径require('./common')引用

内容的提问来源于stack exchange，提问作者shary.sharath