当前位置:   article > 正文

鸿蒙端云一体化,极简开发数独闯关游戏元服务_端云一体化工程目录结构分为哪些部分

端云一体化工程目录结构分为哪些部分

前言

数独闯关游戏元服务,支持2*4历史闯关记录卡片、4*4数独闯关游戏卡片,无需进入元服务,可在桌面上开始游戏,同步刷新记录。

1 基本概念

  • 元服务(原名原子化服务)是一种基于HarmonyOS API的全新服务提供方式,以HarmonyOS万能卡片等多种呈现形态,向用户提供更轻量化的服务。具有即用即走、信息外显、服务直达的特性。
  • 万能卡片(简称卡片)是一种界面展示形式,可以将应用的重要信息或操作前置到卡片,以达到服务直达、减少体验层级的目的。
  • HUAWEI DevEco Studio是华为基于IntelljJ IDEA Community开源版本打造的一款面向全场景多设备,提供一站式的分布式应用开发平台,支持分布式多端开发、分布式多端调测、多端模拟仿真,为运行在HarmonyOS/OpenHarmony系统上的应用/服务提供一站式开发平台。
  • HarmonyOS SDK是集成在DevEco Studio中,为应用/服务开发提供所需的一系列系统开放能力,如框架、Ability、分布式服务、安全、方舟编译器、HMS Core、基础软件服务、硬件服务等,其包含开发者可以使用的API以及调试编译等基础的工具链。
  • ArkTS语言是华为自研的开发语言,基于TypeScript(简称TS)基础上匹配了ArkUI框架,扩展了声明式UI、状态管理等相应的能力。
  • ArkUI框架是一套构建分布式应用界面的声明式UI开发框架,其使用极简的UI信息语法、丰富的UI组件、以及实时界面预览工具,帮助开发者提升HarmonyOS应用界面开发效率。
  • ArkCompiler是华为自研的统一编程平台,包括编译器、工具链、运行时等关键部件,支持高级语言在多种芯片平台的编译与运行。
  • AppGallery Connect(简称AGC)致力于为应用的创意、开发、分发、运营、经营各环节提供一站式服务,构建全场景智慧化的应用生态体验。
  • 端云一体化是为丰富HarmonyOS对云端开发的支持、实现HarmonyOS生态端云联动,DevEco Studio推出了云开发功能,开发者在创建工程时选择云开发模板,即可在DevEco Studio内同时完成HarmonyOS应用/服务的端侧与云侧开发。

2 约定

  • DevEco Studio 3.1.1 Release
  • HarmonyOS SDK API 9
  • ArkTS语言
  • Stage模型
  • 端云一体化元服务工程
    • 确保已使用已实名认证的华为开发者账号登录DevEco Studio。

3 创建端云一体化元服务工程

3.1 打开创建工程向导

选择以下一种方式,打开工程创建向导界面

  • 当前未打开任何工程,单击DevEco Studio欢迎页中“Create Project”创建新工程。
  • 当前已打开工程,单击菜单栏“File > New > Create Project”创建新工程。

3.2 选择工程模板

在Choose Your Ability Template向导页,单击“Atomic Service”切换工程类型,选择云开发模板,单击“Next”进入下一步。

3.3 配置工程信息

在工程配置界面,配置工程的基本信息。单击“Next”按钮进入关联云开发资源界面。

参数说明
Project name工程的名称,由大小写字母、数字和下划线组成。
Bundle name软件包名称,需保证唯一,由字母、数字、下划线和符合“.”组成,以字母开头,长度为7-127个字符。
Save location工程文件本地存储路径,由大小写字母、数字和下划线等组成,不能包含中文字符。
Compile SDK应用的目标API Version,在编译构建时,DevEco Studio会根据指定的Compile API版本进行编译打包。使用云开发模板,版本不低于9。
Model应用支持的模式,云开发模板仅支持Stage模式。
Language开发语言。Stage模式仅支持使用ArkTS语言开发。
Compatible SDK兼容的最低API Version。云开发模板,版本不低于9。
Device Type工程模板支持的设备类型,当前API 9仅支持手机设备。
Enable CloudDev是否启用云开发,默认启用且无法更改。

3.4 关联云开发资源

为工程关联云开发所需的资源,即在DevEco Studio中选择您的华为开发者账号加入的开发者团队,将该团队在AGC的同包名应用关联到当前工程,具体操作如下:

  • 若尚未登录DevEco Studio,单击“Sign in”,拉起浏览器在弹出的账号登录页面,使用已实名认证的华为开发者账号完成登录。

登录成功后,在授权界面单击“允许”按钮为DevEco Studio授权,界面将展示账号昵称。

  • 单击“Team”下拉框,选择开发团队。选中团队后,系统根据工程包名自动查询团队下的同包名应用。若为首次创建且团队下未创建同包名的应用,则提示需要在AGC平台创建应用。

单击“AppGallery Connect”打开AGC应用创建向导,填写应用信息,单击“确认”按钮创建应用。

完成以上操作后,DevEco Studio即可获取到同包名应用对应的项目信息。

3.5 工程初始化配置

成功创建工程并关联云开发资源后,DevEco Studio会为工程自动执行一些初始化配置,并开通云开发相关服务:认证服务、云函数、云数据库、云托管、API网关、云存储。

  • 端侧工程自动集成AGC SDK,包括AGC SDK 配置文件entry/src/main/resources/rawfile/agconnect-services.json 和在entry/oh-package.json5配置文件中引入的AGC相关云服务最新版本SDK。

  • 云侧工程自动集成云数据库最新版本Node.js Server SDK。

