天天一個設計模式之訂閱-發佈模式

博主按：《天天一個設計模式》旨在初步領會設計模式的精髓，目前採用javascript（靠這吃飯）和python（純粹喜歡）兩種語言實現。誠然，每種設計模式都有多種實現方式，但此小冊只記錄最直截了當的實現方式 :)

0. 項目地址

• 天天一個設計模式之訂閱-發佈模式·原文地址
• 本節課代碼
• 《天天一個設計模式·系列》地址

1. 什麼是「訂閱-發佈模式」？

訂閱-發佈模式定義了對象之間的一種一對多的依賴關係，當一個對象的狀態發生改變時，全部依賴它的對象均可以獲得通知。

瞭解過事件機制或者函數式編程的朋友，應該會體會到「訂閱-發佈模式」所帶來的「時間解耦」和「空間解耦」的優勢。藉助函數式編程中閉包和回調的概念，能夠很優雅地實現這種設計模式。

2. 「訂閱-發佈模式」 vs 觀察者模式

訂閱-發佈模式和觀察者模式概念類似，但在訂閱-發佈模式中，訂閱者和發佈者之間多了一層中間件：一個被抽象出來的信息調度中心。

但其實沒有必要太深究 2 者區別，由於《Head First 設計模式》這本經典書都寫了：發佈+訂閱=觀察者模式。其核心思想是狀態改變和發佈通知。在此基礎上，根據語言特性，進行實現便可。

3. 代碼實現

3.1 python3 實現

python 中咱們定義一個事件類Event, 而且爲它提供 事件監聽函數、（事件完成後）觸發函數，以及事件移除函數。任何類均可以經過繼承這個通用事件類，來實現「訂閱-發佈」功能。

class Event:
  def __init__(self):
    self.client_list = {}

  def listen(self, key, fn):
    if key not in self.client_list:
      self.client_list[key] = []
    self.client_list[key].append(fn)

  def trigger(self, *args, **kwargs):
    fns = self.client_list[args[0]]

    length = len(fns)
    if not fns or length == 0:
      return False

    for fn in fns:
      fn(*args[1:], **kwargs)

    return False

  def remove(self, key, fn):
    if key not in self.client_list or not fn:
      return False

    fns = self.client_list[key]
    length = len(fns)

    for _fn in fns:
      if _fn == fn:
        fns.remove(_fn)

    return True

# 藉助繼承爲對象安裝 發佈-訂閱 功能
class SalesOffice(Event):
  def __init__(self):
    super().__init__()

# 根據本身需求定義一個函數：供事件處理完後調用
def handle_event(event_name):
  def _handle_event(*args, **kwargs):
    print("Price is", *args, "at", event_name)

  return _handle_event


if __name__ == "__main__":
  # 建立2個回調函數
  fn1 = handle_event("event01")
  fn2 = handle_event("event02")

  sales_office = SalesOffice()

  # 訂閱event01 和 event02 這2個事件，而且綁定相關的 完成後的函數
  sales_office.listen("event01", fn1)
  sales_office.listen("event02", fn2)

  # 當兩個事件完成時候，觸發前幾行綁定的相關函數
  sales_office.trigger("event01", 1000)
  sales_office.trigger("event02", 2000)

  sales_office.remove("event01", fn1)

  # 打印：False
  print(sales_office.trigger("event01", 1000))

3.2 ES6 實現

JS 中通常用事件模型來代替傳統的發佈-訂閱模式。任何一個對象的原型鏈被指向Event的時候，這個對象即可以綁定自定義事件和對應的回調函數。

const Event = {
  clientList: {},

  // 綁定事件監聽
  listen(key, fn) {
    if (!this.clientList[key]) {
      this.clientList[key] = [];
    }
    this.clientList[key].push(fn);
    return true;
  },

  // 觸發對應事件
  trigger() {
    const key = Array.prototype.shift.apply(arguments),
      fns = this.clientList[key];

    if (!fns || fns.length === 0) {
      return false;
    }

    for (let fn of fns) {
      fn.apply(null, arguments);
    }

    return true;
  },

  // 移除相關事件
  remove(key, fn) {
    let fns = this.clientList[key];

    // 若是以前沒有綁定事件
    // 或者沒有指明要移除的事件
    // 直接返回
    if (!fns || !fn) {
      return false;
    }

    // 反向遍歷移除置指定事件函數
    for (let l = fns.length - 1; l >= 0; l--) {
      let _fn = fns[l];
      if (_fn === fn) {
        fns.splice(l, 1);
      }
    }

    return true;
  }
};

// 爲對象動態安裝 發佈-訂閱 功能
const installEvent = obj => {
  for (let key in Event) {
    obj[key] = Event[key];
  }
};

let salesOffices = {};
installEvent(salesOffices);

// 綁定自定義事件和回調函數

salesOffices.listen(
  "event01",
  (fn1 = price => {
    console.log("Price is", price, "at event01");
  })
);

salesOffices.listen(
  "event02",
  (fn2 = price => {
    console.log("Price is", price, "at event02");
  })
);

salesOffices.trigger("event01", 1000);
salesOffices.trigger("event02", 2000);

salesOffices.remove("event01", fn1);

// 輸出: false
// 說明刪除成功
console.log(salesOffices.trigger("event01", 1000));

4. 參考

• 維基百科·訂閱-發佈模式
• 觀察者模式和訂閱-發佈模式的不一樣
• 《JavaScript 設計模式和開發實踐》