事件中心,提供订阅、取消订阅、触发事件的能力

2024-01-23 13:01 更新

EventHub模块提供了事件中心,提供订阅、取消订阅、触发事件的能力。

说明

本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

本模块接口仅可在Stage模型下使用。

使用说明

在使用eventHub的功能前,需要通过Ability实例的成员变量context获取。

  1. import Ability from '@ohos.app.ability.UIAbility';
  2. export default class MainAbility extends Ability {
  3. func1(){
  4. console.log('func1 is called');
  5. }
  6. onForeground() {
  7. this.context.eventHub.on('123', this.func1);
  8. }
  9. }

EventHub.on

on(event: string, callback: Function): void;

订阅指定事件。

系统能力:SystemCapability.Ability.AbilityRuntime.Core

参数:

参数名类型必填说明
eventstring事件名称。
callbackFunction事件回调,事件触发后运行。

示例:

  1. import Ability from '@ohos.app.ability.UIAbility';
  2. export default class MainAbility extends Ability {
  3. onForeground() {
  4. this.context.eventHub.on('123', this.func1);
  5. this.context.eventHub.on('123', () => {
  6. console.log('call anonymous func 1');
  7. });
  8. // 结果:
  9. // func1 is called
  10. // call anonymous func 1
  11. this.context.eventHub.emit('123');
  12. }
  13. func1() {
  14. console.log('func1 is called');
  15. }
  16. }

EventHub.off

off(event: string, callback?: Function): void;

取消订阅指定事件。当callback传值时,取消订阅指定的callback;未传值时,取消订阅该事件下所有callback。

系统能力:SystemCapability.Ability.AbilityRuntime.Core

参数:

参数名类型必填说明
eventstring事件名称。
callbackFunction事件回调。如果不传callback,则取消订阅该事件下所有callback。

示例:

  1. import Ability from '@ohos.app.ability.UIAbility';
  2. export default class MainAbility extends Ability {
  3. onForeground() {
  4. this.context.eventHub.on('123', this.func1);
  5. this.context.eventHub.off('123', this.func1); //取消订阅func1
  6. this.context.eventHub.on('123', this.func1);
  7. this.context.eventHub.on('123', this.func2);
  8. this.context.eventHub.off('123'); //取消订阅func1和func2
  9. }
  10. func1() {
  11. console.log('func1 is called');
  12. }
  13. func2() {
  14. console.log('func2 is called');
  15. }
  16. }

EventHub.emit

emit(event: string, ...args: Object[]): void;

触发指定事件。

系统能力:SystemCapability.Ability.AbilityRuntime.Core

参数:

参数名类型必填说明
eventstring事件名称。
...argsObject[]可变参数,事件触发时,传递给回调函数的参数。

示例:

  1. import Ability from '@ohos.app.ability.UIAbility';
  2. export default class MainAbility extends Ability {
  3. onForeground() {
  4. this.context.eventHub.on('123', this.func1);
  5. // 结果:
  6. // func1 is called,undefined,undefined
  7. this.context.eventHub.emit('123');
  8. // 结果:
  9. // func1 is called,1,undefined
  10. this.context.eventHub.emit('123', 1);
  11. // 结果:
  12. // func1 is called,1,2
  13. this.context.eventHub.emit('123', 1, 2);
  14. }
  15. func1(a, b) {
  16. console.log('func1 is called,' + a + ',' + b);
  17. }
  18. }
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号