4 端云协同元服务工程介绍

端云一体化元服务开发工程目录分为三个子工程:元服务开发工程(Application)、云开发工程(CloudProgram)、端侧公共库(External Libraries)。

4.1 元服务开发工程(Application)

元服务开发工程主要用于开发应用端侧的业务代码,元服务开发工程目录结构如下:

  1. - Application
  2.     - AppScope
  3.         app.json5    // 应用的全局配置信息
  4.     - entry           // 应用/服务模块,编译构建生成一个HAP
  5.         oh_modules   // 用于存放三方库依赖信息
  6.         - src/main
  7.             - ets    // 用于存放ArkTS源码
  8.             - resources    // 用于存放应用/服务所用到的资源文件
  9.             module.json5    // Stage模型配置文件
  10.         build-profile.json5    // 当前模块信息、编译信息配置项
  11.         hvigorfile.ts          // 模块级编译构建任务脚本
  12.         oh-package.json5        // 配置三方包声明的入口及包名
  13.     build-profile.json5    // 应用配置信息,包括签名、产品配置等
  14.     hvigorfile.ts         // 应用级编译构建任务脚本  
复制

4.2 云开发工程(CloudProgram)

云开发工程中开发者可以为应用开发云函数和云数据库服务资源,云开发工程目录结构如下:

  1. - CloudProgram
  2.     - clouddb    // 云数据库工程目录
  3.         dataentry    // 用于存放数据条目文件
  4.         objecttype    // 用于存放对象类型文件
  5.         db-config.json    // 模块配置文件
  6.     - cloudfunctions    // 云函数工程目录
  7. cloudFunctionName // 云函数名称
  8.         node_modules    // 包含所有三方依赖
  9.         cloud-config.json    // 云开发工程配置文件
  10.         package.json    // 定义了TypeScript公共依赖
复制

5 云函数开发指南

5.1 创建函数

在云端工程(CloudProgram)中可以创建函数、编写函数业务代码、为函数配置调用触发器。

  1. 单击“cloudfunctions”目录,选择“New > Cloud Function”创建云函数。

  1. 输入函数名称,单击“OK”按钮DevEco Studio自动生成函数目录。函数名称仅支持小写英文字母、数字、中划线(-),首字母必须为小写字母,结尾不能为中划线(-)。

    为当前工程创建生成数独9*9宫格二维数组算法,云函数名称为sudoku-algorithm 。

  1. 云函数目录结构。

  1. - sudoku-algorithm
  2. node_modules    // 自动为该函数引入依赖包
  3. function-config.json    // 函数的配置文件,可配置触发器,通过触发器暴露的触发条件来实现函数调用。
  4. package.json            // 包含了当前函数的名称、版本等函数元数据。
  5. sudoku-algorithm.ts    // 函数入口文件
复制
  1. 云函数触发器 云函数触发器在function-config.json文件中triggers属性中配置,当前支持HTTP触发器、CLOUDDB触发器、AUTH触发器、CLOUDSTORAGE触发器、CRON触发器五种。
  • HTTP触发器:工程创建完成后默认自动在function-config.json文件生成HTTP触发器配置。函数部署到云端后会自动生成触发URL,开发者向URL发起HTTP请求时触发函数。
  1. {
  2. "type": "http",
  3. "properties": {
  4. "enableUrlDecode": true,
  5. "authFlag": "true",
  6. "authAlgor": "HDA-SYSTEM",
  7. "authType": "apigw-client"
  8. }
  9. }
复制
参数说明
enableUrlDecode通过HTTP触发器触发函数,对于contentType为“application/x-www-form-urlencoded”的触发请求,是否使用URLDecoder对请求body进行解码再转发到函数中。
- true:启用。
- false:不启用。
authFlag是否鉴权,默认为true。
authAlgor鉴权算法,默认为HDA-SYSTEM。
authTypeHTTP触发器的认证类型。
 - apigw-client:端侧网关认证,适用于来自APP客户端侧的函数调用。
 - cloudgw-client:云侧网关认证,适用于来自APP服务器侧的函数调用。

5.2 开发云函数

云函数的代码实现基于不同的语言运行环境可分为Node.js、Java、Python,还有一种比较特别运行环境为Custom Runtime(自定义运行环境)。本工程的语言运行环境为Node.js。

  1. 云函数的入口方法
module.exports.myHandler = function(event, context, callback, logger)
复制
  • myHandler:入口方法名称。
  • event:调用方传递的事件对象,JSON格式。
  • context:函数运行时上下文对象,封装了日志接口、回调接口、环境变量env对象等。
  • callback:事件处理结果。
  • logger:记录日志。开发者在代码中使用logger接口记录日志,当前支持四种级别。
    • logger.debug()
    • logger.error()
    • logger.warn()
    • logger.info()

函数必须通过显示调用callback(object)将事件处理结果返回给AGC,结果可以是任意对象,但必须与JSON.stringify兼容,AGC会将结果转换成JSON字符串,返回给调用方。callback执行完成后,函数即执行结束。

  1. 为云函数添加返回内容
  1. let myHandler = async function (event, context, callback, logger) {
  2. logger.info(event);
  3. // do something here
  4. callback({
  5. code: 0,
  6. desc: "Success.",
  7. data: "请求成功!"
  8. });
  9. };
  10. export { myHandler };
