参考 EventEmitter实现一个简单的订阅发布功能函数

 更新时间:2023年02月12日 15:21:18   作者:拾光者  
这篇文章主要为大家介绍了参考 EventEmitter实现一个简单的订阅发布功能函数示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

目的

订阅发布模式 应该是 JS 最常用的设计模式,也可称之为 观察者模式,前端各个方面都会涉及到它,比如:浏览器中的事件监听机制、nodejs 中的 EventEmitter 、redux 数据传递实现等等。

不管是 浏览器中的事件监听机制 还是 nodejs 中的 EventEmitter,都只能在各自的环境进行运行。因此我们需要用一份代码来让多端都可以调用,EventEmitter 功能更全面,我们借鉴它来实现一个完整的 PubSub

实现

主要参考 EventEmitter 的功能来,本篇文章提供 简单实现,下一篇提供了 完整实现,点击即可去查看,代码有问题欢迎评论区指出。

实现常用功能:

  • on : 用于添加订阅
  • off : 用于取消订阅
  • once : 用于添加一次性订阅
  • emit : 用于发布事件,让订阅者收到通知

完整代码实现:

type Listener = (...args: any[]) => void;
type EventInfo = {
  // 监听器
  listener: Listener;
  // 备份,需要改变 listener 时,则需要备份,比如 once
  bak?: Listener;
};
// 创建一次性监听器
function createOnceListener(pub: PubSub, eventName: string | symbol, listener: Listener) {
  const onceListener = (...args: any[]) => {
    // 执行一次后直接取消订阅
    listener(...args);
    pub.off(eventName, listener);
  };
  return onceListener;
}
export class PubSub {
  private eventMap: Record<string | symbol, EventInfo[]> = {};
  // 订阅
  on = (eventName: string | symbol, listener: Listener) => {
    if (!this.eventMap[eventName]) {
      this.eventMap[eventName] = [];
    }
    this.eventMap[eventName].push({ listener });
    return this;
  };
  // 取消订阅
  off = (eventName: string | symbol, listener: Listener) => {
    if (this.eventMap[eventName]) {
      this.eventMap[eventName] = this.eventMap[eventName].filter((item) => {
        // once listener 取消订阅
        if (item.bak) {
          return item.bak !== listener;
        }
        // 正常 listener 取消订阅
        return item.listener !== listener;
      });
    }
    return this;
  };
  // 类似 EventEmitter 中的 emit 函数
  emit = (eventName: string | symbol, ...args: any[]) => {
    this.eventMap[eventName]?.forEach((item) => {
      item.listener(...args);
    });
    return this;
  };
  // 只订阅一次
  once = (eventName: string | symbol, listener: Listener) => {
    const onceListener = createOnceListener(this, eventName, listener);
    this.on(eventName, onceListener);
    return this;
  };
}
// 不需要有全局订阅功能的,可以去掉这个
export const pubSub = new PubSub();

实现说明:

  • 不管订阅还是发布的时候都需要判读是否有已存在的队列。
  • eventMap 用于存储订阅相关信息。
  • once 使用 createOnceListener 函数实现,给原listener 添加一层包裹,执行一次后自动注销。
  • off 注销监听时需要考虑 oncelistener 被添加了一层包裹,需要用备份的原始 listener 来判断。
  • listener 函数需要考虑有多个参数。
  • 操作性的函数的返回值为 this,用于链式调用,比如 pubSub.emit("test").off("test")

总结

实现过程是通过阅读 EventEmitter 官方文档的 API 来进行反向实现的,typescript 类型可以直接通过 nodejs 使用的时候获取,这也一般是想实现某一个功能的方法。

有不对的地方欢迎指出,感谢🙏。

点击查看下一篇 完整实现

以上就是参考 EventEmitter实现一个简单的订阅发布功能函数的详细内容,更多关于EventEmitter订阅发布功能函数的资料请关注脚本之家其它相关文章!

相关文章

  • express+multer上传图片打开乱码问题及解决

    express+multer上传图片打开乱码问题及解决

    这篇文章主要介绍了express+multer上传图片打开乱码问题及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-09-09
  • Node错误处理笔记之挖坑系列教程

    Node错误处理笔记之挖坑系列教程

    因为nodejs是单线程的,所以一旦发生错误或异常,如果没有及时被处理整个系统就会崩溃。下面这篇文章主要给大家介绍了关于Node错误处理笔记之挖坑系列的相关资料,需要的朋友可以参考借鉴,下面来一起看看吧
    2018-06-06
  • Nodejs实战心得之eventproxy模块控制并发

    Nodejs实战心得之eventproxy模块控制并发

    本篇文章给大家分享我的nodejs实战心得,如何使用eventproxy模块控制并发,感兴趣的朋友可以参考下
    2015-10-10
  • 在Linux系统上更新Node.js到最新版本的3种方法小结

    在Linux系统上更新Node.js到最新版本的3种方法小结

    这篇文章主要介绍了在Linux系统上更新Node.js到最新版本的3种方法,使用NVM,使用NPM,用二进制包更新Node.js,文中有详解更新方法,需要的朋友可以参考下
    2023-09-09
  • node.js中优雅的使用Socket.IO模块的方法

    node.js中优雅的使用Socket.IO模块的方法

    Socket.IO是一个WebSocket库,包括了客户端的js和服务器端的node.js,它的目标是构建可以在不同浏览器和移动设备上使用的实时应用,这篇文章主要介绍了node.js中优雅的使用Socket.IO模块,需要的朋友可以参考下
    2022-12-12
  • Node.js的HTTP模块、URL模块与supervisor工具介绍

    Node.js的HTTP模块、URL模块与supervisor工具介绍

    这篇文章介绍了Node.js的HTTP模块、URL模块与supervisor工具,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-06-06
  • 解决linux下node.js全局模块找不到的问题

    解决linux下node.js全局模块找不到的问题

    今天小编就为大家分享一篇解决linux下node.js全局模块找不到的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-05-05
  • Yapi安装部署详细图文教程

    Yapi安装部署详细图文教程

    YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台,下面这篇文章主要给大家介绍了关于Yapi安装部署的相关资料,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2022-09-09
  • Node.js简单入门前传

    Node.js简单入门前传

    Node.js 是一个基于Chrome JavaScript 运行时建立的一个平台。接下来通过本文给大家分享node.js 入门前传,感兴趣的朋友一起看看吧
    2017-08-08
  • node环境下运行js代码缺少window环境的原因以及解决方法

    node环境下运行js代码缺少window环境的原因以及解决方法

    Node是一个基于Chrome V8引擎的运行环境,让JavaScript运行在服务端的开发平台,这篇文章主要给大家介绍了关于node环境下运行js代码缺少window环境的原因以及解决方法,需要的朋友可以参考下
    2023-11-11

最新评论