参考EventEmitter实现完整订阅发布功能函数

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

引言

前一篇文章 《实现一个简单的订阅发布功能函数|参考 EventEmitter》 实现了简单版本的,本篇文章用 JS 完整实现 Node.js 中的 EventEmitter

实现

EventEmitter 中有一些重复功能的函数,或者已经移除的函数,这里不会进行实现。

主要会新增以下功能:

  • 新增默认最大订阅限制,且可进行更改
  • 可获取所有的订阅事件名称
  • 可根据事件名获取所有的监听函数
  • 默认是往订阅事件队列尾部新增,现在新增 可往队列头部添加订阅事件 的功能

根据 简单版实现 为基础,再根据功能来新增一些属性和方法。

需要新增内部属性:

  • maxListeners,默认最多给特定事件添加了 10 个的订阅,如果超过了则不会生效,且会有警告提示,如果需要更多,则需要调用 setMaxListeners 进行设置。
  • addListener,抽离新增订阅的实现,用于复用

需要新增功能函数:

  • listeners 获取
  • rawListeners 获取所有订阅的原始监听函数
  • listenerCount 获取所有订阅数量
  • eventNames 获取所有订阅事件名
  • prependListener 从头部新增订阅,如果代码中需要先执行的订阅,才需要用到
  • prependOnceListener 从头部新增一次性订阅,如果代码中需要先执行的订阅,才需要用到
  • setMaxListeners 设置最大订阅数量
  • getMaxListeners 获取最大订阅数量

完整代码实现:

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[]> = {};
  // 默认最多给特定事件添加了 10 个的监听器
  private maxListeners = 10;
  // 订阅实现
  private addListener = (eventName: string | symbol, listener: Listener, addToHead = false) => {
    if (!this.eventMap[eventName]) {
      this.eventMap[eventName] = [];
    }
    // 不能添加超过 maxListeners 的监听逻辑处理
    if (this.eventMap[eventName].length >= this.maxListeners) {
      console.warn(
        `maxListeners: ${this.maxListeners}, ${eventName.toString()} event has add ${this.maxListeners} listener,`
      );
    } else {
      if (addToHead) {
        this.eventMap[eventName].unshift({ listener });
      } else {
        this.eventMap[eventName].push({ listener });
      }
    }
    return this;
  };
  // 订阅
  on = (eventName: string | symbol, listener: Listener) => {
    return this.addListener(eventName, listener);
  };
  // 取消订阅
  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;
  };
  // 获取所有订阅的原始监听器
  listeners = (eventName: string | symbol) => {
    return this.eventMap[eventName]?.map((item) => item.bak || item.listener) || [];
  };
  // 返回名为 eventName 的事件的监听器数组的副本,包括任何封装器(例如由 .once() 创建的封装器)。
  rawListeners = (eventName: string | symbol) => {
    return this.eventMap[eventName]?.map((item) => item.listener) || [];
  };
  // 获取所有订阅数量
  listenerCount = (eventName: string | symbol) => {
    return this.eventMap[eventName]?.length || 0;
  };
  // 获取所有 eventName
  eventNames = () => {
    const eventNames = [];
    for (const key in this.eventMap) {
      eventNames.push(key);
    }
    return eventNames;
  };
  // 将 listener 函数添加到名为 eventName 的事件的监听器数组的开头。不检查是否已添加 listener。 多次调用传入相同的 eventName 和 listener 组合将导致多次添加和调用 listener。
  prependListener = (eventName: string | symbol, listener: Listener) => {
    return this.addListener(eventName, listener, true);
  };
  // 将名为 eventName 的事件的单次 listener 函数添加到监听器数组的开头。 下次触发 eventName 时,将移除此监听器,然后再调用。
  prependOnceListener = (eventName: string | symbol, listener: Listener) => {
    const onceListener = createOnceListener(this, eventName, listener);
    this.prependListener(eventName, onceListener);
    return this;
  };
  // 当前最大监听器数的值。 该值可以设置为 Infinity(或 0)以指示无限数量的监听器。
  setMaxListeners = (n: number) => {
    this.maxListeners = n;
    return this;
  };
  // 返回当前最大监听器数的值,该值由 setMaxListeners(n) 设置或为默认值 10。
  getMaxListeners = () => {
    return this.maxListeners;
  };
}
export const pubSub = new PubSub();

说明:

  • ononceprependListenerprependOnceListener 几个新增 listener 的函数都不检查是否已添加 listener,多次调用传入相同的 eventNamelistener 组合将导致多次添加和调用listener ,因此需要注意不要多次注入。

总结

如果你的应用非常大,需要非常精细的管理事件,那么可以使用完整版实现,如果不是的话,可以使用简单版本。

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

相关文章

  • node+express框架中连接使用mysql(经验总结)

    node+express框架中连接使用mysql(经验总结)

    这篇文章主要介绍了node+express框架中连接使用mysql(经验总结),小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-11-11
  • Node.js入门教程:在windows和Linux上安装配置Node.js图文教程

    Node.js入门教程:在windows和Linux上安装配置Node.js图文教程

    这篇文章主要介绍了Node.js入门教程:在windows和Linux上安装配置Node.js的方法,本文图文并茂,步骤明细,是学习安装node.js的绝佳教程,需要的朋友可以参考下
    2014-08-08
  • NodeJS中的MongoDB快速入门详细教程

    NodeJS中的MongoDB快速入门详细教程

    MongoDB 是一个基于分布式文件存储的数据库,由 C++ 语言编写。这篇文章主要介绍了NodeJS中的MongoDB快速入门详细教程的相关资料,需要的朋友可以参考下
    2016-11-11
  • 基于node.js之调试器详解

    基于node.js之调试器详解

    下面小编就为大家带来一篇基于node.js之调试器详解。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-08-08
  • nodejs中安装ghost出错的原因及解决方法

    nodejs中安装ghost出错的原因及解决方法

    本篇文章主要介绍了nodejs中安装ghost出错的原因及解决方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-10-10
  • Node.js实现大文件断点续传示例详解

    Node.js实现大文件断点续传示例详解

    这篇文章主要为大家介绍了Node.js实现大文件断点续传示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-11-11
  • Node.js卸载与重装及zip与msi安装详解

    Node.js卸载与重装及zip与msi安装详解

    Node.js是一个JavaScript运行环境,可以使JavaScript这类脚本语言编写出来的代码运行速度获得极大提升,下面这篇文章主要给大家介绍了关于Node.js卸载与重装及zip与msi安装的相关资料,需要的朋友可以参考下
    2023-01-01
  • windows系统下更新nodejs版本的方案

    windows系统下更新nodejs版本的方案

    这篇文章主要介绍了windows系统下更新nodejs版本的方案,在文章给大家介绍了NodeJS 与 npm 在Windows下升级问题,需要的朋友可以参考下
    2017-11-11
  • Node.js 实现抢票小工具 & 短信通知提醒功能

    Node.js 实现抢票小工具 & 短信通知提醒功能

    这篇文章主要介绍了Node.js 实现抢票小工具 & 短信通知提醒功能,本文通过实例代码给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2019-10-10
  • Node.js 中如何收集和解析命令行参数

    Node.js 中如何收集和解析命令行参数

    这篇文章主要介绍了Node.js 中如何收集和解析命令行参数,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-01-01

最新评论