【鸿蒙开发基础学习】UIAbility 组件与 UI 的数据同步

UIAbility 组件与 UI 的数据同步

基于当前的应用模型，可以通过以下几种方式来实现 UIAbility 组件与 UI 之间的数据同步。

1. 使用 EventHub 进行数据通信：在基类 Context 中提供了 EventHub 对象，可以通过发布订阅方式来实现事件的传递。在事件传递前，订阅者需要先进行订阅，当发布者发布事件时，订阅者将接收到事件并进行相应处理。
2. 使用 AppStorage/LocalStorage 进行数据同步：ArkUI 提供了 AppStorage 和 LocalStorage 两种应用级别的状态管理方案，可用于实现应用级别和 UIAbility 级别的数据同步。

使用 EventHub 进行数据通信

EventHub 为 UIAbility 组件提供了事件机制，使它们能够进行订阅、取消订阅和触发事件等数据通信能力。

在基类 Context 中，提供了 EventHub 对象，可用于在 UIAbility 组件实例内通信。使用 EventHub 实现 UIAbility 与 UI 之间的数据通信需要先获取 EventHub 对象，本章节将以此为例进行说明。

在 UIAbility 中调用 eventHub.on() 方法注册一个自定义事件“event1”，eventHub.on() 有如下两种调用方式，使用其中一种即可。

import { hilog } from '@kit.PerformanceAnalysisKit';
import { UIAbility, Context, Want, AbilityConstant } from '@kit.AbilityKit';

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, '%{public}s', 'Ability onCreate');
  } 

  //... 
  eventFunc(argOne: Context, argTwo: Context): void {
    hilog.info(DOMAIN_NUMBER, TAG, '1. ' `${argOne}, ${argTwo}`);
    return; 
  } 
} 

在 UI 中通过 eventHub.emit() 方法触发该事件，在触发事件的同时，根据需要传入参数信息。

import { common } from '@kit.AbilityKit';
import { promptAction } from '@kit.ArkUI';

@Entry 
@Component 
struct Page_EventHub { 
  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, 'test');
    // 开发者可以根据实际的业务场景设计事件传递的参数
  } 

  build() { 
    Column() { 
      //... 
      List({ initialIndex: 0 }) { 
        ListItem() { 
          Row() { 
            //... 
          } 
         .onClick(() => { 
            this.eventHubFunc(); 
            promptAction.showToast({
              message: $r('app.string.EventHubFuncA')
            }); 
          }) 
        } 

        //... 
        ListItem() { 
          Row() { 
            //... 
          } 
         .onClick(() => { 
            this.context.eventHub.off('event1');
            promptAction.showToast({
              message: $r('app.string.EventHubFuncB')
            }); 
          }) 
        } 
        //... 
      } 
      //... 
    } 
    //... 
  } 
} 

在 UIAbility 的注册事件回调中可以得到对应的触发事件结果，运行日志结果如下所示。

[Example].[Entry].[EntryAbility] 1. []
[Example].[Entry].[EntryAbility] 1. [1]
[Example].[Entry].[EntryAbility] 1. [2,"test"]

在自定义事件“event1”使用完成后，可以根据需要调用 eventHub.off() 方法取消该事件的订阅。

import { UIAbility } from '@kit.AbilityKit';

export default class EntryAbility extends UIAbility {
  //... 
  onDestroy(): void { 
    this.context.eventHub.off('event1');
  } 
} 

使用 AppStorage/LocalStorage 进行数据同步

ArkUI 提供了 AppStorage 和 LocalStorage 两种应用级别的状态管理方案，可用于实现应用级别和 UIAbility 级别的数据同步。使用这些方案可以方便地管理应用状态，提高应用性能和用户体验。其中，AppStorage 是一个全局的状态管理器，适用于多个 UIAbility 共享同一状态数据的情况；而 LocalStorage 则是一个局部的状态管理器，适用于单个 UIAbility 内部使用的状态数据。通过这两种方案，开发者可以更加灵活地控制应用状态，提高应用的可维护性和可扩展性。