node总结之EventEmitter这个鬼了解下

2022-09-07 13:17:48

Node.js 所有的异步 I/O 操作在完成时都会发送一个事件到事件队列，它里面的许多对象都会分发事件：一个 net.Server 对象会在每次有新连接时触发一个事件， 一个 fs.readStream 对象会在文件被打开的时候触发一个事件。 所有这些产生事件的对象都是 events.EventEmitter 的实例。

其中这个EventEmitter类呢，是node中事件的基础， 实现了事件模型需要的接口， 包括addListener，removeListener, emit及其ta工具方法. 同原生javascript事件类似， 采用了发布/订阅(观察者)的方式， 使用内部_events列表来记录注册的事件处理器。

EventEmitter类是events模块中的，然而events 模块只提供了一个对象，就是 events.EventEmitter。EventEmitter 的核心就是事件触发与事件监听器功能的封装，我们可以通过require("events");来访问该模块，如下：

 

  1. // 引入 events 模块

  2. var events = require('events');

  3. // 创建 eventEmitter 对象

  4. var eventEmitter = new events.EventEmitter();

EventEmitter 对象如果在实例化时发生错误，会触发 error 事件。当添加新的监听器时，newListener 事件会触发，当监听器被移除时，removeListener 事件被触发。我们来通过一个简单的例子说明 EventEmitter 的用法，如下：

 

  1. //event.js 文件

  2. var EventEmitter = require('events').EventEmitter;

  3. var event = new EventEmitter();

  4. event.on('some_event', function() {

  5. console.log('some_event 事件触发');

  6. });

  7. setTimeout(function() {

  8. event.emit('some_event');

  9. }, 1000);

运行这段代码，1 秒后控制台输出了 'some_event 事件触发'。其原理是 event 对象注册了事件 some_event 的一个监听器，然后我们通过 setTimeout 在 1000 毫秒以后向 event 对象发送事件 some_event，此时会调用some_event 的监听器。

EventEmitter 的每个事件由一个事件名和若干个参数组成，事件名是一个字符串，通常表达一定的语义。对于每个事件，EventEmitter 支持 若干个事件监听器。完事，当事件触发时，注册到这个事件的事件监听器被依次调用，事件参数作为回调函数参数传递。我们来通过下面的例子解释这个过程：

 

  1. //event.js 文件

  2. var events = require('events');

  3. var emitter = new events.EventEmitter();

  4. emitter.on('someEvent', function(arg1, arg2) {

  5. console.log('listener1', arg1, arg2);

  6. });

  7. emitter.on('someEvent', function(arg1, arg2) {

  8. console.log('listener2', arg1, arg2);

  9. });

  10. emitter.emit('someEvent', 'arg1 参数', 'arg2 参数');

运行结果如下：

 

  1. $ node event.js

  2. listener1 arg1 参数 arg2 参数

  3. listener2 arg1 参数 arg2 参数

上面的例子中，emitter 为事件 someEvent 注册了两个事件监听器，然后触发了 someEvent 事件。我们从运行结果中可以看到两个事件监听器回调函数被先后调用， 这就是EventEmitter最简单的用法。

EventEmitter 提供了多个属性，如 on 和 emit、on 函数用于绑定事件函数，emit 属性用于触发一个事件，我们来具体看下 EventEmitter 的属性介绍：

首先是方法：

序号 方法 & 描述
1 addListener(event, listener)
为指定事件添加一个监听器到监听器数组的尾部。
2 on(event, listener)
为指定事件注册一个监听器，接受一个字符串 event 和一个回调函数。 
 

  1. server.on('connection', function (stream) {

  2. console.log('someone connected!');

  3. });

 
3 once(event, listener)
为指定事件注册一个单次监听器，即 监听器最多只会触发一次，触发后立刻解除该监听器。 
 

  1. server.once('connection', function (stream) {

  2. console.log('Ah, we have our first user!');

  3. });

 
4 removeListener(event, listener)

移除指定事件的某个监听器，监听器必须是该事件已经注册过的监听器。

