HarmonyOS ：基于 emitter 封装了一个便捷的 EventBus 事件通知

2024-11-29
北京
本文字数：1679 字
阅读完需：约 6 分钟

引言

鸿蒙提供提供了在同一进程不同线程间，或同一进程同一线程内，发送和处理事件的能力，包括持续订阅事件、单次订阅事件、取消订阅事件，以及发送事件到事件队列的能力。 @ohos.events.emitter

Emitter

封装前使用：emitter，下面我们先来看看官方示例：

对于事件通知，我们主要看两个交互操作：

发送

// 事件传递的消息体let eventData: emitter.EventData = {    data: {        "content": "c",        "id": 1,    }};
let innerEvent: emitter.InnerEvent = {    eventId: 1, //事件的唯一标识，后续监听也是通过这个唯一值    priority: emitter.EventPriority.HIGH //事件被发送的优先级};
emitter.emit(innerEvent, eventData);

复制代码

监听

let innerEvent: emitter.InnerEvent = {  eventId: 1 //和发送的唯一标识对应上};
// 收到eventId为1的事件后执行回调函数emitter.on(innerEvent, (eventData) => {  // eventData.data 即为上面发送的消息提});

复制代码

不足之处：emitter 发送和接收消息体类型为 [key: string]: any，而习惯的强类型语言开发应用的同学都更倾向于发送一个对象，监听时接到的也是一个对象。

EventBus

我们先来看看封装后 EventBus 的使用区别：

首先定义一个对象，用来测试我们事件的发送和监听

// test: eventBus 发送和接收的数据模型interface TestEventModule {  name: string,  age: number,}

复制代码

发送事件，传递一个对象

let eventData: TestEventModule = {  name: '李小轰',  age: 123}EventBus.send('TestEventID', eventData)

复制代码

监听事件，回执是一个对象

EventBus.listen<TestEventModule>('TestEventID', (data) => {  if (data !== undefined) {    this.receivedData = JSON.stringify(data)  }})

复制代码

EventBus.listen<T>方法提供注入对象泛型，将监听到的消息体转换成对应类型，如下截图为，监听结果时的断点：

附上完整代码（已开源，后续不断完善）

import { emitter } from '@kit.BasicServicesKit';
/// 事件通知工具类export abstract class EventBus {  static send(    eventID: string,    eventData?: Object | Record<string, Object> | null,  ) {    let data: string | undefined    if (eventData !== null && eventData !== undefined) {      if (typeof eventData === 'string') {        data = eventData      } else {        data = JSON.stringify(eventData)      }    }
    emitter.emit(      eventID,      {        priority: emitter.EventPriority.HIGH      },      {        data: {          'data': data        }      },    );  }
  static listen<T>(    eventID: string,    callback: (data?: T) => void,  ) {    emitter.on(      eventID,      (eventData: emitter.EventData) => {        let data: string | undefined = eventData.data!['data']        if (data == undefined) {          callback(undefined)        } else {          if (data.startsWith("{") && data.endsWith("}")) {            callback(JSON.parse(data) as T)          } else {            callback(data as T)          }        }      },    );  }
  static cancel(eventID: string) {    emitter.off(eventID);  }}

复制代码

附注（Example）

Demo 示例已上传：

GitHub：https://github.com/liyufengrex/HarmonyAtomicService

GitCode：https://gitcode.com/liyufengrex/HarmonyAtomicService

（基于 API11 开发，支持 NEXT 及以上版本运行）已上传可供参考，包含如下内容：

静态库+动态包+多模块设计
状态管理
统一路由管理（router+navPathStack）
网络请求、Loading 等工具库封装
自定义组件、自定义弹窗（解耦）
EventBus 事件通知
扩展修饰器，实现节流、防抖、权限申请
动态路由（navPathStack + 动态 import + WrappedBuilder）
UI 动态节点操作 (BuilderNode + NodeController)
折叠屏适配示例
组件工厂示例
组件动态属性设置示例
云函数、云数据库使用示例
华为账号服务示例（快速登陆、快速验证手机号）

发布于: 刚刚阅读数: 2

李小轰

关注

有趣的灵魂，拒绝沉默 2022-03-28 加入

目前从事 Android、Flutter、HarmonyOS 开发工作，喜欢尝试各种新玩意儿。重度强迫症（匠心精神），乐于分享！『 OpenHarmony 三方库贡献者』、『 pub.dev 三方库维护者』

发布

暂无评论

创作场景

HarmonyOS ：基于 emitter 封装了一个便捷的 EventBus 事件通知

引言

Emitter

EventBus

附上完整代码（已开源，后续不断完善）

附注（Example）

李小轰

评论