指定 Node.js 依赖项

函数可以使用外部 Node.js 模块以及本地数据。Node.js 中的依赖项可通过 npm 进行管理,并在名为 package.json 的元数据文件中表示。Cloud Functions Node.js 运行时环境通常支持使用 npmyarn 进行安装。

要为您的函数指定依赖项,请将依赖项添加到 package.json 文件中。

在此示例中,package.json 文件中列出了一个依赖项:

{
  "dependencies": {
    "escape-html": "^1.0.3"
  }
}

此依赖项随后被导入函数中:

const escapeHtml = require('escape-html');

/**
 * HTTP Cloud Function.
 *
 * @param {Object} req Cloud Function request context.
 *                     More info: https://expressjs.com/en/api.html#req
 * @param {Object} res Cloud Function response context.
 *                     More info: https://expressjs.com/en/api.html#res
 */
exports.helloHttp = (req, res) => {
  res.send(`Hello ${escapeHtml(req.query.name || req.body.name || 'World')}!`);
};

使用 npm 在本地安装 Node.js 模块

要在本地安装 Node.js 模块,最简单的方法是在包含您的 Cloud Functions 函数的文件夹中使用 npm install 命令。例如,以下命令将添加 uuid 模块:

npm install uuid

此命令会执行两个步骤:

  1. 将该模块的最新版本作为依赖项添加到 package.json 文件中。这一点很重要:Cloud Functions 仅安装已在您的 package.json 文件中声明的模块。
  2. 将该模块下载到 node_modules 目录中。这样您便可以在本地开发时使用该模块。

如果您的机器上未安装 npm,请获取 npm

配置部署依赖项

使用 npm 安装生产依赖项

部署您的函数后,Cloud Functions 会使用 npm install 命令安装 package.json 文件中声明的依赖项。

npm install --production

在 Node.js 8 运行时及更高版本中,如果存在 yarn.lock 文件,则 Cloud Functions 会改用 yarn install 命令:

yarn install --production

在部署期间执行自定义构建步骤

部署后,在函数构建过程中,您可以通过在 package.json 文件中添加 gcp-build 脚本来执行自定义构建步骤。

执行此脚本时,可以使用 package.json 文件的 dependenciesdevDependencies 字段中的依赖项。执行自定义构建步骤后,Cloud Functions 仅安装 package.json 文件的 dependencies 字段中声明的生产依赖项,以移除并重新生成 node_modules 文件夹。

如果 package.json 中没有 gcp-build 脚本,则 Cloud Functions 仅安装生产依赖项。

使用系统软件包

Node.js 运行时还会在执行环境中添加多个系统软件包。如果您的函数使用的依赖项需要未列出的软件包,您可以请求添加软件包

包括本地 Node.js 模块

您还可以将本地 Node.js 模块作为函数的一部分。要实现此目的,您可在 package.json 中使用 file: 前缀声明相关模块。在以下示例中,mymodule 引用您的模块名称,而 mymoduledir 是包含您的模块的目录:

{
  "dependencies": {
    "mymodule": "file:mymoduledir"
  }
}

此本地模块的代码应存储在函数根目录内的 node_modules 文件夹之外。

加载 Node.js 模块

使用 Node.js require() 函数加载已安装的任何 Node.js 模块。您还可以使用 require() 函数导入与您的函数一起部署的本地文件。

使用私有模块

若要使用私有 npm 模块,您必须在位于函数目录下的 .npmrc 文件中提供 npm 注册表所对应的凭据(身份验证令牌)。npm 文档说明了如何创建自定义只读访问令牌。我们不建议使用在主目录中创建的 .npmrc 文件,因为它包含读写令牌。部署期间不需要写入权限,写入权限可能会带来安全风险。

如果您未使用私有代码库,请勿添加 .npmrc 文件,因为该文件可能会延长函数的部署时间。

文件格式

如果您使用 .npmrc 文件设置自定义身份验证令牌,则应包含下面所示的一行内容。将 <YOUR_AUTH_TOKEN> 替换为 NPM 提供的身份验证令牌。

//registry.npmjs.org/:_authToken=<YOUR_AUTH_TOKEN>