HarmonyOS :基于 emitter 封裝了一個(gè)便捷的 EventBus 事件通知

引言

鴻蒙提供提供了在同一進(jìn)程不同線程間骤素,或同一進(jìn)程同一線程內(nèi),發(fā)送和處理事件的能力异剥,包括持續(xù)訂閱事件瑟由、單次訂閱事件、取消訂閱事件冤寿,以及發(fā)送事件到事件隊(duì)列的能力歹苦。 @ohos.events.emitter

Emitter

封裝前使用:emitter青伤,下面我們先來看看官方示例:

對(duì)于事件通知,我們主要看兩個(gè)交互操作:

  • 發(fā)送
// 事件傳遞的消息體
let eventData: emitter.EventData = {
    data: {
        "content": "c",
        "id": 1,
    }
};

let innerEvent: emitter.InnerEvent = {
    eventId: 1, //事件的唯一標(biāo)識(shí)殴瘦,后續(xù)監(jiān)聽也是通過這個(gè)唯一值
    priority: emitter.EventPriority.HIGH //事件被發(fā)送的優(yōu)先級(jí)
};

emitter.emit(innerEvent, eventData);
  • 監(jiān)聽
let innerEvent: emitter.InnerEvent = {
  eventId: 1 //和發(fā)送的唯一標(biāo)識(shí)對(duì)應(yīng)上
};

// 收到eventId為1的事件后執(zhí)行回調(diào)函數(shù)
emitter.on(innerEvent, (eventData) => {
  // eventData.data 即為上面發(fā)送的消息提
});

不足之處:emitter 發(fā)送和接收消息體類型為 [key: string]: any狠角,而習(xí)慣的強(qiáng)類型語言開發(fā)應(yīng)用的同學(xué)都更傾向于發(fā)送一個(gè)對(duì)象,監(jiān)聽時(shí)接到的也是一個(gè)對(duì)象蚪腋。

EventBus

我們先來看看封裝后 EventBus 的使用區(qū)別:

  • 首先定義一個(gè)對(duì)象丰歌,用來測(cè)試我們事件的發(fā)送和監(jiān)聽
// test: eventBus 發(fā)送和接收的數(shù)據(jù)模型
interface TestEventModule {
  name: string,
  age: number,
}
  • 發(fā)送事件,傳遞一個(gè)對(duì)象
let eventData: TestEventModule = {
  name: '李小轟',
  age: 123
}
EventBus.send('TestEventID', eventData)
  • 監(jiān)聽事件屉凯,回執(zhí)是一個(gè)對(duì)象
EventBus.listen<TestEventModule>('TestEventID', (data) => {
  if (data !== undefined) {
    this.receivedData = JSON.stringify(data)
  }
})

EventBus.listen<T>方法提供注入對(duì)象泛型立帖,將監(jiān)聽到的消息體轉(zhuǎn)換成對(duì)應(yīng)類型,如下截圖為悠砚,監(jiān)聽結(jié)果時(shí)的斷點(diǎn):

image.png

附上完整代碼(已開源晓勇,后續(xù)不斷完善)

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示例(基于API11開發(fā),支持NEXT及以上版本運(yùn)行)已上傳可供參考灌旧,包含如下內(nèi)容:

  • 靜態(tài)庫+多模塊設(shè)計(jì)
  • 狀態(tài)管理+統(tǒng)一路由管理
  • 網(wǎng)絡(luò)請(qǐng)求宵蕉、Loading、Log(支持長(zhǎng)文本打咏诎瘛) 等工具庫封裝
  • 自定義組件羡玛、自定義彈窗(解耦)
  • EventBus 事件通知
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市宗苍,隨后出現(xiàn)的幾起案子稼稿,更是在濱河造成了極大的恐慌,老刑警劉巖讳窟,帶你破解...
    沈念sama閱讀 217,277評(píng)論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件让歼,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡丽啡,警方通過查閱死者的電腦和手機(jī)谋右,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,689評(píng)論 3 393
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來补箍,“玉大人改执,你說我怎么就攤上這事】友牛” “怎么了辈挂?”我有些...
    開封第一講書人閱讀 163,624評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)裹粤。 經(jīng)常有香客問我终蒂,道長(zhǎng),這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,356評(píng)論 1 293
  • 正文 為了忘掉前任拇泣,我火速辦了婚禮噪叙,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘霉翔。我一直安慰自己睁蕾,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,402評(píng)論 6 392
  • 文/花漫 我一把揭開白布早龟。 她就那樣靜靜地躺著惫霸,像睡著了一般猫缭。 火紅的嫁衣襯著肌膚如雪葱弟。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,292評(píng)論 1 301
  • 那天猜丹,我揣著相機(jī)與錄音芝加,去河邊找鬼。 笑死射窒,一個(gè)胖子當(dāng)著我的面吹牛藏杖,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播脉顿,決...
    沈念sama閱讀 40,135評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼蝌麸,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了艾疟?” 一聲冷哼從身側(cè)響起来吩,我...
    開封第一講書人閱讀 38,992評(píng)論 0 275
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎蔽莱,沒想到半個(gè)月后弟疆,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,429評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡盗冷,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,636評(píng)論 3 334
  • 正文 我和宋清朗相戀三年怠苔,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片仪糖。...
    茶點(diǎn)故事閱讀 39,785評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡柑司,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出锅劝,到底是詐尸還是另有隱情帜羊,我是刑警寧澤,帶...
    沈念sama閱讀 35,492評(píng)論 5 345
  • 正文 年R本政府宣布鸠天,位于F島的核電站讼育,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜奶段,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,092評(píng)論 3 328
  • 文/蒙蒙 一饥瓷、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧痹籍,春花似錦呢铆、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,723評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至线定,卻和暖如春娜谊,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背斤讥。 一陣腳步聲響...
    開封第一講書人閱讀 32,858評(píng)論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留芭商,地道東北人派草。 一個(gè)月前我還...
    沈念sama閱讀 47,891評(píng)論 2 370
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像铛楣,于是被迫代替她去往敵國和親近迁。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,713評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容