HuaweiCloud 拓展- 重要:为什么是“云函数网关式”
- 适用场景
- 组件组成
- 共享配置
- 云函数约定(必读)
- 开发前准备工作
- 使用示例
- HuaweiCloudAuth
- HuaweiCloudFunction
- HuaweiCloudDB
- HuaweiCloudStorage
HuaweiCloud 拓展
HuaweiCloud 拓展用于把华为 AppGallery Connect(AGC)/ Cloud Foundation Kit(端云一体化) 的 BaaS 能力接入 App Inventor 应用,提供身份认证、云数据库、云存储和云函数能力。
- .aix 拓展下载:
重要:为什么是“云函数网关式”
App Inventor 生成的是 Android 应用,端侧只能走 HTTP,无法使用华为 HarmonyOS 原生的 Cloud Foundation Kit SDK。而 AGC 的云数据库 / 云存储 / 认证在端侧都是 SDK 能力,没有可供任意客户端直接调用的 REST 接口。AGC 唯一“干净的 REST 入口”是 云函数 HTTP 触发器。
因此本拓展采用 云函数网关式架构:
App(本拓展)── HTTP POST ──▶ 云函数 HTTP 触发器 ──▶ AGC 服务端 SDK ──▶ 云数据库/云存储/认证
- 所有组件都把请求 POST 给你在云端部署的云函数。
- 由云函数(用 AGC 服务端 SDK)真正操作数据库 / 存储 / 认证,再把结果返回。
- 你需要在 AGC 控制台部署对应云函数,并为其开启 HTTP 触发器。
适用场景
- 需要用户注册、登录、匿名登录、令牌管理。
- 需要把 App 数据保存到华为云数据库。
- 需要上传文件到云存储,并在 App 中获取访问链接。
- 需要把复杂业务逻辑放到云函数中执行。
组件组成
导入 cn.fun123.HuaweiCloud.aix 后,会出现 4 个可独立拖拽的不可见组件。
| 组件 | 作用 |
|---|---|
HuaweiCloudFunction |
调用云函数 HTTP 触发器,是网关式架构的核心入口 |
HuaweiCloudAuth |
身份认证:注册、登录、匿名登录、刷新/获取/退出当前用户,并承载共享配置 |
HuaweiCloudDB |
云数据库:通过云函数做增删改查、统计 |
HuaweiCloudStorage |
云存储:通过云函数上传、下载、获取链接、删除文件 |
共享配置
HuaweiCloudAuth 承载共享配置,其它组件设置 HuaweiCloudAuth 属性引用它即可复用:
TriggerBaseUrl:云函数 HTTP 触发器基础地址,组件会把它与函数名拼成完整 URL(base/函数名)。也可在方法里直接传完整触发器 URL。ApiKey:可选,作为请求头x-api-key发给云函数,供云函数校验调用来源。AccessToken:登录成功后自动存储;其它组件请求时作为Authorization: Bearer发送。Timeout:HTTP 超时,默认10000毫秒。
跨页面(多屏幕)使用时,可在各组件上手动设置 TriggerBaseUrl 和 AccessToken,无需 HuaweiCloudAuth 引用。
云函数约定(必读)
组件按下面的约定调用你的云函数,请按约定实现对应云函数:
- 请求方式:
POST,请求体是一段 JSON 文本。 - 请求头:
Authorization: Bearer <AccessToken>(已登录时)、x-api-key: <ApiKey>(已配置时)。 - 响应体:返回 JSON 文本,原样通过“成功事件”的
data参数交给项目。若返回{"code":"非0","message":"..."}这类业务错误,会触发RequestFailed。
各组件发送的请求体:
| 组件方法 | 默认云函数 | 请求体(JSON) |
|---|---|---|
Auth.SignIn |
auth |
{"action":"signIn","username":..,"password":..} |
Auth.SignUp |
auth |
{"action":"signUp","username":..,"password":..,...} |
Auth.SignInAnonymously |
auth |
{"action":"signInAnonymously"} |
Auth.RefreshAccessToken |
auth |
{"action":"refreshToken","refresh_token":..} |
Auth.GetCurrentUser |
auth |
{"action":"getCurrentUser"} |
Auth.SignOut |
auth |
{"action":"signOut"} |
DB.QueryDocuments |
clouddb |
{"action":"query","objectType":..,"query":{..}} |
DB.InsertDocuments |
clouddb |
{"action":"insert","objectType":..,"data":{..}} |
DB.UpdateDocuments |
clouddb |
{"action":"update","objectType":..,"query":{..},"data":{..}} |
DB.DeleteDocuments |
clouddb |
{"action":"delete","objectType":..,"query":{..}} |
DB.CountDocuments |
clouddb |
{"action":"count","objectType":..,"query":{..}} |
Storage.UploadFile |
cloudstorage |
{"action":"upload","path":..,"fileName":..,"content":"<base64>","encoding":"base64"} |
Storage.GetFileUrl |
cloudstorage |
{"action":"getUrl","path":..} → 返回 {"url":".."} |
Storage.DownloadFile |
cloudstorage |
先 getUrl 取链接,再下载保存到本地 |
Storage.DeleteFile |
cloudstorage |
{"action":"delete","path":..} |
认证类返回里若包含 access_token / refresh_token / user_id(或在 data. / tokens. 下),会被自动存储到 Auth 组件。
开发前准备工作
1. 开通 AppGallery Connect 并创建项目/应用
参考 华为 Cloud Foundation Kit 指南 与 AppGallery Connect 云函数。
2. 部署云函数并开启 HTTP 触发器
按上面的「云函数约定」实现 auth / clouddb / cloudstorage 等云函数(函数名可自定义,组件属性里改对应的 Default*Function 即可),并为每个函数开启 HTTP 触发器,记录触发器地址。
3. 在 App 中配置
把触发器基础地址填到 HuaweiCloudAuth.TriggerBaseUrl,其它组件引用该 Auth 组件即可。
使用示例
下面每张积木图的右上角都有「复制代码块」,点一下,再到代码块编辑器里按 Ctrl+V,
积木就直接进工程了——不用照着一块块拖。
组件名按设计器里的默认中文名写(按钮1、标签1…),拓展组件本身是英文名。
粘贴后如果工程里没有同名组件,组件块会标红,把名字改成你自己的组件即可。
注册与登录
注册成功后 SignUpSuccess 不带参数,通常紧接着自动登录一次。
所有组件共用一个 RequestFailed,operation 会告诉你是哪一步失败的。
when 按钮_注册.Click() {
HuaweiCloudAuth1.SignUp(文本输入框_账号.Text, 文本输入框_密码.Text, "{}")
}
when HuaweiCloudAuth1.SignUpSuccess() {
标签_状态.Text = "注册成功,正在登录…"
HuaweiCloudAuth1.SignIn(文本输入框_账号.Text, 文本输入框_密码.Text)
}
when 按钮_登录.Click() {
HuaweiCloudAuth1.SignIn(文本输入框_账号.Text, 文本输入框_密码.Text)
}
when HuaweiCloudAuth1.SignInSuccess() {
标签_状态.Text = "登录成功"
HuaweiCloudAuth1.GetCurrentUser()
}
when HuaweiCloudAuth1.CurrentUserSuccess(responseCode, data) {
标签_状态.Text = join("当前用户:", data)
}
when HuaweiCloudAuth1.RequestFailed(operation, errorCode, errorMessage) {
标签_状态.Text = join("失败(", operation, "):", errorMessage)
}
云数据库增查
InsertDocuments 第一个参数是对象类型(相当于表名),数据是 JSON 文本,用 join 拼。
新增成功后再查一次刷新列表。
when 按钮_新增.Click() {
HuaweiCloudDB1.InsertDocuments("Note", join("[{\"title\":\"", 文本输入框_标题.Text, "\"}]"))
}
when HuaweiCloudDB1.InsertSuccess(responseCode, data) {
标签_状态.Text = "已保存"
HuaweiCloudDB1.QueryDocuments("Note", "{}")
}
when HuaweiCloudDB1.QuerySuccess(responseCode, data) {
列表显示框1.ElementsFromString = data
}
when HuaweiCloudDB1.RequestFailed(operation, errorCode, errorMessage) {
标签_状态.Text = join("出错:", errorMessage)
}
上传文件并取回地址
UploadFile 传云端路径和本地路径;上传完用 GetFileUrl 换可访问地址,直接给图像组件显示。
when 图像选择器1.AfterPicking() {
标签_状态.Text = "上传中…"
HuaweiCloudStorage1.UploadFile("photos/head.jpg", 图像选择器1.Selection)
}
when HuaweiCloudStorage1.UploadSuccess(responseCode, data) {
HuaweiCloudStorage1.GetFileUrl("photos/head.jpg")
}
when HuaweiCloudStorage1.GetUrlSuccess(responseCode, url) {
图像1.Picture = url
标签_状态.Text = "上传完成"
}
when HuaweiCloudStorage1.RequestFailed(operation, errorCode, errorMessage) {
标签_状态.Text = join("上传失败:", errorMessage)
}
HuaweiCloudAuth
身份认证组件,同时承载共享配置(TriggerBaseUrl / ApiKey / Timeout)。登录/注册成功后自动存储 AccessToken / RefreshToken / UserId。
Properties
- AccessToken
- 访问令牌,登录成功后自动存储。跨页面使用时可读取此属性传给其它组件。
- ApiKey
- 应用密钥/标识,作为请求头
x-api-key发给云函数。 - DefaultAuthFunction
- 默认的“认证云函数”名/触发器标识,默认
auth。 - RefreshToken
- 刷新令牌,登录成功后自动存储。
- Timeout
- HTTP 请求超时时间(毫秒),默认
10000。 - TriggerBaseUrl
- 云函数 HTTP 触发器基础地址。
- UserId
- 用户ID,登录成功后自动存储。
Events
- AnonymousSignInSuccess()
- 匿名登录成功。AccessToken 已自动存储。
- CurrentUserSuccess(responseCode,data)
- 获取当前用户成功,
data为用户信息 JSON。 - RefreshTokenSuccess()
- 刷新令牌成功。AccessToken/RefreshToken 已自动更新。
- RequestFailed(operation,errorCode,errorMessage)
- 请求失败。
- SignInSuccess()
- 登录成功。AccessToken/RefreshToken/UserId 已自动存储。
- SignOutSuccess(responseCode,data)
- 退出登录成功。
- SignUpSuccess()
- 注册成功。AccessToken/RefreshToken/UserId 已自动存储。
Methods
- CallAuthAction(action,paramsJson)
- 调用认证云函数的自定义动作,返回数据通过
CurrentUserSuccess给出。 - GetCurrentUser()
- 获取当前登录用户信息。
- RefreshAccessToken()
- 用已存储的刷新令牌换取新的访问令牌。
- SignIn(username,password)
- 登录,成功后自动存储令牌。
- SignInAnonymously()
- 匿名登录。
- SignOut()
- 退出登录,成功后清空本地令牌。
- SignUp(username,password,extraJson)
- 注册。
extraJson为额外字段(JSON,可为空)。
HuaweiCloudFunction
云函数组件,直接调用 AGC 云函数 HTTP 触发器,是网关式架构的核心入口。
Properties
- AccessToken
- 访问令牌。设置
HuaweiCloudAuth后自动获取;跨页面使用时需手动设置。 - DefaultFunctionName
- 默认云函数名/触发器标识,
Call方法会调用它。 - HuaweiCloudAuth
- Auth 组件引用,设置后自动复用其 TriggerBaseUrl/ApiKey/AccessToken。
Events
- FunctionSuccess(responseCode,data)
- 云函数调用成功,
data为函数返回的数据。 - RequestFailed(operation,errorCode,errorMessage)
- 请求失败。
Methods
- Call(params)
- 调用默认云函数(DefaultFunctionName)。
params为 JSON 参数(可为空)。 - CallFunction(functionName,params)
- 调用指定云函数(也可传完整触发器 URL)。
- CallUrl(fullUrl,params)
- 用完整 URL 调用云函数 HTTP 触发器。
- GetJsonValue(jsonText,path)
- 从 JSON 文本里按路径取值(
a.b.0.c,点分隔,数字为数组下标),取不到返回空串。
HuaweiCloudDB
云数据库组件,通过“数据库云函数”对云数据库做增删改查、统计。objectType 相当于表名/对象类型。
Properties
- AccessToken
- 访问令牌。设置
HuaweiCloudAuth后自动获取;跨页面使用时需手动设置。 - DefaultDbFunction
- 默认的“数据库云函数”名/触发器标识,默认
clouddb。 - DefaultObjectType
- 默认对象类型(相当于表名)。不带 objectType 的快捷方法会用它。
- HuaweiCloudAuth
- Auth 组件引用。
Events
- DeleteSuccess(responseCode,data)
- 删除成功。
- InsertSuccess(responseCode,data)
- 新增成功。
- QuerySuccess(responseCode,data)
- 查询/统计成功。
- RequestFailed(operation,errorCode,errorMessage)
- 请求失败。
- UpdateSuccess(responseCode,data)
- 更新成功。
Methods
- CallDbAction(action,paramsJson)
- 调用数据库云函数的自定义动作,结果在
QuerySuccess的data中。 - CountDocs(queryJson)
- 统计记录数(使用默认对象类型)。
- CountDocuments(objectType,queryJson)
- 统计记录数。
- DeleteDocs(queryJson)
- 删除记录(使用默认对象类型)。
- DeleteDocuments(objectType,queryJson)
- 删除记录。
- InsertDoc(dataJson)
- 新增/写入记录(使用默认对象类型)。
- InsertDocuments(objectType,dataJson)
- 新增/写入记录。
- QueryDocs(queryJson)
- 查询记录(使用默认对象类型)。
- QueryDocuments(objectType,queryJson)
- 查询记录。
- UpdateDocs(queryJson,dataJson)
- 更新记录(使用默认对象类型)。
- UpdateDocuments(objectType,queryJson,dataJson)
- 更新记录。
HuaweiCloudStorage
云存储组件,通过“存储云函数”上传、下载、获取访问链接、删除文件。本地路径支持 /storage/...、file://、content://。
Properties
- AccessToken
- 访问令牌。设置
HuaweiCloudAuth后自动获取;跨页面使用时需手动设置。 - DefaultDirectory
- 默认云端目录前缀(如
images)。设置后传入的相对路径会自动加上该前缀。 - DefaultStorageFunction
- 默认的“存储云函数”名/触发器标识,默认
cloudstorage。 - HuaweiCloudAuth
- Auth 组件引用。
Events
- DeleteFileSuccess(responseCode,data)
- 删除文件成功。
- DownloadSuccess(responseCode,cloudPath,localFilePath,bytesWritten)
- 文件下载成功。
- GetUrlSuccess(responseCode,url)
- 获取文件链接成功,
url为访问链接。 - RequestFailed(operation,errorCode,errorMessage)
- 请求失败。
- UploadSuccess(responseCode,data)
- 文件上传成功,
data含云端返回的url等。
Methods
- DeleteFile(cloudPath)
- 删除云文件。
- DownloadFile(cloudPath,localFilePath)
- 下载云文件并保存到手机。
- GetFileUrl(cloudPath)
- 获取文件的访问链接(可在 Image 组件预览在线图片)。
- UploadFile(cloudPath,filePath)
- 上传本地文件到云存储。
扫码添加客服咨询