UIAbility组件与UI的数据同步

2024-01-25 12:15 更新

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

使用EventHub进行数据通信

EventHub提供了UIAbility组件/ExtensionAbility组件级别的事件机制,以UIAbility组件/ExtensionAbility组件为中心提供了订阅、取消订阅和触发事件的数据通信能力。接口说明请参见EventHub

在使用EventHub之前,首先需要获取EventHub对象。基类Context提供了EventHub对象,本章节以使用EventHub实现UIAbility与UI之间的数据通信为例进行说明。

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

    1. import UIAbility from '@ohos.app.ability.UIAbility';
    2. const TAG: string = '[Example].[Entry].[EntryAbility]';
    3. export default class EntryAbility extends UIAbility {
    4. func1(...data) {
    5. // 触发事件,完成相应的业务操作
    6. console.info(TAG, '1. ' + JSON.stringify(data));
    7. }
    8. onCreate(want, launch) {
    9. // 获取eventHub
    10. let eventhub = this.context.eventHub;
    11. // 执行订阅操作
    12. eventhub.on('event1', this.func1);
    13. eventhub.on('event1', (...data) => {
    14. // 触发事件,完成相应的业务操作
    15. console.info(TAG, '2. ' + JSON.stringify(data));
    16. });
    17. }
    18. }
  2. 在UI界面中通过eventHub.emit()方法触发该事件,在触发事件的同时,根据需要传入参数信息。

    1. import common from '@ohos.app.ability.common';
    2. @Entry
    3. @Component
    4. struct Index {
    5. private context = getContext(this) as common.UIAbilityContext;
    6. eventHubFunc() {
    7. // 不带参数触发自定义“event1”事件
    8. this.context.eventHub.emit('event1');
    9. // 带1个参数触发自定义“event1”事件
    10. this.context.eventHub.emit('event1', 1);
    11. // 带2个参数触发自定义“event1”事件
    12. this.context.eventHub.emit('event1', 2, 'test');
    13. // 开发者可以根据实际的业务场景设计事件传递的参数
    14. }
    15. // 页面展示
    16. build() {
    17. // ...
    18. }
    19. }
  3. 在UIAbility的注册事件回调中可以得到对应的触发事件结果,运行日志结果如下所示。

    1. []
    2. [1]
    3. [2,'test']
  4. 在自定义事件“event1”使用完成后,可以根据需要调用eventHub.off()方法取消该事件的订阅。

    1. // context为UIAbility实例的AbilityContext
    2. this.context.eventHub.off('event1');

使用globalThis进行数据同步

globalThis是ArkTS引擎实例内部的一个全局对象,引擎内部的UIAbility/ExtensionAbility/Page都可以使用,因此可以使用globalThis全局对象进行数据同步。

图1 使用globalThis进行数据同步

如上图所示,下面来具体介绍globalThis的使用:

UIAbility和Page之间使用globalThis

globalThis为ArkTS引擎实例下的全局对象,可以通过globalThis绑定属性/方法来进行UIAbility组件与UI的数据同步。例如在UIAbility组件中绑定want参数,即可在UIAbility对应的UI界面上使用want参数信息。

  1. 调用startAbility()方法启动一个UIAbility实例时,被启动的UIAbility创建完成后会进入onCreate()生命周期回调,且在onCreate()生命周期回调中能够接受到传递过来的want参数,可以将want参数绑定到globalThis上。

    1. import UIAbility from '@ohos.app.ability.UIAbility'
    2. export default class EntryAbility extends UIAbility {
    3. onCreate(want, launch) {
    4. globalThis.entryAbilityWant = want;
    5. // ...
    6. }
    7. // ...
    8. }
  2. 在UI界面中即可通过globalThis获取到want参数信息。

    1. let entryAbilityWant;
    2. @Entry
    3. @Component
    4. struct Index {
    5. aboutToAppear() {
    6. entryAbilityWant = globalThis.entryAbilityWant;
    7. }
    8. // 页面展示
    9. build() {
    10. // ...
    11. }
    12. }

UIAbility和UIAbility之间使用globalThis

