• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# UIAbility组件与UI的数据同步
2
3
4基于OpenHarmony的应用模型，可以通过以下几种方式来实现UIAbility组件与UI之间的数据同步。
5
6- [使用EventHub进行数据通信](#使用eventhub进行数据通信)：在基类Context中提供了EventHub对象，可以通过发布订阅方式来实现事件的传递。在事件传递前，订阅者需要先进行订阅，当发布者发布事件时，订阅者将接收到事件并进行相应处理。
7- [使用AppStorage/LocalStorage进行数据同步](#使用appstorage/localstorage进行数据同步)：ArkUI提供了AppStorage和LocalStorage两种应用级别的状态管理方案，可用于实现应用级别和UIAbility级别的数据同步。
8
9
10## 使用EventHub进行数据通信
11
12[EventHub](../reference/apis/js-apis-inner-application-eventHub.md)为UIAbility组件提供了事件机制，使它们能够进行订阅、取消订阅和触发事件等数据通信能力。
13
14在[基类Context](application-context-stage.md)中，提供了EventHub对象，可用于在UIAbility组件实例内通信。使用EventHub实现UIAbility与UI之间的数据通信需要先获取EventHub对象，本章节将以此为例进行说明。
15
161. 在UIAbility中调用[`eventHub.on()`](../reference/apis/js-apis-inner-application-eventHub.md#eventhubon)方法注册一个自定义事件“event1”，[`eventHub.on()`](../reference/apis/js-apis-inner-application-eventHub.md#eventhubon)有如下两种调用方式，使用其中一种即可。
17
18   ```ts
19   import UIAbility from '@ohos.app.ability.UIAbility';
20   import AbilityConstant from '@ohos.app.ability.AbilityConstant';
21   import Want from '@ohos.app.ability.Want';
22
23   const TAG: string = '[Example].[Entry].[EntryAbility]';
24
25   export default class EntryAbility extends UIAbility {
26     func1(data: string) {
27       // 触发事件，完成相应的业务操作
28       console.info(TAG, '1. ' + JSON.stringify(data));
29     }
30
31     onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
32       // 获取eventHub
33       let eventhub = this.context.eventHub;
34       // 执行订阅操作
35       eventhub.on('event1', this.func1);
36       eventhub.on('event1', (data: string) => {
37         // 触发事件，完成相应的业务操作
38         console.info(TAG, '2. ' + JSON.stringify(data));
39       });
40     }
41   }
42   ```
43
442. 在UI中通过[eventHub.emit()](../reference/apis/js-apis-inner-application-eventHub.md#eventhubemit)方法触发该事件，在触发事件的同时，根据需要传入参数信息。
45
46   ```ts
47   import common from '@ohos.app.ability.common';
48
49   @Entry
50   @Component
51   struct Index {
52     private context = getContext(this) as common.UIAbilityContext;
53
54     eventHubFunc() {
55       // 不带参数触发自定义“event1”事件
56       this.context.eventHub.emit('event1');
57       // 带1个参数触发自定义“event1”事件
58       this.context.eventHub.emit('event1', 1);
59       // 带2个参数触发自定义“event1”事件
60       this.context.eventHub.emit('event1', 2, 'test');
61       // 开发者可以根据实际的业务场景设计事件传递的参数
62     }
63
64     // 页面展示
65     build() {
66       Button('按钮')
67         .onClick(() => {
68           this.eventHubFunc();
69         })
70       Button('关闭')
71         .onClick(() => {
72           this.context.eventHub.off('event1');
73         })
74     }
75   }
76   ```
77
783. 在UIAbility的注册事件回调中可以得到对应的触发事件结果，运行日志结果如下所示。
79
80   ```json
81   [Example].[Entry].[EntryAbility] 1. []
82   [Example].[Entry].[EntryAbility] 2. []
83   [Example].[Entry].[EntryAbility] 1. [1]
84   [Example].[Entry].[EntryAbility] 2. [1]
85   [Example].[Entry].[EntryAbility] 1. [2,"test"]
86   [Example].[Entry].[EntryAbility] 2. [2,"test"]
87   ```
88
894. 在自定义事件“event1”使用完成后，可以根据需要调用[eventHub.off()](../reference/apis/js-apis-inner-application-eventHub.md#eventhuboff)方法取消该事件的订阅。
90
91   ```ts
92   // context为UIAbility实例的AbilityContext
93   this.context.eventHub.off('event1');
94   ```
95
96## 使用AppStorage/LocalStorage进行数据同步
97
98ArkUI提供了AppStorage和LocalStorage两种应用级别的状态管理方案，可用于实现应用级别和UIAbility级别的数据同步。使用这些方案可以方便地管理应用状态，提高应用性能和用户体验。其中，AppStorage是一个全局的状态管理器，适用于多个UIAbility共享同一状态数据的情况；而LocalStorage则是一个局部的状态管理器，适用于单个UIAbility内部使用的状态数据。通过这两种方案，开发者可以更加灵活地控制应用状态，提高应用的可维护性和可扩展性。详细请参见[应用级变量的状态管理](../quick-start/arkts-application-state-management-overview.md)。
99