复制
  1. 调试云函数

函数开发过程中,开发者可在本地进行调试,或者将函数部署到AGC云端后,在本地触发调用云端函数。当前本地调试支持Run和Debug两种模式,Debug模式支持使用断点来追踪函数的运行情况。

  • 本地云函数调试,单击"cloudfunctions > Run/Debug Cloud Function"运行/调试云函数。

  • 查看Run面板,若出现“Cloud Functions loaded successfully”,标识云函数启动成功(云函数启动/调试将部署cloudfunctions中所有的云函数),并生成对应的POST URL。

  • 在菜单栏选择“Tools > CloudDev > Cloud Functions Requestor”触发云函数调用。

  • 在弹出的云函数调用界面填写触发事件参数。

  • Environment:选择函数调用环境,Local表示本地调用,Remote表示远程调用(需要先将函数部署到AGC云端)。
  • Cloud Function:选择需要触发的云函数。
  • Event:输入事件参数,内容为JSON格式请求体数据。
  • 单击Trigger按钮,触发执行云函数,执行结果展示在Result框内,Run面板同时打印运行日志。

  1. 部署云函数 完成函数代码开发后,开发者可将函数部署到AGC控制台,支持单个部署和批量部署。
  • 右键单击需要部署的函数目录,选择“Deploy Function”。
  • 底部状态栏右侧将显示函数打包与部署进度,直至出现“Deploy successfully”消息表示函数部署成功。

  • 登录AGC控制台,进入当前项目的云函数服务菜单,可查看开发者部署的函数。

  • 远程函数测试 在“Cloud Functions Reuestor”面板中,更改Environment为Remote远程调用,单击“Trigger”按钮,在Result中显示返回结果。

5.3 查看触发器标识

当开发者创建的函数或函数别名中创建一个HTTP类型的触发器后,在应用客户端调用函数时需要传入HTTP触发器的标识,查询方法如下:在函数的触发器页面点击“HTTPTrigger”触发器,查看“触发URL”的后缀,获取触发器标识,格式为“函数名-版本号”。

5.4 调用云函数

应用集成云函数SDK后,可以在应用内直接通过SDK API调用AGC中的云函数,云函数SDK与AGC的函数调用基于HTTPS的安全访问。

  • 在端侧应用(Application)中“entry > src/main/ets > services”目录创建SudokuAlgorithmFunction.ts文件,编写调用云函数方法。
  1. import agconnect from '@hw-agconnect/api-ohos';
  2. import "@hw-agconnect/function-ohos";
  3. import { Constants } from '../common/Constants';
  4. import { Log } from '../common/Log';
  5. import { getAGConnect } from './AgcConfig';
  6. export function getSudokuPuzzle(context: any) {
  7. return new Promise((resolve, reject) => {
  8. getAGConnect(context);
  9. // 调用wrap方法设置函数,在方法中传入触发器标识,返回得到可执行云函数对象
  10. let functionCallable = agconnect.function().wrap("sudoku-algorithm-$latest");
  11. // 调用call方法运行云函数,若函数有入参,可以将参数转化为JSON对象或JSON字符串传入,若无参则不传
  12. functionCallable.call().then((ret: any) => {
  13. // 可调用getValue方法获取函数的返回值
  14. let result = ret.getValue();
  15. Log.info(Constants.LOG_TAG_NAME, `sudoku-algorithm called, result: ${JSON.stringify(result)}`);
  16. resolve(result);
  17. }).catch((err: any) => {
  18. Log.error(Constants.LOG_TAG_NAME, `sudoku-algorithm failed, cause: ${JSON.stringify(err)}`);
  19. })
  20. });
  21. }
复制
  • 在端侧应用(Application)中“entry > src/main/ets > pages > Index.ets”文件中增加请求云函数方法。
  1. Button('请求自定义云函数')
  2. .fontSize(16)
  3. .onClick(() => {
  4. getSudokuPuzzle(getContext(this)).then((ret) => {
  5. Log.info(Constants.LOG_TAG_NAME, `单击按钮调用云函数返回结果: ${JSON.stringify(ret)}`)
  6. })
  7. })
复制
  • 运行端侧(Application)应用程序,单击“请求自定义云函数”按钮,在Log控制台过滤日志查看返回结果。

5.5 实现云函数返回9*9宫格二位数组的数独谜题和所有解

使用回溯算法填充数独谜题,并随机移除一些数字将其作为数独谜题,然后求解指定数独谜题的所有解。

  1. let myHandler = async function (event, context, callback, logger) {
  2. // 传递的关卡值作为需要填充的空格数
  3. let body = event.body;
  4. let params = JSON.parse(body);
  5. let levelNum = params.level;
  6. // 创建一个9*9的空白数独谜题
  7. let sudoku = Array.from({ length: 9 }, () => Array(9).fill(0));
  8. // 使用回溯算法填充数独谜题
  9. solve_sudoku(sudoku);
  10. // 随机移除一些数字,生成数独谜题
  11. remove_number(sudoku, levelNum);
  12. let solutions = answer_sudoku(sudoku);
  13. let sudokuPuzzle = {
  14. "original": sudoku,
  15. "answer": solutions
  16. }
  17. callback({
  18. code: 0,
  19. desc: "Success.",
  20. data: JSON.stringify(sudokuPuzzle)
  21. });
  22. };
  23. function solve_sudoku(sudoku){...}
  24. function remove_number(sudoku, level){...}
  25. function answer_sudoku(sudoku){...}
  26. export { myHandler };
