Vue3全局組件通信之EventBus

全局組件通信

全局組件通信是指,兩個任意的組件,不管是否有關聯(e.g. 父子、爺孫)的組件,都可以直接進行交流的通信方案。

舉個例子,像下面這樣,B2.vue 可以采用全局通信方案,直接向 D2.vue 發起交流,而無需經過他們的父組件。

A.vue
├─B1.vue
├───C1.vue
├─────D1.vue
├─────D2.vue
├───C2.vue
├─────D3.vue
└─B2.vue

常用的方法有:

方案 發起方 接收方 對應章節傳送門
EventBus emit on 點擊查看
Vuex - - 點擊查看

#EventBus

EventBus 通常被稱之為 “全局事件總線” ,它是用來在全局范圍內通信的一個常用方案,它的特點就是: “簡單” 、 “靈活” 、“輕量級”。

TIP

在中小型項目,全局通信推薦優先采用該方案,事件總線在打包壓縮后不到 200 個字節, API 也非常簡單和靈活。

#回顧 2.x

在 2.x,使用 EventBus 無需導入第三方插件,直接在自己的 libs 文件夾下創建一個 bus.ts 文件,暴露一個新的 Vue 實例即可。

import Vue from 'vue';
export default new Vue;

然后就可以在組件里引入 bus ,通過 $emit 去發起交流,通過 $on 去監聽接收交流。

舊版方案的完整案例代碼可以查看官方的 2.x 語法 - 事件 API(opens new window)

#了解 3.x

Vue 3.x 移除了 $on$off$once 這幾個事件 API ,應用實例不再實現事件觸發接口。

根據官方文檔在 遷移策略 - 事件 API (opens new window)的推薦,我們可以用 mitt (opens new window)或者 tiny-emitter (opens new window)等第三方插件來實現 EventBus

#創建 3.x 的 EventBus

這里以 mitt 為例,示范如何創建一個 Vue 3.x 的 EventBus

首先,需要安裝 mitt

npm install --save mitt

然后在 libs 文件夾下,創建一個 bus.ts 文件,內容和舊版寫法其實是一樣的,只不過是把 Vue 實例,換成了 mitt 實例。

import mitt from 'mitt';
export default mitt();

然后就可以定義發起和接收的相關事件了,常用的 API 和參數如下:

方法名稱 作用
on 注冊一個監聽事件,用于接收數據
emit 調用方法發起數據傳遞
off 用來移除監聽事件

on 的參數:

參數 類型 作用
type string | symbol 方法名
handler function 接收到數據之后要做什么處理的回調函數

這里的 handler 建議使用具名函數,因為匿名函數無法銷毀。

emit 的參數:

參數 類型 作用
type string | symbol 與 on 對應的方法名
data any 與 on 對應的,允許接收的數據

off 的參數:

參數 類型 作用
type string | symbol 與 on 對應的方法名
handler function 要刪除的,與 on 對應的 handler 函數名

更多的 API 可以查閱 插件的官方文檔 (opens new window),在了解了最基本的用法之后,我們來開始配置一對交流。

TIP

如果你需要把 bus 配置為全局 API ,不想在每個組件里分別 import 的話,可以參考之前的章節內容: 全局 API 掛載

#創建和移除監聽事件

在需要暴露交流事件的組件里,通過 on 配置好接收方法,同時為了避免路由切換過程中造成事件多次被綁定,多次觸發,需要在適當的時機 off 掉:

import { defineComponent, onBeforeUnmount } from 'vue'
import bus from '@libs/bus'

export default defineComponent({
  setup () {
    // 定義一個打招呼的方法
    const sayHi = (msg: string = 'Hello World!'): void => {
      console.log(msg);
    }

    // 啟用監聽
    bus.on('sayHi', sayHi);

    // 在組件卸載之前移除監聽
    onBeforeUnmount( () => {
      bus.off('sayHi', sayHi);
    })
  }
})

btw: 關于銷毀的時機,可以參考 組件的生命周期

#調用監聽事件

在需要調用交流事件的組件里,通過 emit 進行調用:

import { defineComponent } from 'vue'
import bus from '@libs/bus'

export default defineComponent({
  setup () {
    // 調用打招呼事件,傳入消息內容
    bus.emit('sayHi', '哈哈哈哈哈哈哈哈哈哈哈哈哈哈');
  }
})

#舊項目升級 EventBus

Vue 3.x 的 EventBus,我們可以看到它的 API 和舊版是非常接近的,只是去掉了 $ 符號。

如果你要對舊的項目進行升級改造,因為原來都是使用了 $on$emit 等舊的 API ,一個一個組件去修改成新的 API 肯定不現實。

我們可以在創建 bus.ts 的時候,通過自定義一個 bus 對象,來掛載 mitt 的 API 。

bus.ts 里,改成以下代碼:

import mitt from 'mitt';

// 初始化一個 mitt 實例
const emitter = mitt();

// 定義一個空對象用來承載我們的自定義方法
const bus: any = {};

// 把你要用到的方法添加到 bus 對象上
bus.$on = emitter.on;
bus.$emit = emitter.emit;

// 最終是暴露自己定義的 bus
export default bus;

這樣我們在組件里就可以繼續使用 bus.$onbus.$emit 等以前的老 API 了,不影響我們舊項目的升級使用。

點贊加關注,永遠不迷路

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,967評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,273評論 3 415
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,870評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,742評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,527評論 6 407
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,010評論 1 322
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,108評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,250評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,769評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,656評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,853評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,371評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,103評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,472評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,717評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,487評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,815評論 2 372

推薦閱讀更多精彩內容