管理云函数

最近更新时间:2020-05-06 17:33:32

本文档主要指导您如何通过云开发控制台、CLI 和微信小程序开发者工具管理云函数。

云开发控制台

新建云函数

登录腾讯云 云开发控制台,单击需要开通云函数的环境,单击左侧菜单栏【云函数】,进入云函数页面,单击 【新建云函数】,填写函数名并确定即创建并部署成功。

删除云函数

在函数列表的操作列,单击【删除】即可删除该函数。删除云函数不可恢复,并且删除后即不可访问,请谨慎操作。
若此环境为微信侧创建环境,则无法在腾讯云云开发控制台进行函数的删除。

更改云函数超时时间

在函数列表的操作列,单击要操作的云函数名称。进入函数配置页。单击右上角【编辑】进入编辑模式,可以更改云函数的超时时间,默认时间为20s,最大值为20s,为保证前端体验,可以根据需要调整。

添加云函数环境变量

云函数环境变量可以在您的代码中直接读取,如在 Node.js 中使用 process.env 操作。

更新函数代码并部署

您可以在控制台网页上编辑入口文件代码,或者在您的 IDE 里书写代码并将相关代码压缩成 zip 包在控制台上传并部署。
若此环境为微信侧创建环境,则无法在腾讯云云开发控制台进行编辑,只能在 IDE 中进行代码编辑及部署。

云开发 CLI

使用 命令行工具(CLI) 可以方便的完成云函数的所有管理操作,目前支持的命令行如下:

functions:list [options]                                         展示云函数列表
  functions:download [options] <functionName> [dest]               下载云函数代码
  functions:deploy [options] [functionName]                        部署云函数
  functions:delete [options] [functionName]                        删除云函数
  functions:detail [options] [functionName]                        获取云函数信息
  functions:code:update [options] <functionName>                   更新云函数代码
  functions:config:update [options] [functionName]                 更新云函数配置
  functions:copy [options] <functionName> <newFunctionName>        拷贝云函数
  functions:log [options] <functionName>                           打印云函数日志
  functions:trigger:create [options] [functionName]                创建云函数触发器
  functions:trigger:delete [options] [functionName] [triggerName]  删除云函数触发器
  functions:invoke [options] [functionName]                        触发云端部署的云函数
  functions:run [options]                                          本地运行云函数(当前仅支持 Node)

小程序云开发控制台

配置云函数本地目录

在项目根目录中可以使用 project.config.json 文件,在其中定义 cloudfunctionRoot 字段,指定本地已存在的目录作为云函数的本地根目录。

云函数操作

在云函数根目录或者云函数目录上,通过鼠标右键,我们可以唤出右键菜单,完成以下操作。

  • 查看当前环境。
  • 切换环境。
  • 新建 Node.js 云函数。
  • 下载线上环境的云函数列表。
  • 下载线上环境的云函数代码并覆盖本地。
  • 对比本地代码和线上环境的代码。
  • 上传并部署云函数到线上环境。

查看和切换环境

在云函数根目录上右键,在右键菜单中,可以查看当前对应的环境,同时可以切换环境,后续所有右键菜单都是在这个环境下进行操作。

新建 Node.js 云函数

在云函数根目录上右键,在右键菜单中,可以选择创建一个新的 Node.js 云函数,开发者工具在本地创建出以下目录和文件,同时在线上环境中创建出对应的云函数:

  • 云函数目录:以云函数名字命名的目录,存放该云函数的所有代码
  • index.js:云函数入口文件,云函数被调用时实际执行的入口函数是 index.js 中导出的 main 方法
  • package.json:npm 包定义文件,其中默认定义了最新 wx-server-sdk 依赖

在创建成功后,工具会提示是否为该云函数立即安装本地依赖即 wx-server-sdk,如是,则工具会开启终端执行 npm install

wx-server-sdk 是基于 tcb-admin-node 开发的 服务端 SDK,与小程序端的接口使用方式一致,能获得更一体的开发体验。但如果想获得更高级的功能,可使用 tcb-admin-node

下载云函数列表

在云函数根目录上右键,在右键菜单中,可以将线上环境中的云函数列表同步到本地,开发者工具会根据云函数的名字,在本地中创建出对应的云函数目录。

下载云函数

在一个云函数目录上右键可以在菜单中选择下载该云函数,云函数代码会被下载到指定目录。

上传并部署

在云函数目录上右键,在右键菜单中,我们可以将云函数整体打包上传并部署到线上环境中。

更多设置

通过右键菜单的 “更多设置” 可以进入云函数的沉浸式交互场景,在这个场景里可以完成以上所有的云函数操作,在云目录上按 ctrl 可以进行多选批量操作。

目录