复制

6 认证服务-邮箱认证

当前AGC认证服务为HarmonyOS应用/服务提供的登录认证方式有手机、邮箱和关联账号三种方式。本工程使用“邮箱+验证码”的方式作为应用的登录入口。

6.1 前提条件

  • 需要在AGC控制台开通认证服务(工程创建时默认开通),并在“认证方式”页签中启用“邮箱地址”。
  • 需要在应用中集成SDK(工程创建时默认开通)。

6.2 扩展邮箱认证

  • 调用AGConnectAuth.requestEmailVerifyCode申请验证码,在entry/src/main/ets/services/Auth.ts认证工具类中添加邮箱验证码获取方法。
  1. // 申请邮箱验证码
  2. public requestEmailVerifyCode(email: string) {
  3. let verifyCodeSettings = new VerifyCodeSettingBuilder()
  4. .setAction(VerifyCodeAction.REGISTER_LOGIN)
  5. .setLang('zh_CN')
  6. .setSendInterval(60)
  7. .build();
  8. this.agc.auth().requestEmailVerifyCode(email, verifyCodeSettings)
  9. .then((ret) => {
  10. Log.info(TAG, JSON.stringify({ "Verify Code Result: ": ret }));
  11. }).catch((error) => {
  12. Log.error(TAG, "Error: " + JSON.stringify(error));
  13. });
  14. }
复制
  • 调用EmailUserBuilder生成EmailUser,然后调用AGConnectAuth.createEmailUser注册用户。注册成功后,系统会自动登录,无需再次调用登录接口。也可以使用signIn登录接口,通过第三方认证来登录AGConnect平台,在entry/src/main/ets/services/Auth.ts认证工具类中添加邮箱账号注册用户方法。
  1. // 邮箱账号注册登录
  2. public async loginByEmail(email: string, verifyCode: string): Promise<AgUser> {
  3. return new Promise((resolve, reject) => {
  4. // 如果创建账户的时候没有设置过密码,则只能通过此接口进行登录
  5. let credential = EmailAuthProvider.credentialWithVerifyCode(email, verifyCode);
  6. // 登录接口,通过第三方认证来登录AGConnect平台
  7. this.agc.auth().signIn(credential).then(async (ret) => {
  8. Log.info(TAG, `User has signed in. User: ${JSON.stringify(ret)}`);
  9. let user = ret.getUser();
  10. let userExtra = await ret.getUser().getUserExtra();
  11. let loginRes = new AgUser(
  12. user.getUid(),
  13. user.getPhotoUrl(),
  14. user.getPhone(),
  15. user.getDisplayName(),
  16. userExtra.getCreateTime(),
  17. userExtra.getLastSignInTime())
  18. resolve(loginRes);
  19. }).catch((error) => {
  20. Log.error(TAG, "Error: ", error);
  21. reject(error);
  22. });
  23. });
  24. }
复制

6.3 构建邮箱登录页面

通过容器组件Flex、Row、Column以及基础组件Text、Image、Button、Navigation、TextInput构建邮箱登录页面。

  1. Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
  2. Navigation() {
  3. Column() {
  4. Row({ space: Constants.LENGTH_5_PX }) {
  5. TextInput({ placeholder: '请输入邮箱账号..'})
  6. .type(InputType.Email)
  7. .layoutWeight(Constants.LENGTH_3_PX)
  8. .borderRadius(Constants.BORDER_RADIUS_4_PX)
  9. .maxLength(Constants.LENGTH_20_PX)
  10. .height(Constants.HEIGHT_40)
  11. .enabled(this.timer === 60)
  12. .onChange((val) => {
  13. this.email = val;
  14. })
  15. }
  16. .width(Constants.PERCENT_100)
  17. .justifyContent(FlexAlign.Center)
  18. .margin({ bottom: Constants.LENGTH_20_PX })
  19. Row({ space: Constants.LENGTH_5_PX }) {
  20. TextInput({ placeholder: '请输入验证码..', text: this.verificationCode })
  21. .layoutWeight(Constants.LENGTH_3_PX)
  22. .borderRadius(Constants.BORDER_RADIUS_4_PX)
  23. .maxLength(Constants.LENGTH_6_PX)
  24. .height(Constants.HEIGHT_40)
  25. .onChange((val) => {
  26. this.verificationCode = val;
  27. })
  28. Button(this.timer === 60 ? '获取验证码' : this.timer.toString(), {
  29. type: ButtonType.Normal
  30. })
  31. .backgroundColor('#f9fcfb')
  32. .layoutWeight(Constants.LENGTH_2_PX)
  33. .borderColor('#169cd5')
  34. .borderWidth(Constants.LENGTH_1_PX)
  35. .fontColor('#169cd5')
  36. .borderRadius(Constants.BORDER_RADIUS_4_PX)
  37. .height(Constants.HEIGHT_40)
  38. .enabled(this.validateEmailAddress(this.email) && this.timer === 60)
  39. .onClick(() => this.onGetCodeButtonClicked())
  40. }
  41. .width(Constants.PERCENT_100)
  42. .justifyContent(FlexAlign.Center)
  43. .margin({ bottom: Constants.LENGTH_20_PX })
  44. Button('登录', { type: ButtonType.Normal })
  45. .width(Constants.PERCENT_100)
  46. .borderRadius(Constants.BORDER_RADIUS_4_PX)
  47. .backgroundColor('#169cd5')
  48. .enabled(this.canAuthorize() && this.verificationCode.length > 5 && this.canLogin)
  49. .opacity(this.canLogin ? 1 : 0.5)
  50. .height(Constants.HEIGHT_40)
  51. .onClick(() => this.onAuthButtonClicked())
  52. }
  53. .width(Constants.PERCENT_90).height(Constants.HEIGHT_50)
  54. .justifyContent(FlexAlign.Center)
  55. .margin({ top: Constants.LENGTH_40_PX })
  56. .padding({
  57. right: Constants.LENGTH_15_PX,
  58. left: Constants.LENGTH_15_PX
  59. })
  60. .borderRadius(Constants.LENGTH_8_PX)
  61. .backgroundColor(0xFFFFFF)
  62. }
  63. .title(this.NavigationTitle())
  64. .titleMode(NavigationTitleMode.Full)
  65. .hideTitleBar(false)
  66. .hideToolBar(false)
  67. }
  68. .width(Constants.PERCENT_100).height(Constants.PERCENT_100)
  69. .backgroundColor(Constants.VIEW_BG_COLOR)