它接受两个参数，第一个是事件名称，第二个是回调函数名称。

 

  1. var callback = function(stream) {

  2. console.log('someone connected!');

  3. };

  4. server.on('connection', callback);

  5. // ...

  6. server.removeListener('connection', callback);

 
5 removeAllListeners([event])
移除所有事件的所有监听器， 如果指定事件，则移除指定事件的所有监听器。
6 setMaxListeners(n)
默认情况下， EventEmitters 如果你添加的监听器超过 10 个就会输出警告信息。 setMaxListeners 函数用于提高监听器的默认限制的数量。
7 listeners(event)
返回指定事件的监听器数组。
8 emit(event, [arg1], [arg2], [...])
按参数的顺序执行每个监听器，如果事件有注册监听返回 true，否则返回 false。

类方法如下：

序号 方法 & 描述
1 listenerCount(emitter, event)
返回指定事件的监听器数量。		 
 

  1. events.EventEmitter.listenerCount(emitter, eventName) //已废弃，不推荐

  2. events.emitter.listenerCount(eventName) //推荐

 事件如下：

序号 事件 & 描述
1 newListener

  • event - 字符串，事件名称

  • listener - 处理事件函数

该事件在添加新监听器时被触发。
2 removeListener

  • event - 字符串，事件名称

  • listener - 处理事件函数

从指定监听器数组中删除一个监听器。需要注意的是，此操作将会改变处于被删监听器之后的那些监听器的索引。

接下来通过 connection（连接）事件演示 EventEmitter 类的应用。

我们来创建 main.js 文件，代码如下：

 

  1. var events = require('events');

  2. var eventEmitter = new events.EventEmitter();

  3.  

  4. // 监听器 #1

  5. var listener1 = function listener1() {

  6. console.log('监听器 listener1 执行。');

  7. }

  8.  

  9. // 监听器 #2

  10. var listener2 = function listener2() {

  11. console.log('监听器 listener2 执行。');

  12. }

  13.  

  14. // 绑定 connection 事件，处理函数为 listener1

  15. eventEmitter.addListener('connection', listener1);

  16.  

  17. // 绑定 connection 事件，处理函数为 listener2

  18. eventEmitter.on('connection', listener2);

  19.  

  20. var eventListeners = eventEmitter.listenerCount('connection');

  21. console.log(eventListeners + " 个监听器监听连接事件。");

  22.  

  23. // 处理 connection 事件

  24. eventEmitter.emit('connection');

  25.  

  26. // 移除监绑定的 listener1 函数

  27. eventEmitter.removeListener('connection', listener1);

  28. console.log("listener1 不再受监听。");

  29.  

  30. // 触发连接事件

  31. eventEmitter.emit('connection');

  32.  

  33. eventListeners = eventEmitter.listenerCount('connection');

  34. console.log(eventListeners + " 个监听器监听连接事件。");

  35.  

  36. console.log("程序执行完毕。");

执行结果如下：

 

  1. $ node main.js

  2. 2 个监听器监听连接事件。

  3. 监听器 listener1 执行。

  4. 监听器 listener2 执行。

  5. listener1 不再受监听。

  6. 监听器 listener2 执行。

  7. 1 个监听器监听连接事件。

  8. 程序执行完毕。

EventEmitter 定义了一个特殊的事件 error，它包含了错误的语义，我们在遇到 异常的时候通常会触发 error 事件。当 error 被触发时，EventEmitter 规定如果没有响 应的监听器，Node.js 会把它当作异常，退出程序并输出错误信息。我们一般要为会触发 error 事件的对象设置监听器，避免遇到错误后整个程序崩溃，如下：

 

  1. var events = require('events');

  2. var emitter = new events.EventEmitter();

  3. emitter.emit('error');

运行结果如下：

 

  1. node.js:201

  2. throw e; // process.nextTick error, or 'error' event on first tick

  3. ^

  4. Error: Uncaught, unspecified 'error' event.

  5. at EventEmitter.emit (events.js:50:15)

  6. at Object.<anonymous> (/home/byvoid/error.js:5:9)

  7. at Module._compile (module.js:441:26)

  8. at Object..js (module.js:459:10)

  9. at Module.load (module.js:348:31)

  10. at Function._load (module.js:308:12)

  11. at Array.0 (module.js:479:10)

  12. at EventEmitter._tickCallback (node.js:192:40)

