应用站内组件模块间广播消息 Emitter - 鸿蒙 HarmonyOS Next

应用站内组件模块间广播消息,适用于站内各模块间信息的传递与分发,例如某个公共状态属性的变更同步响应至各个所需之处;
类似于 iOS 中的通知 NSNotificationCenter 或者 Android 的 EventBus,通过某个 click 事件向其它已预订阅的模块发送广播消息;
注:以下内容基于 HarmonyOS NEXT Developer Beta3 版本实现

若主线程内通信可以通过 EventHub
若主线程与 Worker 间通信可以通过 Emitter
若应用间的通信可以通过 commonEventManager
具体可根据实际业务而定,起初先尝试使用的 commonEventManager 后切换成了 Emitter 更适合作用域于应用站内的模式,具体实现如下:

基于 BasicServicesKit api 中的接口方法实现广播消息的订阅、发送和解除订阅;

一.广播消息的订阅

// 订阅: 事件监听_持续
// EmitterCenter.shareInstance().on(EmitterKey.Emitter_ReloadWeb, (data) => {
//   console.info('[EmitterCenter] - callback:', JSON.stringify(data.data))
// })
on(key: string, callback:(eventData: emitter.EventData) => void) {
  console.log('[EmitterCenter] - on:', key)
  emitter.on(key, callback)
}

二.广播消息的发送

EventPriority 分发类型

IMMEDIATE:   0    事件被立即投递
HIGH:   1    事件先于LOW优先级投递
LOW:   2    事件优于IDLE优先级投递，事件的默认优先级是LOW
IDLE:   3    在没有其他事件的情况下投递该事件

// 订阅: 事件发送
// EmitterCenter.shareInstance().post(EmitterKey.Emitter_ReloadWeb, new Object({
//   'key': item.value,
// }))
post(key: string, data?:object) {
  console.log('[EmitterCenter] - post:', key)
  let option: emitter.Options = {
    priority: emitter.EventPriority.IMMEDIATE // 事件立即发送
  }
  let eventData: emitter.EventData = { // 数据源
    data: data // [key: string]: any
  }
  emitter.emit(key, option, eventData)
}

三.广播消息的解除订阅

// 订阅: 事件解绑
// EmitterCenter.shareInstance().off(EmitterKey.Emitter_ReloadWeb)
off(key: string) {
  console.log('[EmitterCenter] - off:', key)
  emitter.off(key)
}

完整事例

具体实现如下,通过自定义广播消息类,针对消息的收、发和解进行简易封装后按需调用即可:

import { emitter } from '@kit.BasicServicesKit';

// 通信协议
export enum EmitterKey {
  // 监听网络状态
  Emitter_NoticeNetworkState = 'NoticeNetworkState',
  // 获取蓝牙状态
  Emitter_BluetoothState = 'NoticeBluetoothState',
  // 刷新 web
  Emitter_ReloadWeb = 'reloadWebView',
  // 监测键盘弹出 & 收起状态
  Emitter_KeyboardChangeState = 'NoticeKeyboardChangeState',
  // 应用即将进入前台
  Emitter_MsgAppWillStarting = 'MsgAppWillStarting',
  // 应用进入前台
  Emitter_MsgAppStarting = 'MsgAppStarting',
  // 应用进入后台
  Emitter_MsgAppReactivate = 'MsgAppReactivate',
}

export default class EmitterCenter {
  private static instance: EmitterCenter

  private constructor() {

  }

  static shareInstance(): EmitterCenter {
    if (!EmitterCenter.instance) {
      EmitterCenter.instance = new EmitterCenter()
    }
    return EmitterCenter.instance
  }

  // 订阅: 事件监听_持续
  // EmitterCenter.shareInstance().on(EmitterKey.Emitter_ReloadWeb, (data) => {
  //   console.info('[EmitterCenter] - callback:', JSON.stringify(data.data))
  // })
  on(key: string, callback:(eventData: emitter.EventData) => void) {
    console.log('[EmitterCenter] - on:', key)
    emitter.on(key, callback)
  }

  // 订阅: 事件解绑
  // EmitterCenter.shareInstance().off(EmitterKey.Emitter_ReloadWeb)
  off(key: string) {
    console.log('[EmitterCenter] - off:', key)
    emitter.off(key)
  }

  // 订阅: 事件发送
  // EmitterCenter.shareInstance().post(EmitterKey.Emitter_ReloadWeb, new Object({
  //   'key': item.value,
  // }))
  post(key: string, data?:object) {
    console.log('[EmitterCenter] - post:', key)
    let option: emitter.Options = {
      priority: emitter.EventPriority.IMMEDIATE // 事件立即发送
    }
    let eventData: emitter.EventData = { // 数据源
      data: data // [key: string]: any
    }
    emitter.emit(key, option, eventData)
  }
}

---

以上便是此次分享的全部内容，希望能对大家有所帮助！