HarmonyOS Developer DevEco Studio使用指南-开发云函数
您可以在云侧工程下开发云函数资源,包括创建函数、部署函数。
创建函数
- 右击“cloudfunctions”目录,选择“New > Cloud Function”。
- 输入函数名称后,点击“OK”。
函数名称仅支持小写英文字母、数字、中划线(-),首字符必须为小写字母,结尾不能为中划线(-)。
“cloudfunctions”目录下生成新建的函数目录。
- 配置函数。
- function-config.json:函数的配置文件,可配置触发器。
在“triggers”下配置触发器,云函数目前支持以下5种触发器。
- HTTP触发器
参数 | 说明 |
type | 触发器类型,配置为“http”。 |
enableUriDecode | 触发器是否启用decode。
|
authFlag | 是否鉴权,默认为true。 |
authAlgor | 鉴权算法,默认为HDA-System。 |
authType | HTTP触发器的认证类型。
|
- CLOUDDB触发器
参数 | 说明 |
type | 触发器类型,配置为“clouddb”。 |
eventSourceId | CLOUDDB触发器的数据源。 格式为:项目ID-CloudDB存储区名称-CloudDB对象类型名称,例如“99034201568569469-StorageArea-student”。
|
eventType | 触发器支持的事件类型。
|
enabled | 是否启用该触发器。默认为启用(true)。 |
- AUTH触发器
参数 | 说明 |
type | 触发器类型,配置为“auth”。 |
eventType | 触发器支持的事件类型。
说明
|
- CLOUDSTORAGE触发器
参数 | 说明 |
type | 触发器类型,配置为“cloud_storage”。 |
bucketName | 云存储服务中已创建的存储实例名称,仅支持字母、数字、中划线,长度为1~64字符。 |
eventName | 触发器支持的事件类型。
|
- CRON触发器
参数 | 说明 |
type | 触发器类型,配置为“cron”。 |
triggerMode | 调用方式。
|
schedule | 触发函数调用的时间点,支持两种设置方式:
说明 cron以UTC时间运行,即北京时间减去8个小时。 下列提供了cron表达式的一些常用设置示例:
|
triggerSwitch | 触发器是否自动开启。 |
triggerName | 触发器名称,不超过32位,仅支持输入小写字母、数字、$和中划线,以小写字母开头,数字或小写字母结尾。触发器名称必须唯一。 |
- helloworld.ts:函数入口文件(此处以“helloworld.ts”为例,请以实际名称为准)。请参考代码开发编写函数代码。
- package.json:包含了当前函数的名称、版本等函数元数据。package.json内自动引入了云数据库的最新版本Node.js Server SDK,您也可以在“dependencies”下添加其他需要的依赖。
部署函数
完成函数代码开发后,您可将函数部署到AGC控制台,支持单个部署和批量部署。
部署单个函数
- 右击需部署的函数目录,选择“Deploy Function”。
- “Event Log”区域可查看函数打包与部署状态日志。
请您耐心等待,直至出现“Deploy succeed”日志,表示函数已成功部署。
- 登录AppGallery Connect,进入当前项目的云函数服务菜单,可查看到您刚刚部署的函数,函数名称与本地工程的函数目录名相同。
批量部署函数
批量部署指将整个云函数目录下创建的所有函数同时部署到AGC控制台。
- 右击“cloudfunctions”目录,选择“Deploy Cloud Functions”。
- DevEco Studio将依次部署各个函数,您可在“Event Log”区域查看函数打包与部署状态日志。
请您耐心等待,直至出现“Deploy succeed”日志,表示所有函数均已成功部署。
- 登录AppGallery Connect,进入当前项目的云函数服务菜单,可查看到您刚刚部署的云函数目录下的所有函数,函数名称均与本地工程的函数目录名相同。