复制

6.4 用户登录成功信息写入缓存

调用自定义的登录接口实现登录,并使用首选项自定义工具接口将用户信息写入缓存。

  1. onAuthButtonClicked = () => {
  2. this.canLogin = false;
  3. this.agcAuth.loginByEmail(this.email, this.verificationCode).then((user) => {
  4. PreferencesUtil.putPreference(getContext(this), Constants.USER_AUTH_INFO, JSON.stringify(user));
  5. Log.info(Constants.LOG_TAG_NAME, `Logged in successfully. Data: ${JSON.stringify(user)}`);
  6. this.canLogin = true;
  7. }).catch((err) => {
  8. this.canLogin = true;
  9. Log.error(Constants.LOG_TAG_NAME, `Logged in failed. Cause: ${JSON.stringify(err)}`);
  10. })
  11. }
复制

6.5 登录成功后跳转设置昵称头像界面

右键单击“entry > src/main/ets > pages”目录选择“New > Pages”新建Setting设置页面。

在页面中使用容器组件Grid实现头像选择(提供可选头像6个)和使用基础组件TextInput实现昵称设置。

头像昵称设置成功后,跳转到游戏主界面,点击“开始”按钮从云函数中获取数独谜题及对应的解,然后通过容器组件Grid和其子组件GridItem构建9*9宫格并使用ForEach渲染宫格的对应组件。

  1. // 获取数独谜题和解
  2. getSudoPuzzle = () => {
  3. let _this = this;
  4. getSudokuPuzzle(getContext(this), this.levelNum).then((ret: string) => {
  5. let result: SudokuPuzzle = JSON.parse(ret);
  6. _this.puzzles = result.original;
  7. _this.answers = result.answer;
  8. }).catch((err) => {
  9. Log.error(Constants.LOG_TAG_NAME, `cause: ${JSON.stringify(err)}`);
  10. })
  11. }
  12. Grid() {
  13. ForEach(this.puzzles, (item: Array<number>, i: number) => {
  14. ForEach(item, (temp: number, j: number) => {
  15. GridItem() {
  16. if (temp === 0) {
  17. TextInput()
  18. .type(InputType.Number)
  19. .maxLength(1)
  20. .backgroundColor(0xf47721)
  21. .caretColor(Color.White)
  22. .onChange((val) => {
  23. let answer = this.puzzles;
  24. answer[i][j] = parseInt(val);
  25. this.userAnswer = answer;
  26. Log.info(Constants.LOG_TAG_NAME, JSON.stringify(this.userAnswer));
  27. if (val == "") {
  28. this.userAnswer = [];
  29. }
  30. })
  31. } else {
  32. Text(temp.toString())
  33. .fontSize(16)
  34. }
  35. }
  36. .borderWidth(1)
  37. }, (temp: number) => temp.toString())
  38. }, (item: Array<number>) => item.toString())
  39. }
  40. .columnsTemplate('1fr 1fr 1fr 1fr 1fr 1fr 1fr 1fr 1fr')
  41. .rowsTemplate('1fr 1fr 1fr 1fr 1fr 1fr 1fr 1fr 1fr')
  42. .width(Constants.PERCENT_96)
  43. .height(400)
  44. .backgroundColor(0xFFFFFF)
复制

7 创建闯关游戏万能卡片

万能卡片(以下简称“卡片”)是一种界面展示形式,可以将应用的重要信息或操作前置到卡片,以达到服务直达、减少体验层级的目的。卡片常用于嵌入到其他应用(当前卡片使用方只支持系统应用,如桌面)中作为其界面显示的一部分,并支持拉起页面、发送消息等基础的交互功能。

7.1 拉起页面的2*2卡片

工程在创建初会自动创建2*2服务卡片,位于“entry > src/main/ets > widget > pages”目录。在WidgetCard.ets文件中编写服务卡片呈现内容及样式。

  1. Column() {
  2. Image($r("app.media.card_start"))
  3. .width(this.FULL_WIDTH_PERCENT)
  4. .height(this.FULL_HEIGHT_PERCENT)
  5. .objectFit(ImageFit.Cover)
  6. }
  7. .width(this.FULL_WIDTH_PERCENT)
  8. .height(this.FULL_HEIGHT_PERCENT)
  9. .onClick(() => {
  10. postCardAction(this, {
  11. "action": this.ACTION_TYPE,
  12. "abilityName": this.ABILITY_NAME,
  13. "params": {
  14. "message": this.MESSAGE
  15. }
  16. });
  17. })
