在鸿蒙（HarmonyOS 5），创建云函数以及调用和传参

在鸿蒙（HarmonyOS）开发中，创建云函数是端云一体化开发的重要组成部门，主要用于实现服务端的业务逻辑。以下是详细的步骤和说明：
1. 开通云函数服务（AGC）

• 注册并登录AppGallery Connect (AGC)：在华为AGC平台创建项目和应用256。
  
• 开通云函数服务：在项目设置中开通云函数功能，免费档支持每月100万次调用268。
  

2. 使用DevEco Studio创建端云一体化项目

• 选择端云一体化模板创建项目，确保Bundle name与AGC中的应用包名一致257。
  
• 项目结构包含：
  
  
  
  • Application（端侧代码）
    
  • CloudProgram（云侧代码，包括云函数和云数据库）23。
    
  
  

3. 创建云函数

• 在cloudfunctions目次右键选择 New > Cloud Function，输入函数名称（如my-cloud-function），定名规则为小写字母、数字或中划线127。
  
• 生成的文件包括：
  
  
  
  • function-config.json（触发器配置）
    
  • myCloudFunction.ts（入口文件）
    
  • package.json（依赖管理）17。
    
  
  

4. 编写云函数代码

云函数使用TypeScript开发，标准格式如下：

1. /*
2. event：调用时传入的参数（如HTTP请求体）。
3. context：执行上下文（环境变量等）。
4. callback：返回结果。
5. logger：日志记录
6. */
7. let myHandler = async function (event, context, callback, logger) {
8.   logger.info(event);
10.   // do something here
12.   callback({
13.     code: 0,
14.     message: "Success." + Math.random()
15.   });
16. };
18. export { myHandler };

复制代码

• 参数说明：
  
  
  
  • event：调用时传入的参数（如HTTP哀求体）。
    
  • context：实行上下文（环境变量等）。
    
  • callback：返回结果。
    
  • logger：日志记录237。
    
  
  

5. 配置触发器

在function-config.json中配置HTTP触发器，支持鉴权和URL解码等属性：

1. {
2.     "type": "http",
3.     "properties": {
4.         "enableUrlDecode": true,
5.         "authFlag": "true",
6.         "authType": "apigw-client"
7.     }
8. }

复制代码

• 部署后会自动生成触发URL17。
  

6. 调试与部署

• 本地调试：右键cloudfunctions选择 Run Cloud Functions，需安装华为提供的Node.js环境27。
  
  
  
• 云端部署：右键选择 Deploy Cloud Functions，需登录华为开发者账号。部署后可在AGC控制台查看和测试257。
  
  
  

7. 端侧调用云函数

检查agconnect-services.json中是否有云函数配置：

2.   "services": {
3.     "cloudfunction": {
4.       "functions": [
5.         {
6.           "name": "hello",
7.           "version": "$latest"
8.         }
9.       ]
10.     }
11.   }

复制代码

注：version  ："1"  // 1为版本，$latest 为最新版本（建议使用）

通过cloud.callFunction调用：

1. import cloud from '@hw-agconnect/cloud'
3. @Entry
4. @Component
5. struct Test{
6.   @State message:string = '初始数据'
7.   build() {
8.     Column(){
9.       Text(this.message)
10.         .fontSize(24)
11.       Button('测试云函数')
12.         .onClick(async () => {
13.           try {
14.             console.log("开始调用云函数..."); // 确认点击事件触发
15.             const result = await cloud.callFunction({
16.               name: 'hello',
17.               version: "$latest",
18.               params: {}
19.             });
20.             console.log("云函数返回原始数据:", result); // 打印完整结果
21.             if (result && result.getValue()) {
22.               this.message = result.getValue().message;
23.             } else {
24.               this.message = "云函数未返回数据";
25.             }
26.           } catch (e) {
27.             console.error("云函数调用失败:", e); // 打印详细错误
28.             this.message = "调用失败: " + e.message;
29.           }
30.         })
31.     }
32.   }
33. }

复制代码

• version：版本（$latest表现最新）。
  
• 解释：端侧调用只能在 真机 和 模仿器上 运行，预览器不可行。
  

8.云函数（怎样传参）

重新编写云函数（例：Holle）

1. // 定义一个异步处理函数，接收4个标准参数
2. let myHandler = async function (event, context, callback, logger) {
3.   // 1. 记录日志：打印完整的event对象（调试用）
4.   logger.info(event);
6.   // 2. 业务逻辑处理
7.   // --------------------------------------------------
8.   // 注意：event.body 是字符串格式，需要先解析为JSON对象
9.   const obj = JSON.parse(event.body);  // 解析请求体
11.   // 获取参数方式1：从解析后的对象中获取
12.   const name = obj.name;  // 获取客户端传递的name参数
14.   // 获取参数方式2（错误示例）：直接访问会报错，因为event.body是字符串
15.   // const name = event.body.name;  // ❌ 错误写法！
16.   // --------------------------------------------------
18.   // 3. 返回响应（通过callback）
19.   callback({
20.     code: 0,  // 自定义状态码（0表示成功）
21.     message: `Hello ${name}`  // 返回拼接的问候语
22.   });
23. };
25. // 导出处理函数（固定写法）
26. export { myHandler };

复制代码

完成之后重新部署，云函数部署后如需更新触发器，需先删除旧配置再添加新配置。
（将agconnect-services.json重新在控制台下载，将从前的覆盖）
---------=============================================================
修改端侧调调用云函数代码

1. import cloud from '@hw-agconnect/cloud'
3. @Entry
4. @Component
5. struct Test{
6.   @State message:string = '初始数据'
7.   @State name:string = ''   // 定义变量name
8.   build() {
9.     Column(){
10.       TextInput({placeholder:'请输入姓名'})
11.         .onChange((value)=>{
12.           this.name = value  // 获取用户输入的数据
13.       })
14.      //省略
15.               name: 'hello',
16.               version: "$latest",
17.               params: {name:this.name} //将获取的数据
18.      //省略
19.   }
20. }

复制代码

结果演示

留意事项

• 云函数部署后如需更新触发器，需先删除旧配置再添加新配置。
  
• 端侧与云侧包名必须一致，否则关联失败56。