使用Typescript手写一个Eventhub(发布订阅模式)

什么是发布-订阅模式?

发布-订阅模式主要包含三个模块, 发布者,事件处理中心,订阅者。
举个简单的例子,假设我们是一个淘宝买家,我们喜欢一家淘宝店铺的话可以点击关注,就可以接收到店铺发布的消息。
这里我们就相当于一个 订阅者 ,淘宝就相当于 事件处理中心,然后我们关注的卖家店铺就相当于 发布者
订阅者 可以有多个,小明,小红,小亮都关注的小米手机官方店,这个时候小米手机官方店就作为一个发布者,可以给小明,小红,小亮通过淘宝,发布新产品上市的消息。

如何实现一个发布订阅模式?

说下简单的思路

  • 首先我们需要一个事件处理中心能够储存我们订阅的事件。
  • 然后我们需要一个发布方法,发布的时候能够遍历储存好的订阅事件,依次执行,还能够接收发布传递的参数。

使用Typescript实现

type Event = (params?: unknown) => void;

class EventHub {
  private cache: { [key: string]: Array<Event> } = {};  // 缓存订阅的事件   
  // {
  //     'xxx事件': [fn1, fn2, fn3]
  // }

  // 把fn 推进this.cache[eventName]数组里
  on(eventName: string, fn: Event) {
    // 如果订阅的事件缓存里不存在任何处理函数,则初始化订阅事件名为一个空数组
    this.cache[eventName] = this.cache[eventName] || [];
    this.cache[eventName].push(fn);
  }

  // 依次执行this.cache[eventName]数组里的函数
  emit(eventName: string, params?: unknown) {
    (this.cache[eventName] || []).forEach(fn  => fn(params))
  }

  // 取消订阅的事件
  off(eventName: string, fn: Event) {
    // 检查需要取消的事件是否存在, 如果存在则把该事件从this.cache[eventName]数组里面移除
    let index = indexOf(this.cache[eventName], fn);
    index !== -1 && this.cache[eventName].splice(index, 1);
  }
}

export default EventHub;

/**
 * 帮助函数
 * @param array 
 * @param item 
 */
function indexOf(array: Array<Event> | undefined, item: unknown) {
  if(array === undefined) return -1;
  let index = -1;
  for(let i = 0; i<array.length; i++) {
    if(array[i] === item) {
      index = i;
      break;
    }
  }
  return index;
}

使用测试用例保证我们的代码是可靠的!

import EventHub from '../src/index';

type TestCase = (message: string) => void;

const test1: TestCase = message => {
   const eventhub = new EventHub();
   console.assert(eventhub instanceof Object === true, 'EventHub是一个对象');
   console.log(message)
}
   

const test2: TestCase = message => {
   const eventhub = new EventHub();
   let called = false;
   eventhub.on('testEvent', (params) => {
      called = true;
      console.assert(params === 'redmi note8pro 新品发布')
   });
   eventhub.emit('testEvent', 'redmi note8pro 新品发布');
   setTimeout(() => {
      console.assert(called === true);
      console.log(message)
   })
}

const test3: TestCase = message => {
   const eventhub = new EventHub();
   let called = false;
   const fn1 = () => {
      called = true;
   }
   eventhub.on('testEvent', fn1);
   eventhub.off('testEvent', fn1);
   eventhub.emit('testEvent');
   setTimeout(() => {
      console.assert(called === false);
      console.log(message)
   }, 2000)
}

test1('EventHub可以创建一个对象');
test2('EventHub可以on订阅事件和emit触发事件');
test3('EventHub可以off取消一个订阅事件');

测试用例主要用到了assert(断言)这个方法,如果不知道用法可以参考这个api说明
console.assert() 方法

测试用例运行结果

测试用例运行结果

没有报错,说明我们的发布订阅模式是可用的,如果有疑问可以留言!

本文正在参加“写编程博客瓜分千元现金”活动,关注公众号“饥人谷”回复“编程博客”参与活动。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,277评论 6 503
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,689评论 3 393
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,624评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,356评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,402评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,292评论 1 301
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,135评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,992评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,429评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,636评论 3 334
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,785评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,492评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,092评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,723评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,858评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,891评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,713评论 2 354

推荐阅读更多精彩内容

  • 发布—订阅模式又叫观察者模式,它定义对象间的一种一对多的依赖关系,当一个对象的状态发生改变时,所有依赖于它的对象都...
    yufawu阅读 753评论 0 6
  • 工厂模式 单体模式 模块模式 代理模式 职责链模式 命令模式 模板方法模式 策略模式 发布-订阅模式 中介者模式 ...
    HelloJames阅读 1,008评论 0 6
  • 1.发布订阅模式介绍 发布---订阅模式又叫观察者模式,它定义了对象间的一种一对多的关系,让多个观察者对象同时监听...
    JSUED阅读 783评论 1 4
  • 发布-订阅模式又叫观察者模式,它定义对象间的一种一对多的依赖关系,当一个对象的状态发生改变时,所有依赖于它的对象都...
    李友胜阅读 289评论 0 1
  • 生活中的发布订阅 淘宝卖家属于发布者。顾客小红等一群吃瓜群众是订阅者。群众订阅淘宝卖家的店铺,卖家有新消息就会通知...
    209bd3bc6844阅读 321评论 0 0