(前端)「中介者」設計模式在專案開發中的應用

2022-08-05 15:00:20

  1. 事件起因

    事情是這樣的,我之前在做一個仿網易雲的專案,想實現一個功能,就是點選歌曲列表元件(MusicList)中每一個item時,底部播放欄(FooterMusic)就能夠獲取我所點選的這首歌曲的所有資訊(如圖1到圖2),但是底部播放欄是直接放在外殼元件App.vue中固定定位的,歌曲列表元件是作為頁面級元件HomeView.vue的子元件,因此他們二者至多隻能算是兄弟元件(可能還差了一個輩分?),這就涉及到了兄弟元件之間的通訊問題。

 

  

        圖1                      圖2

  Vue2中實現兄弟元件的通訊一般是安裝EventBus外掛,或者範例化一個Vue,它上面有關於事件的釋出和訂閱方法,Vue3的話好像是使用mitt外掛吧,但我不想用mitt,也不想裝外掛,因此決定手寫一個EventBus。

 

2. 解決方案

  利用「中介者」設計模式。

  實現思路: 手寫一個EventBus,讓其作為中介者進行事件的釋出與訂閱(或取消訂閱),在元件中呼叫EventBus範例進行事件的釋出或訂閱即可。

  程式碼如下:

  src/EventBus/index.ts:

class EventBus {
  static instance: object;
  eventQueue: any

  constructor() {
    this.eventQueue = {}
  }

  // 用單例模式設計一下,使全域性只能有一個EventBus範例,這樣排程中心eventQueue就唯一了,所有事件與其對應的訂閱者都在裡面
  static getInstance() {
    if(!EventBus.instance) {
      Object.defineProperty(EventBus, 'instance', {
        value: new EventBus()
      });
    }

    return EventBus.instance;
  }

  // 事件釋出
  $emit(type: string, ...args: any[]) {
    if(this.eventQueue.hasOwnProperty(type)) {
      // 如果排程中心中已包含此事件, 則直接將其所有的訂閱者函數觸發
      this.eventQueue[type].forEach((fn: Function) => {
        fn.apply(this, args);
      });
    }
  }


  // 事件訂閱
  $on(type: string, fn: Function) {
    if(!this.eventQueue.hasOwnProperty(type)) {
      this.eventQueue[type] = [];
    }
    
    if(this.eventQueue[type].indexOf(fn) !== -1) {
      // 說明該訂閱者已經訂閱過了
      return;
    }
    this.eventQueue[type].push(fn);
  }


  // 取消事件訂閱, 將相應的回撥函數fn所在的位置置為null即可
  $off(type: string, fn: Function) {
    if(this.eventQueue.hasOwnProperty(type)) {
      this.eventQueue[type].forEach((item: Function, index: number) => {
        if(item == fn) {
          this.eventQueue[type][index] = null;
        }
      });
    }
  }
}



// 最後匯出單例的時候記得給單例斷言成any哈, 要不然在元件內呼叫eventBus.$on('xxx', () => {...})會報錯物件上沒有$on這個方法
export default EventBus.getInstance() as any;

 

  寫好了中介者之後,我們在元件中使用一下

  在歌曲列表元件中點選事件後觸發 

eventBus.$emit('CUR_SONG', curSongMsg);  進行事件的釋出,並帶上歌曲資訊

  

  在底部播放欄元件中訂閱這個事件

eventBus.$on('CUR_SONG', (curSongMsg: IMusic) => {
    console.log('訂閱事件: CUR_SONG');
    console.log('curSongMsg: ', curSongMsg);

    // reactive定義的參照型別必須逐個屬性進行賦值才能實現頁面的響應式更新
    songMsg.name = curSongMsg.name;
    songMsg.author = curSongMsg.author;
    songMsg.mv = curSongMsg.mv;
});

 

  以上就完成了利用中介者EventBus進行事件的釋出與訂閱,實現無關元件之間的通訊問題。

  

  參考書籍 《JavaScript設計模式》 張容銘 著