同一个应用中UIAbility和UIAbility之间的数据传递,可以通过将数据绑定到全局变量globalThis上进行同步,如在AbilityA中将数据保存在globalThis,然后跳转到AbilityB中取得该数据:

  1. AbilityA中保存数据一个字符串数据并挂载到globalThis上。

    1. import UIAbility from '@ohos.app.ability.UIAbility'
    2. export default class AbilityA extends UIAbility {
    3. onCreate(want, launch) {
    4. globalThis.entryAbilityStr = 'AbilityA'; // AbilityA存放字符串“AbilityA”到globalThis
    5. // ...
    6. }
    7. }
  2. AbilityB中获取对应的数据。

    1. import UIAbility from '@ohos.app.ability.UIAbility'
    2. export default class AbilityB extends UIAbility {
    3. onCreate(want, launch) {
    4. // AbilityB从globalThis读取name并输出
    5. console.info('name from entryAbilityStr: ' + globalThis.entryAbilityStr);
    6. // ...
    7. }
    8. }

globalThis使用的注意事项

图2 globalThis注意事项

  • Stage模型下进程内的UIAbility组件共享ArkTS引擎实例,使用globalThis时需要避免存放相同名称的对象。例如AbilityA和AbilityB可以使用globalThis共享数据,在存放相同名称的对象时,先存放的对象会被后存放的对象覆盖。

  • FA模型因为每个UIAbility组件之间引擎隔离,不会存在该问题。

  • 对于绑定在globalThis上的对象,其生命周期与ArkTS虚拟机实例相同,建议在使用完成之后将其赋值为null,以减少对应用内存的占用。

Stage模型上同名对象覆盖导致问题的场景举例说明。

  1. 在AbilityA文件中使用globalThis存放了UIAbilityContext

    1. import UIAbility from '@ohos.app.ability.UIAbility'
    2. export default class AbilityA extends UIAbility {
    3. onCreate(want, launch) {
    4. globalThis.context = this.context; // AbilityA存放context到globalThis
    5. // ...
    6. }
    7. }
  2. 在AbilityA的页面中获取该UIAbilityContext并进行使用。使用完成后将AbilityA实例切换至后台。

    1. @Entry
    2. @Component
    3. struct Index {
    4. onPageShow() {
    5. let ctx = globalThis.context; // 页面中从globalThis中取出context并使用
    6. let permissions = ['com.example.permission']
    7. ctx.requestPermissionsFromUser(permissions,(result) => {
    8. // ...
    9. });
    10. }
    11. // 页面展示
    12. build() {
    13. // ...
    14. }
    15. }
  3. 在AbilityB文件中使用globalThis存放了UIAbilityContext,并且命名为相同的名称。

    1. import UIAbility from '@ohos.app.ability.UIAbility'
    2. export default class AbilityB extends UIAbility {
    3. onCreate(want, launch) {
    4. // AbilityB覆盖了AbilityA在globalThis中存放的context
    5. globalThis.context = this.context;
    6. // ...
    7. }
    8. }
  4. 在AbilityB的页面中获取该UIAbilityContext并进行使用。此时获取到的globalThis.context已经表示为AbilityB中赋值的UIAbilityContext内容。

    1. @Entry
    2. @Component
    3. struct Index {
    4. onPageShow() {
    5. let ctx = globalThis.context; // Page中从globalThis中取出context并使用
    6. let permissions = ['com.example.permission']
    7. ctx.requestPermissionsFromUser(permissions,(result) => {
    8. console.info('requestPermissionsFromUser result:' + JSON.stringify(result));
    9. });
    10. }
    11. // 页面展示
    12. build() {
    13. // ...
    14. }
    15. }
  5. 在AbilityB实例切换至后台,将AbilityA实例从后台切换回到前台。此时AbilityA的onCreate生命周期不会再次进入。

    1. import UIAbility from '@ohos.app.ability.UIAbility'
    2. export default class AbilityA extends UIAbility {
    3. onCreate(want, launch) { // AbilityA从后台进入前台,不会再走这个生命周期
    4. globalThis.context = this.context;
    5. // ...
    6. }
    7. }
  6. 在AbilityA的页面再次回到前台时,其获取到的globalThis.context表示的为AbilityB的UIAbilityContext,而不是AbilityA的UIAbilityContext,在AbilityA的页面中使用则会出错。

    1. @Entry
    2. @Component
    3. struct Index {
    4. onPageShow() {
    5. let ctx = globalThis.context; // 这时候globalThis中的context是AbilityB的context
    6. let permissions=['com.example.permission'];
    7. ctx.requestPermissionsFromUser(permissions,(result) => { // 使用这个对象就会导致进程崩溃
    8. console.info('requestPermissionsFromUser result:' + JSON.stringify(result));
    9. });
    10. }
    11. // 页面展示
    12. build() {
    13. // ...
    14. }
    15. }

使用AppStorage/LocalStorage进行数据同步

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

以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号