大多数时候我们不会直接使用 EventEmitter，而是在对象中继承它，其中包括 fs、net、 http 在内的，只要是支持事件响应的核心模块都是 EventEmitter 的子类。这样做的原因有两点，如下：

  1. 首先，具有某个实体功能的对象实现事件符合语义， 事件的监听和发生应该是一个对象的方法
  2. 其次 JavaScript 的对象机制是基于原型的，支持 部分多重继承，继承 EventEmitter 不会打乱对象原有的继承关系

顺便提一嘴，EventEmitter 即使绑定了 error 事件，也是不会输出的，而是会在控制台打印该异常的堆栈信息，并结束进程。 获取异常只能通过 try catch，如下格式：

 

  1. eventEmitter.on('error',function(err){

  2. console.error('Error:',err);

  3. });

具体就是，我们绑定的 error 事件，只能自己触发，使用eventEmitter.emit('error');， 当没有错误时，会在控制台打印 Error：undefined，有错误时，不会打印，直接打印该异常的堆栈信息，并结束进程。

还有两点咱也赘述上：

1、eventEmitter.on()与eventEmitter.addListener()没有区别，且一个事件可以绑定多个回调函数；

2、若事件队列中出现一个未绑定事件则触发error事件，若未绑定 error事件则程序抛出异常结束执行

我们可以使用类方法 listenerCount 获取指定事件的监听数量替代方案，如下：

eventEmitter.listeners('connection').length

完事就是removeListener('connection',callback); ，此处参数 callback 必须和监听器中的回调函数是同一个，否则不生效。

 我们最后来看个EventEmitter发送和接收事件的实例，如下：

 

  1. /*

  2. EventEmitter发送和接收事件

  3. HTTPServer和HTTPClient类，它们都继承自EventEmitter

  4.  

  5. EventEmitter被定义在Node的事件(events)模块中，直接使用EventEmitter类需要先声明require('events')，

  6. 否则不必显式声明require('events')，因为Node中很多对象都无需你调用require('events')就会使用EventEmitter

  7. */

  8. var events = require('events');

  9. var util = require('util');

  10.  

  11. function Pulser(){

  12. events.EventEmitter.call(this);

  13. }

  14. util.inherits(Pulser, events.EventEmitter);

  15.  

  16. Pulser.prototype.start = function(){

  17. var self = this;

  18. this.id = setInterval(function(){

  19. util.log('>>>>pulse');

  20. self.emit('pulse');

  21. util.log('<<<<pulse');

  22. }, 1000);

  23. }

  24. //定义了一个类Pulser，该类(通过util.inherits)继承自EventEmitter，它的作用是每隔一秒钟向所有监听器发送一个定时事件。

  25. //start方法使用了setInterval这个函数来定期重复执行回调函数，并调用emit方法将pulse事件发送给每一个监听器

  26.  
  27.  

  28. //使用Pulser对象

  29. /*

  30. 创建了一个Pulser对象并处理其pulse事件，执行pulser.on('pulse'..)为pulse事件和回调函数建立联系

  31. */

  32. var pulser = new Pulser();

  33. pulser.on('pulse', function(){

  34. util.log('pulse received');

  35. });

  36. pulser.start();

  37.  
  38.  

  39. //对象使用emit函数发送事件，所有注册到对应事件的监听器都可以收到事件；

  40. //通过调用.on方法注册监听器，参数是事件名，并用一个回调函数接收事件

  41. //通常来说，有一些数据需要伴随着事件同时发送 self.emit('eventName', data1, data2, ..);

  42. //emitter.on('eventName', function(data1, data2,..){

  43. //接收到事件后的操作

  44. // });

输出结果可以自己看下。

好啦，本次记录就到这里了。

如果感觉不错的话，请多多点赞支持哦。。。

上一篇：Node.js核心入门


下一篇：Node.js-Events 模块总结与源码解析