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