复制

ArkTS卡片提供了postCardAction()接口用于卡片内部和提供方应用间交互,当前支持router、message和call三种类型的事件,仅在卡片中可以调用。

接口定义:postCardAction(component: Object, action: Object): void

  • 接口参数说明
参数名参数类型必填参数描述
componentObject当前自定义组件的实例,通常传入this。
actionObjectaction的具体描述详见下表。
  • action参数说明
KeyValue描述
actionstringaction的类型,支持三种预定义的类型:
 - router:跳转到提供方应用的指定UIAbility。
 - message:自定义消息。触发后会调用提供方FormExtensionAbility的onFormEvent()生命周期回调。
 - call:后台启动提供方应用。触发后会拉起提供方应用的指定UIAbility(仅支持launchType为singleton的UIAbility,即启动模式为单实例的UIAbility),但不会调度到前台。提供方应用需要具备后台运行权限ohos.permission.KEEP_BACKGROUND_RUNNING。
bundleNamestringrouter/call类型时跳转的包名,可选。
moduleNamestringrouter/call类型时跳转的模块名,可选。
abilityNamestringrouter/call类型跳转的UIAbility名,必填。
paramsObject当前action携带的额外参数,内容使用JSON格式的键值形式。call类型时需填入参数method,且类型需要为string类型,用于触发UIAbiltiy中对应的方法,必填。

2*2万能卡片提供点击卡片进入元服务主界面。

7.2 创建4*4闯关游戏卡片

4*4服务卡片用于在桌面玩游戏,没关通关后需要通过message事件刷新卡片内容生成新的关卡。

7.2.1 创建一个ArkTS卡片

创建ArkTS卡片有两种方式:

  • 通过在”entry“目录右键单击“New > Service Widget”创建卡片。
  • 通过在”entry > src/main/ets > widget > pages“目录右键单击“New > ArkTS File”创建文件,并在卡片配置文件form_config.json中配置卡片信息。 使用第二种方式创建卡片,在”entry > src/main/ets > widget > pages“目录右键单击“New > ArkTS File”创建GameCard.ets文件,接着打开"entry > src/main/resources > base > profile"目录下的form_config.json文件,配置名称为game的4*4卡片。
  1. {
  2. "name": "game",
  3. "description": "数独闯关游戏",
  4. "src": "./ets/widget/pages/GameCard.ets",
  5. "uiSyntax": "arkts",
  6. "window": {
  7. "designWidth": 720,
  8. "autoDesignWidth": true
  9. },
  10. "colorMode": "auto",
  11. "isDefault": false,
  12. "updateEnabled": false,
  13. "scheduledUpdateTime": "10:30",
  14. "updateDuration": 1,
  15. "defaultDimension": "4*4",
  16. "supportDimensions": [
  17. "4*4"
  18. ]
  19. }
复制

7.2.2 卡片配置文件

卡片相关的配置主要包括FormExtensionAbility的配置和卡片的配置两部分:

  • 卡片需要在module.json5配置文件中的extensionAbilityes标签下,配置FormExtensionAbility相关信息。FormExtensionAbility需要填写metadata元素信息标签,其中键名为固定字符串”ohos.extension.form“,资源为卡片的具体配置信息的索引。
  1. {
  2. "module": {
  3. ...
  4. "extensionAbilities": [
  5. {
  6. "name": "EntryFormAbility",
  7. "srcEntrance": "./ets/entryformability/EntryFormAbility.ts",
  8. "label": "$string:EntryFormAbility_label",
  9. "description": "$string:EntryFormAbility_desc",
  10. "type": "form",
  11. "metadata": [
  12. {
  13. "name": "ohos.extension.form",
  14. "resource": "$profile:form_config"
  15. }
  16. ]
  17. }
  18. ]
  19. }
  20. }
复制
  • 卡片的具体配置信息。在上述FormExtensionAbility的元信息("metadata"配置项)中,可以指定卡片具体配置信息的索引资源。如当resource指定为$profile:form_config时,会使用"entry > src/main/resources > base > profile"目录下的form_config.json作为卡片profile配置文件。
属性名称含义数据类型是否可缺省
name表示卡片的类名,字符串最大的长度为127字节。字符串
description表示卡片的描述。取值可以时描述性内容,也可以是对描述内容的资源索引,以支持多语言。字符串最大长度为255字节。
 该属性将显示在卡片预览界面上,以便用户识别不同的卡片。
