未验证 提交 04cfaff9 编写于 作者: O openharmony_ci 提交者: Gitee

!14896 【轻量级 PR】:update zh-cn/application-dev/application-models/uiability-data-sync-with-ui.md.

Merge pull request !14896 from zyjhandsome/N/A
# UIAbility组件与UI的数据同步 # UIAbility组件与UI的数据同步
基于OpenHarmony的应用模型,可以通过以下种方式来实现UIAbility组件与UI之间的数据同步。 基于OpenHarmony的应用模型,可以通过以下种方式来实现UIAbility组件与UI之间的数据同步。
- [使用EventHub进行数据通信](#使用eventhub进行数据通信):在基类Context中提供了EventHub对象,可以通过发布订阅方式来实现事件的传递。在事件传递前,订阅者需要先进行订阅,当发布者发布事件时,订阅者将接收到事件并进行相应处理。
1. EventHub:基于发布订阅模式来实现,事件需要先订阅后发布,订阅者收到消息后进行处理。 - [使用globalThis进行数据同步](#使用globalthis进行数据同步):在ArkTS引擎实例内部,globalThis是一个全局对象,可以被UIAbility、ExtensionAbility、Page等组件访问。
- [使用AppStorage/LocalStorage进行数据同步](#使用appstorage/localstorage进行数据同步):ArkUI提供了AppStorage和LocalStorage两种应用级别的状态管理方案,可用于实现应用级别和UIAbility级别的数据同步。
2. globalThis:ArkTS引擎实例内部的一个全局对象,在ArkTS引擎实例内部都能访问。
## 使用EventHub进行数据通信 ## 使用EventHub进行数据通信
EventHub提供了UIAbility组件/ExtensionAbility组件级别的事件机制,以UIAbility组件/ExtensionAbility组件为中心提供了订阅、取消订阅和触发事件的数据通信能力。接口说明请参见[EventHub](../reference/apis/js-apis-inner-application-eventHub.md) [EventHub](../reference/apis/js-apis-inner-application-eventHub.md)为UIAbility组件/ExtensionAbility组件提供了事件机制,使它们能够进行订阅、取消订阅和触发事件等数据通信能力
使用EventHub之前,首先需要获取EventHub对象。[基类Context](application-context-stage.md)提供了EventHub对象,本章节以使用EventHub实现UIAbility与UI之间的数据通信为例进行说明。 [基类Context](application-context-stage.md)中,提供了EventHub对象,使用EventHub实现UIAbility与UI之间的数据通信需要先获取EventHub对象。本章节将以此为例进行说明。
1. 在UIAbility中调用eventHub.on()方法注册一个自定义事件“event1”,eventHub.on()有如下两种调用方式,使用其中一种即可。 1. 在UIAbility中调用[eventHub.on()](../reference/apis/js-apis-inner-application-eventHub.md#eventhubon)方法注册一个自定义事件“event1”,[eventHub.on()](../reference/apis/js-apis-inner-application-eventHub.md#eventhubon)有如下两种调用方式,使用其中一种即可。
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
...@@ -41,7 +40,7 @@ EventHub提供了UIAbility组件/ExtensionAbility组件级别的事件机制, ...@@ -41,7 +40,7 @@ EventHub提供了UIAbility组件/ExtensionAbility组件级别的事件机制,
} }
``` ```
2. 在UI界面中通过eventHub.emit()方法触发该事件,在触发事件的同时,根据需要传入参数信息。 2. 在UI界面中通过[eventHub.emit()](../reference/apis/js-apis-inner-application-eventHub.md#eventhubemit)方法触发该事件,在触发事件的同时,根据需要传入参数信息。
```ts ```ts
import common from '@ohos.app.ability.common'; import common from '@ohos.app.ability.common';
...@@ -78,7 +77,7 @@ EventHub提供了UIAbility组件/ExtensionAbility组件级别的事件机制, ...@@ -78,7 +77,7 @@ EventHub提供了UIAbility组件/ExtensionAbility组件级别的事件机制,
[2,'test'] [2,'test']
``` ```
4. 在自定义事件“event1”使用完成后,可以根据需要调用eventHub.off()方法取消该事件的订阅。 4. 在自定义事件“event1”使用完成后,可以根据需要调用[eventHub.off()](../reference/apis/js-apis-inner-application-eventHub.md#eventhuboff)方法取消该事件的订阅。
```ts ```ts
// context为UIAbility实例的AbilityContext // context为UIAbility实例的AbilityContext
...@@ -88,8 +87,7 @@ EventHub提供了UIAbility组件/ExtensionAbility组件级别的事件机制, ...@@ -88,8 +87,7 @@ EventHub提供了UIAbility组件/ExtensionAbility组件级别的事件机制,
## 使用globalThis进行数据同步 ## 使用globalThis进行数据同步
globalThis是[ArkTS引擎实例](thread-model-stage.md)内部的一个全局对象,引擎内部的UIAbility/ExtensionAbility/Page都可以使用,因此可以使用globalThis对象进行数据同步。
globalThis是ArkTS引擎实例内部的一个全局对象,引擎内部的UIAbility/ExtensionAbility/Page都可以使用,因此可以使用globalThis全局对象进行数据同步。
**图1** 使用globalThis进行数据同步 **图1** 使用globalThis进行数据同步
...@@ -105,12 +103,12 @@ globalThis是ArkTS引擎实例内部的一个全局对象,引擎内部的UIAbi ...@@ -105,12 +103,12 @@ globalThis是ArkTS引擎实例内部的一个全局对象,引擎内部的UIAbi
### UIAbility和Page之间使用globalThis ### UIAbility和Page之间使用globalThis
globalThis为[ArkTS引擎实例](thread-model-stage.md)下的全局对象,可以通过globalThis绑定属性/方法来进行UIAbility组件与UI的数据同步。例如在UIAbility组件中绑定want参数,即可在UIAbility对应的UI界面上使用want参数信息。 通过在globalThis对象上绑定属性/方法,可以实现UIAbility组件与UI之间的数据同步。例如在UIAbility组件中绑定want参数,即可在UIAbility对应的UI界面上使用want参数信息。
1. 调用startAbility()方法启动一个UIAbility实例时,被启动的UIAbility创建完成后会进入onCreate()生命周期回调,且在onCreate()生命周期回调中能够接受到传递过来的want参数,可以将want参数绑定到globalThis上。 1. 调用[startAbility()](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability)方法启动一个UIAbility实例时,被启动的UIAbility创建完成后会进入onCreate()生命周期回调,且在onCreate()生命周期回调中能够接受到传递过来的want参数,可以将want参数绑定到globalThis上。
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility' import UIAbility from '@ohos.app.ability.UIAbility';
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onCreate(want, launch) { onCreate(want, launch) {
...@@ -144,29 +142,29 @@ globalThis为[ArkTS引擎实例](thread-model-stage.md)下的全局对象,可 ...@@ -144,29 +142,29 @@ globalThis为[ArkTS引擎实例](thread-model-stage.md)下的全局对象,可
### UIAbility和UIAbility之间使用globalThis ### UIAbility和UIAbility之间使用globalThis
同一个应用中UIAbility和UIAbility之间的数据传递,可以通过将数据绑定到全局变量globalThis上进行同步,如在AbilityA中将数据保存在globalThis,然后跳转到AbilityB中取得该数据: 在同一个应用中,UIAbility与UIAbility之间的数据传递可以通过将数据绑定到全局变量globalThis上进行同步。例如,在UIAbilityA中将数据保存在globalThis对象中,然后跳转到UIAbilityB中就可以获取该数据。
1. AbilityA中保存数据一个字符串数据并挂载到globalThis上。 1. UIAbilityA中保存数据一个字符串数据并挂载到globalThis上。
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility' import UIAbility from '@ohos.app.ability.UIAbility'
export default class AbilityA extends UIAbility { export default class UIAbilityA extends UIAbility {
onCreate(want, launch) { onCreate(want, launch) {
globalThis.entryAbilityStr = 'AbilityA'; // AbilityA存放字符串“AbilityA”到globalThis globalThis.entryAbilityStr = 'UIAbilityA'; // UIAbilityA存放字符串“UIAbilityA”到globalThis
// ... // ...
} }
} }
``` ```
2. AbilityB中获取对应的数据。 2. UIAbilityB中获取对应的数据。
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility' import UIAbility from '@ohos.app.ability.UIAbility'
export default class AbilityB extends UIAbility { export default class UIAbilityB extends UIAbility {
onCreate(want, launch) { onCreate(want, launch) {
// AbilityB从globalThis读取name并输出 // UIAbilityB从globalThis读取name并输出
console.info('name from entryAbilityStr: ' + globalThis.entryAbilityStr); console.info('name from entryAbilityStr: ' + globalThis.entryAbilityStr);
// ... // ...
} }
...@@ -176,17 +174,17 @@ globalThis为[ArkTS引擎实例](thread-model-stage.md)下的全局对象,可 ...@@ -176,17 +174,17 @@ globalThis为[ArkTS引擎实例](thread-model-stage.md)下的全局对象,可
### UIAbility和ExtensionAbility之间使用globalThis ### UIAbility和ExtensionAbility之间使用globalThis
同一个应用中UIAbility和ExtensionAbility之间的数据传递,也可以通过将数据绑定到全局变量globalThis上进行同步,如在AbilityA中保存数据,在ServiceExtensionAbility中获取数据。 在同一个应用中,UIAbility和ExtensionAbility之间的数据传递也可以通过将数据绑定到全局变量globalThis上进行同步。例如,在UIAbilityA中保存数据,在ServiceExtensionAbility中就可以获取该数据。
1. AbilityA中保存数据一个字符串数据并挂载到globalThis上。 1. UIAbilityA中保存数据一个字符串数据并挂载到globalThis上。
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility' import UIAbility from '@ohos.app.ability.UIAbility'
export default class AbilityA extends UIAbility { export default class UIAbilityA extends UIAbility {
onCreate(want, launch) { onCreate(want, launch) {
// AbilityA存放字符串“AbilityA”到globalThis // UIAbilityA存放字符串“UIAbilityA”到globalThis
globalThis.entryAbilityStr = 'AbilityA'; globalThis.entryAbilityStr = 'UIAbilityA';
// ... // ...
} }
} }
...@@ -213,7 +211,7 @@ globalThis为[ArkTS引擎实例](thread-model-stage.md)下的全局对象,可 ...@@ -213,7 +211,7 @@ globalThis为[ArkTS引擎实例](thread-model-stage.md)下的全局对象,可
![globalThis2](figures/globalThis2.png) ![globalThis2](figures/globalThis2.png)
- Stage模型下进程内的UIAbility组件共享ArkTS引擎实例,使用globalThis时需要避免存放相同名称的对象。例如AbilityA和AbilityB可以使用globalThis共享数据,在存放相同名称的对象时,先存放的对象会被后存放的对象覆盖。 - Stage模型下进程内的UIAbility组件共享ArkTS引擎实例,使用globalThis时需要避免存放相同名称的对象。例如UIAbilityA和UIAbilityB可以使用globalThis共享数据,在存放相同名称的对象时,先存放的对象会被后存放的对象覆盖。
- FA模型因为每个UIAbility组件之间引擎隔离,不会存在该问题。 - FA模型因为每个UIAbility组件之间引擎隔离,不会存在该问题。
...@@ -221,20 +219,20 @@ globalThis为[ArkTS引擎实例](thread-model-stage.md)下的全局对象,可 ...@@ -221,20 +219,20 @@ globalThis为[ArkTS引擎实例](thread-model-stage.md)下的全局对象,可
Stage模型上同名对象覆盖导致问题的场景举例说明。 Stage模型上同名对象覆盖导致问题的场景举例说明。
1. 在AbilityA文件中使用globalThis中存放了[UIAbilityContext](../reference/apis/js-apis-inner-application-uiAbilityContext.md) 1.UIAbilityA文件中使用globalThis中存放了[UIAbilityContext](../reference/apis/js-apis-inner-application-uiAbilityContext.md)
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility' import UIAbility from '@ohos.app.ability.UIAbility'
export default class AbilityA extends UIAbility { export default class UIAbilityA extends UIAbility {
onCreate(want, launch) { onCreate(want, launch) {
globalThis.context = this.context; // AbilityA存放context到globalThis globalThis.context = this.context; // UIAbilityA存放context到globalThis
// ... // ...
} }
} }
``` ```
2.AbilityA的页面中获取该[UIAbilityContext](../reference/apis/js-apis-inner-application-uiAbilityContext.md)并进行使用。使用完成后将AbilityA实例切换至后台。 2.UIAbilityA的页面中获取该[UIAbilityContext](../reference/apis/js-apis-inner-application-uiAbilityContext.md)并进行使用。使用完成后将UIAbilityA实例切换至后台。
```ts ```ts
@Entry @Entry
...@@ -254,21 +252,21 @@ Stage模型上同名对象覆盖导致问题的场景举例说明。 ...@@ -254,21 +252,21 @@ Stage模型上同名对象覆盖导致问题的场景举例说明。
} }
``` ```
3. 在AbilityB文件中使用globalThis中存放了[UIAbilityContext](../reference/apis/js-apis-inner-application-uiAbilityContext.md),并且命名为相同的名称。 3.UIAbilityB文件中使用globalThis中存放了[UIAbilityContext](../reference/apis/js-apis-inner-application-uiAbilityContext.md),并且命名为相同的名称。
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility' import UIAbility from '@ohos.app.ability.UIAbility'
export default class AbilityB extends UIAbility { export default class UIAbilityB extends UIAbility {
onCreate(want, launch) { onCreate(want, launch) {
// AbilityB覆盖了AbilityA在globalThis中存放的context // UIAbilityB覆盖了UIAbilityA在globalThis中存放的context
globalThis.context = this.context; globalThis.context = this.context;
// ... // ...
} }
} }
``` ```
4.AbilityB的页面中获取该[UIAbilityContext](../reference/apis/js-apis-inner-application-uiAbilityContext.md)并进行使用。此时获取到的globalThis.context已经表示为AbilityB中赋值的[UIAbilityContext](../reference/apis/js-apis-inner-application-uiAbilityContext.md)内容。 4.UIAbilityB的页面中获取该[UIAbilityContext](../reference/apis/js-apis-inner-application-uiAbilityContext.md)并进行使用。此时获取到的globalThis.context已经表示为UIAbilityB中赋值的[UIAbilityContext](../reference/apis/js-apis-inner-application-uiAbilityContext.md)内容。
```ts ```ts
@Entry @Entry
...@@ -288,27 +286,27 @@ Stage模型上同名对象覆盖导致问题的场景举例说明。 ...@@ -288,27 +286,27 @@ Stage模型上同名对象覆盖导致问题的场景举例说明。
} }
``` ```
5.AbilityB实例切换至后台,将AbilityA实例从后台切换回到前台。此时AbilityA的onCreate生命周期不会再次进入。 5.UIAbilityB实例切换至后台,将UIAbilityA实例从后台切换回到前台。此时UIAbilityA的onCreate生命周期不会再次进入。
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility' import UIAbility from '@ohos.app.ability.UIAbility'
export default class AbilityA extends UIAbility { export default class UIAbilityA extends UIAbility {
onCreate(want, launch) { // AbilityA从后台进入前台,不会再走这个生命周期 onCreate(want, launch) { // UIAbilityA从后台进入前台,不会再走这个生命周期
globalThis.context = this.context; globalThis.context = this.context;
// ... // ...
} }
} }
``` ```
6.AbilityA的页面再次回到前台时,其获取到的globalThis.context表示的为AbilityB的[UIAbilityContext](../reference/apis/js-apis-inner-application-uiAbilityContext.md),而不是AbilityA的[UIAbilityContext](../reference/apis/js-apis-inner-application-uiAbilityContext.md),在AbilityA的页面中使用则会出错。 6.UIAbilityA的页面再次回到前台时,其获取到的globalThis.context表示的为UIAbilityB的[UIAbilityContext](../reference/apis/js-apis-inner-application-uiAbilityContext.md),而不是UIAbilityA的[UIAbilityContext](../reference/apis/js-apis-inner-application-uiAbilityContext.md),在UIAbilityA的页面中使用则会出错。
```ts ```ts
@Entry @Entry
@Component @Component
struct Index { struct Index {
onPageShow() { onPageShow() {
let ctx = globalThis.context; // 这时候globalThis中的context是AbilityB的context let ctx = globalThis.context; // 这时候globalThis中的context是UIAbilityB的context
let permissions=['com.example.permission']; let permissions=['com.example.permission'];
ctx.requestPermissionsFromUser(permissions,(result) => { // 使用这个对象就会导致进程崩溃 ctx.requestPermissionsFromUser(permissions,(result) => { // 使用这个对象就会导致进程崩溃
console.info('requestPermissionsFromUser result:' + JSON.stringify(result)); console.info('requestPermissionsFromUser result:' + JSON.stringify(result));
...@@ -320,3 +318,7 @@ Stage模型上同名对象覆盖导致问题的场景举例说明。 ...@@ -320,3 +318,7 @@ Stage模型上同名对象覆盖导致问题的场景举例说明。
} }
} }
``` ```
## 使用AppStorage/LocalStorage进行数据同步
ArkUI提供了AppStorage和LocalStorage两种应用级别的状态管理方案,可用于实现应用级别和UIAbility级别的数据同步。使用这些方案可以方便地管理应用状态,提高应用性能和用户体验。其中,AppStorage是一个全局的状态管理器,适用于多个UIAbility共享同一状态数据的情况;而LocalStorage则是一个局部的状态管理器,适用于单个UIAbility内部使用的状态数据。通过这两种方案,开发者可以更加灵活地控制应用状态,提高应用的可维护性和可扩展性。详细请参见[应用级变量的状态管理](../quick-start/arkts-state-mgmt-application-level.md)
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册