基于当前的应用模型，可以通过以下几种方式来实现UIAbility组件与UI之间的数据同步。
- 使用EventHub进行数据通信：在基类Context中提供了EventHub对象，可以通过发布订阅方式来实现事件的传递。在事件传递前，订阅者需要先进行订阅，当发布者发布事件时，订阅者将接收到事件并进行相应处理。
- 使用AppStorage/LocalStorage进行数据同步：ArkUI提供了AppStorage和LocalStorage两种应用级别的状态管理方案，可用于实现应用级别和UIAbility级别的数据同步。
使用EventHub进行数据通信
EventHub为UIAbility组件提供了事件机制，使它们能够进行订阅、取消订阅和触发事件等数据通信能力。
在基类Context中，提供了EventHub对象，可用于在UIAbility组件实例内通信。使用EventHub实现UIAbility与UI之间的数据通信需要先获取EventHub对象，本章节将以此为例进行说明。
1.在EntryAbility中注册自定义事件
在UIAbility中调用eventHub.on()方法注册一个自定义事件“event1”，eventHub.on()有如下两种调用方式，使用其中一种即可。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
import { AbilityConstant, Context, UIAbility, Want } from '@kit.AbilityKit'; import { hilog } from '@kit.PerformanceAnalysisKit'; import { window } from '@kit.ArkUI'; const DOMAIN_NUMBER: number = 0xFF00 const TAG: string = '[EventAbility]' export default class EntryAbility extends UIAbility { onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void { // 获取eventHub let eventHub = this.context.eventHub // 执行订阅操作 eventHub.on('event1', this.eventFunc) eventHub.on('event1', (data: string) => { // 触发事件，完成相应业务操作 hilog.info(DOMAIN_NUMBER, TAG, 'no params') }) hilog.info(DOMAIN_NUMBER, TAG, '%{public}s', 'Ability onCreate') } eventFunc(argOne: Context, argTwo: Context): void { hilog.info(DOMAIN_NUMBER, TAG, '1. ' + `${argOne}, ${argTwo}`) return } onDestroy(): void | Promise<void> { this.context.eventHub.off('event1') } onWindowStageCreate(windowStage: window.WindowStage): void { // Main window is created, set main page for this ability hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageCreate'); windowStage.loadContent('pages/Index', (err) => { if (err.code) { hilog.error(0x0000, 'testTag', 'Failed to load the content. Cause: %{public}s', JSON.stringify(err) ?? ''); return; } hilog.info(0x0000, 'testTag', 'Succeeded in loading the content.'); }); } } |
2.在页面触发事件
在UI中通过eventHub.emit()方法触发该事件，在触发事件的同时，根据需要传入参数信息。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
import { common } from '@kit.AbilityKit' import { promptAction, router } from '@kit.ArkUI' import { hilog } from '@kit.PerformanceAnalysisKit' const DOMAIN_NUMBER: number = 0xFF00 const TAG: string = '[EventAbility]' @Entry @Component struct Index { private context = getContext(this) as common.UIAbilityContext eventHubFunc(): void { // 不带参数触发自定义"event1"事件 this.context.eventHub.emit('event1') // 带1个参数触发自定义"event1"事件 this.context.eventHub.emit('event1', 1) // 带2个参数触发自定义"event1"事件 this.context.eventHub.emit('event1', 2, 'text') } build() { Row() { Column({ space: 10 }) { Button('Open Second Page') .onClick(() => { router.pushUrl({ url: 'pages/Second' }) }) Button($r('app.string.EventHubFuncA')) .onClick(() => { this.eventHubFunc() promptAction.showToast({ message: $r('app.string.EventHubFuncA') }) }) Button($r('app.string.EventHubFuncB')) .onClick(() => { hilog.info(DOMAIN_NUMBER, TAG, 'event1 off') this.context.eventHub.off('event1') promptAction.showToast({ message: $r('app.string.EventHubFuncB') }) }) } .width('100%') } .height('100%') } } |
3.运行日志结果
在UIAbility的注册事件回调中可以得到对应的触发事件结果，运行日志结果如下所示。
|
1 2 3 4 5 6 7 8 9 |
07-17 16:07:39.914 4952-4952 A0ff00/[EventAbility] pid-4952 I Ability onCreate 07-17 16:07:42.246 4952-4952 A0ff00/[EventAbility] com.examp...litydata I 1. undefined, undefined 07-17 16:07:42.246 4952-4952 A0ff00/[EventAbility] com.examp...litydata I no params 07-17 16:07:42.246 4952-4952 A0ff00/[EventAbility] com.examp...litydata I 1. 1, undefined 07-17 16:07:42.246 4952-4952 A0ff00/[EventAbility] com.examp...litydata I no params 07-17 16:07:42.246 4952-4952 A0ff00/[EventAbility] com.examp...litydata I 1. 2, text 07-17 16:07:42.246 4952-4952 A0ff00/[EventAbility] com.examp...litydata I no params 07-17 16:28:16.552 4952-4952 A0ff00/[EventAbility] com.examp...litydata I event1 off 07-17 16:28:17.670 4952-4952 A0ff00/[EventAbility] com.examp...litydata I event1 off |
4.取消订阅
在自定义事件“event1”使用完成后，可以根据需要调用eventHub.off()方法取消该事件的订阅。
|
1 2 3 4 5 6 7 8 |
import { UIAbility } from '@kit.AbilityKit'; export default class EntryAbility extends UIAbility { // ... onDestroy(): void { this.context.eventHub.off('event1'); } } |
5.gif演示
6.源码下载
使用AppStorage/LocalStorage进行数据同步
ArkUI提供了AppStorage和LocalStorage两种应用级别的状态管理方案，可用于实现应用级别和UIAbility级别的数据同步。使用这些方案可以方便地管理应用状态，提高应用性能和用户体验。其中，AppStorage是一个全局的状态管理器，适用于多个UIAbility共享同一状态数据的情况；而LocalStorage则是一个局部的状态管理器，适用于单个UIAbility内部使用的状态数据。通过这两种方案，开发者可以更加灵活地控制应用状态，提高应用的可维护性和可扩展性。详细请参见应用级变量的状态管理。