字符串可缺省,缺省为空。
src表示卡片对应的UI代码的完整路径。当为ArkTS卡片时,完整路径需要包含卡片文件的后缀,如:“./ets/widget/pages/WidgetCard.ets”。当为JS卡片式,完整路径无需包含卡片文件的后缀。字符串
uiSyntax表示该卡片的类型,当前支持如下两种类型:
- arkts:当前卡片为ArkTS卡片。
- hml:当前卡片为JS卡片。
字符串可缺省,缺省为hml
window用于定义与显示窗口相关的配置。对象可缺省
isDefault表示该卡片是否为默认卡片,每个UIAbility有且只有一个默认卡片。
- true:默认卡片。
- false:非默认卡片。
布尔值
colorMode表示卡片的主题样式,取值范围如下:
- auto:自适应。
- dark:深色主题。
- light:浅色主题。
字符串可缺省,缺省值为“auto”。
supportDimensions表示卡片支持的外观规格,取值范围:
- 1*2:表示1行2列的二宫格。
- 2*2:表示卡片为2行2列的四宫格。
- 2*4:表示2行4列的八宫格。
- 4*4:表示4行4列的十六宫格。
字符串数组
defaultDimension表示卡片的默认外观规格,取值必须在该卡片supportDimensions配置的列表中。字符串
updateEnabled表示卡片是否支持周期性刷新(包含定时刷新和定点刷新),取值范围:
- true:表示支持周期性刷新,可以在定时刷新(updateDuration)和定点刷新(scheduledUpdateTime)两种方式任选其一,当两者同时配置时,定时刷新优先生效。
- false:表示不支持周期性刷新。
布尔类型
scheduledUpdateTime表示卡片的定点刷新的时刻,采用24小时制,精确到分钟。
说明:updateDuration参数优先级高于scheduledUpdateTime,两者同时配置时,以updateDuration配置的刷新时间为准。
字符串可缺省,缺省时不进行定点刷新。
updateDuration表示卡片定时刷新的更新周期,单位为30分钟,取值为自然数。当取值为0时,表示该参数不生效。当取值为正整数N时,表示刷新周期为30*N分钟。
说明:updateDuration参数优先级高于scheduledUpdateTime,两者同时配置时,以updateDuration配置的刷新时间为准。
数值可缺省,缺省值为“0”。
formConfigAbility表示卡片的配置跳转链接,采用URI格式。字符串可缺省,缺省值为空。
formVisibleNotify标识是否允许卡片使用卡片可见性通知。字符串可缺省,缺省值为空。
metadata表示卡片的自定义信息,包含customizeData数组标签。对象可缺省,缺省值为空。

7.2.3 通过message事件刷新卡片内容

在卡片页面可以通过postCardAction接口触发message事件拉起FormExtensionAbility,然后由FormExtensionAbility刷新卡片内容。

  • 在页面中通过注册Button的onClick点击事件互调,并在回调中调用postCardAction接口触发事件至FormExtensionAbility。
  1. Image($r('app.media.game_start'))
  2. .width(120).height(54)
  3. .onClick(() => {
  4. postCardAction(this, {
  5. 'action': 'message',
  6. 'params': {
  7. 'functionName': 'getSudoPuzzle'
  8. }
  9. })
  10. })
复制
  • 在FormExtensionAbility的onFormEvent生命周期调用updateForm接口刷新卡片,通过getSudokuPuzzle()方法获取云函数生成的数独谜题和解,在刷新卡片时传递给卡片。
  1. onFormEvent(formId, message) {
  2. let params = JSON.parse(message);
  3. Log.info(Constants.LOG_TAG_NAME, `message ===> ${params.functionName}`);
  4. // Called when a specified message event defined by the form provider is triggered.
  5. if (params.functionName === "getSudoPuzzle") {
  6. let promise = PreferenceUtil.getPreference(this.context, Constants.GAME_LEVEL);
  7. promise.then((ret) => {
  8. let level = parseInt(ret);
  9. let puzzles = [], answers = [];
  10. getSudokuPuzzle(this.context, level).then((ret: string) => {
  11. let result: SudokuPuzzle = JSON.parse(ret);
  12. puzzles = result.original;
  13. answers = result.answer;
  14. let formData = {
  15. flag: true,
  16. puzzles: puzzles,
  17. answers: answers,
  18. level: level
  19. }
  20. let formBD = formBindingData.createFormBindingData(formData);
  21. Log.info(Constants.LOG_TAG_NAME, `level. ${JSON.stringify(formBD)}`);
  22. formProvider.updateForm(formId, formBD).then((data) => {
  23. Log.info(Constants.LOG_TAG_NAME, `FormAbility updateForm success. ${JSON.stringify(data)}`);
  24. }).catch((err) => {
  25. Log.error(Constants.LOG_TAG_NAME, `FormAbility updateForm failed. ${JSON.stringify(err)}`);
  26. })
  27. }).catch((err) => {
  28. Log.error(Constants.LOG_TAG_NAME, `cause: ${JSON.stringify(err)}`);
  29. })
  30. })
  31. }
  32. }
复制

卡片中需要使用@LocalStorageProp装饰器接收。

  1. @LocalStorageProp("puzzles") puzzles: Array<Array<number>> = [];
  2. @LocalStorageProp("answers") answers: Array<Array<Array<number>>> = [];
复制

7.2.4 卡片不支持TextInput的替代方案

ArkTS卡片具备JS卡片的全量能力,并且新增了动效能力和自定义绘制的能力,支持声明式的部分组件、事件、动效、数据管理、状态管理能力。在数独游戏中需要使用输入框录入谜题解,而ArkTS卡片暂时不具备TextInput组件能力,因此使用点击空白区域与数字按钮互换的方式替代TextInput组件能力。

  • 点击空白区域记录宫格坐标。
  1. Row() {}
  2. .backgroundColor(0xD1D3D5)
  3. .width(this.FULL_HEIGHT_PERCENT)
  4. .height(this.FULL_HEIGHT_PERCENT)
  5. .onClick(() => {
  6. this.selectArr = [i, j];
  7. })
复制
  • 点击数字按钮,填入空白区域,通过postCardAction将空白区域填入解的数组传递给FormExtensionAbility的onFormEvent方法。
  1. ForEach([1, 2, 3, 4, 5, 6, 7, 8, 9], (item: number) => {
  2. Button({ type: ButtonType.Normal }) {
  3. Text(item.toString()).fontSize(14).fontWeight(700)
  4. }
  5. .backgroundColor(Color.Orange)
  6. .borderRadius(4)
  7. .width(30).height(30)
  8. .fontSize(12)
  9. .onClick(() => {
  10. if (this.selectArr.length !== 0) {
  11. let row = this.selectArr[0];
  12. let col = this.selectArr[1];
  13. this.puzzles[row][col] = item;
  14. postCardAction(this, {
  15. 'action': 'message',
  16. 'params': {
  17. 'functionName': 'refresh',
  18. 'puzzles': this.puzzles
  19. }
  20. })
  21. this.userAnswer = this.puzzles;
  22. this.selectArr = [];
  23. }
  24. })
  25. })
复制
  • 在onFormEvent方法中根据params.functionName.refresh通过调用updateForm刷新卡片。
  1. if (params.functionName === 'refresh') {
  2. let formData = {
  3. puzzles: params.puzzles
  4. }
  5. let formBD = formBindingData.createFormBindingData(formData);
  6. formProvider.updateForm(formId, formBD);
  7. }
复制

7.2.5 卡片不支持setInterval的替代方案

在应用程序中可以使用setInterval进行计时操作,但当前ArkTS卡片不支持setInterval,因此使用new Date().getTime()开始时间和结束时间差值作为游戏时长替代setInterval方法。

7.3 闯关记录实时刷新的2*4卡片

使用第二种方式创建卡片,在"entry > src/main/ets > widget > pages"目录右键单击"New > ArkTS File"创建HistoryCard.ets文件,接着打开"entry > src/main/resources > base > profile"目录下的form_config.json文件,配置名称为history的2*4卡片。

  1. {
  2. "name": "history",
  3. "description": "历史闯关记录",
  4. "src": "./ets/widget/pages/HistoryCard.ets",
  5. "uiSyntax": "arkts",
  6. "window": {
  7. "designWidth": 720,
  8. "autoDesignWidth": true
  9. },
  10. "colorMode": "auto",
  11. "isDefault": false,
  12. "updateEnabled": false,
  13. "scheduledUpdateTime": "02:35",
  14. "updateDuration": 1,
  15. "defaultDimension": "2*4",
  16. "supportDimensions": [
  17. "2*4"
  18. ]
  19. }
复制
  • 在添加卡片时,将2*4卡片记录在缓存中并刷新卡片内容,移除卡片时删除缓存中对应的卡片信息。
  1. let formStorage = PreferenceUtil.getPreference(this.context, Constants.FORM_CARD_Dimension_2_4);
  2. formStorage.then((ret) =>{
  3. let formArr: Array<any> = new Array<any>();
  4. if (ret !== "") {
  5. formArr = JSON.parse(ret);
  6. formArr.push(formInfoStorage);
  7. } else {
  8. formArr.push(formInfoStorage);
  9. }
  10. PreferenceUtil.putPreference(this.context, Constants.FORM_CARD_Dimension_2_4, JSON.stringify(formArr));
  11. })
  12. let promise = PreferenceUtil.getPreference(this.context, Constants.HISTORY_RECORDS);
  13. promise.then((ret) => {
  14. if (ret !== "") {
  15. let historyArr: Array<History> = JSON.parse(ret);
  16. formData = {
  17. histories: historyArr
  18. }
  19. let formBD = formBindingData.createFormBindingData(formData);
  20. formProvider.updateForm(formId, formBD);
  21. return formBD;
  22. }
  23. })
复制
  • 闯关成功后,刷新所有已添加的2*4卡片内容,已达到闯关历史记录效果。
  1. PreferenceUtil.getPreference(this.context, Constants.HISTORY_RECORDS).then((ret) => {
  2. let historyArr: Array<History> = [];
  3. if (ret !== "") {
  4. historyArr = JSON.parse(ret);
  5. historyArr.push(history);
  6. } else {
  7. historyArr.push(history);
  8. }
  9. PreferenceUtil.putPreference(this.context, Constants.HISTORY_RECORDS, JSON.stringify(historyArr));
  10. let formStorage = PreferenceUtil.getPreference(this.context, Constants.FORM_CARD_Dimension_2_4);
  11. formStorage.then((ret) =>{
  12. if (ret !== "") {
  13. let formArr: Array<any> = JSON.parse(ret);
  14. formArr.forEach((item) => {
  15. let promise = PreferenceUtil.getPreference(this.context, Constants.HISTORY_RECORDS);
  16. promise.then((ret) => {
  17. if (ret !== "") {
  18. let historyArr: Array<History> = JSON.parse(ret);
  19. let formData = {
  20. histories: historyArr
  21. }
  22. let formBD = formBindingData.createFormBindingData(formData);
  23. formProvider.updateForm(item.formId, formBD);
  24. }
  25. })
  26. })
  27. }
  28. })
  29. })
复制

8 结语

大家可以在华为应用市场元服务专区、服务中心入口,体验已经上架的元服务。

最后,为了能够让大家跟上互联网时代的技术迭代,赶上互联网开发人员寒冬期间一波红利,在这里跟大家分享一下我自己近期学习心得以及参考网上资料整理出的一份最新版的鸿蒙学习提升资料,有需要的小伙伴自行领取,限时开源,先到先得~无套路领取!!!

 
声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/小丑西瓜9/article/detail/567211

推荐阅读
相关标签