node总结之EventEmitter这个鬼了解下

左手的ㄟ右手 2022-05-13 16:00 217阅读 0赞

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");来访问该模块，如下：

// 引入 events 模块
    var events = require('events');
    // 创建 eventEmitter 对象
    var eventEmitter = new events.EventEmitter();

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

//event.js 文件
    var EventEmitter = require('events').EventEmitter; 
    var event = new EventEmitter(); 
    event.on('some_event', function() { 
        console.log('some_event 事件触发'); 
    }); 
    setTimeout(function() { 
        event.emit('some_event'); 
    }, 1000);

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

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

//event.js 文件
    var events = require('events'); 
    var emitter = new events.EventEmitter(); 
    emitter.on('someEvent', function(arg1, arg2) { 
        console.log('listener1', arg1, arg2); 
    }); 
    emitter.on('someEvent', function(arg1, arg2) { 
        console.log('listener2', arg1, arg2); 
    }); 
    emitter.emit('someEvent', 'arg1 参数', 'arg2 参数');

运行结果如下：

$ node event.js 
    listener1 arg1 参数 arg2 参数
    listener2 arg1 参数 arg2 参数

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

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

首先是方法：

<table> 
 <tbody> 
 <tr> 
 <th>序号</th> 
 <th>方法 &amp; 描述</th> 
 </tr> 
 <tr> 
 <td>1</td> 
 <td>addListener(event, listener) 为指定事件添加一个监听器到监听器数组的尾部。</td> 
 </tr> 
 <tr> 
 <td>2</td> 
 <td>on(event, listener) 为指定事件注册一个监听器，接受一个字符串 event 和一个回调函数。 <pre><code>server.on('connection', function (stream) {
 console.log('someone connected!');
});</code></pre> &nbsp; </td> 
 </tr> 
 <tr> 
 <td>3</td> 
 <td>once(event, listener) 为指定事件注册一个单次监听器，即 监听器最多只会触发一次，触发后立刻解除该监听器。 <pre><code>server.once('connection', function (stream) {
 console.log('Ah, we have our first user!');
});</code></pre> &nbsp; </td> 
 </tr> 
 <tr> 
 <td>4</td> 
 <td>removeListener(event, listener) 移除指定事件的某个监听器，监听器必须是该事件已经注册过的监听器。 它接受两个参数，第一个是事件名称，第二个是回调函数名称。 <pre><code>var callback = function(stream) {
 console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);</code></pre> &nbsp; </td> 
 </tr> 
 <tr> 
 <td>5</td> 
 <td>removeAllListeners([event]) 移除所有事件的所有监听器， 如果指定事件，则移除指定事件的所有监听器。</td> 
 </tr> 
 <tr> 
 <td>6</td> 
 <td>setMaxListeners(n) 默认情况下， EventEmitters 如果你添加的监听器超过 10 个就会输出警告信息。 setMaxListeners 函数用于提高监听器的默认限制的数量。</td> 
 </tr> 
 <tr> 
 <td>7</td> 
 <td>listeners(event) 返回指定事件的监听器数组。</td> 
 </tr> 
 <tr> 
 <td>8</td> 
 <td>emit(event, [arg1], [arg2], [...]) 按参数的顺序执行每个监听器，如果事件有注册监听返回 true，否则返回 false。</td> 
 </tr> 
 </tbody> 
</table>

类方法如下：

<table> 
 <tbody> 
 <tr> 
 <th>序号</th> 
 <th>方法 &amp; 描述</th> 
 </tr> 
 <tr> 
 <td>1</td> 
 <td>listenerCount(emitter, event) 返回指定事件的监听器数量。</td> 
 </tr> 
 </tbody> 
</table>

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

事件如下：

<table> 
 <tbody> 
 <tr> 
 <th>序号</th> 
 <th>事件 &amp; 描述</th> 
 </tr> 
 <tr> 
 <td>1</td> 
 <td>newListener 
 <ul> 
 <li> event - 字符串，事件名称 </li> 
 <li> listener - 处理事件函数 </li> 
 </ul>该事件在添加新监听器时被触发。 </td> 
 </tr> 
 <tr> 
 <td>2</td> 
 <td>removeListener 
 <ul> 
 <li> event - 字符串，事件名称 </li> 
 <li> listener - 处理事件函数 </li> 
 </ul>从指定监听器数组中删除一个监听器。需要注意的是，此操作将会改变处于被删监听器之后的那些监听器的索引。 </td> 
 </tr> 
 </tbody> 
</table>

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

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

var events = require('events');
    var eventEmitter = new events.EventEmitter();
    
    // 监听器 #1
    var listener1 = function listener1() {
       console.log('监听器 listener1 执行。');
    }
    
    // 监听器 #2
    var listener2 = function listener2() {
      console.log('监听器 listener2 执行。');
    }
    
    // 绑定 connection 事件，处理函数为 listener1 
    eventEmitter.addListener('connection', listener1);
    
    // 绑定 connection 事件，处理函数为 listener2
    eventEmitter.on('connection', listener2);
    
    var eventListeners = eventEmitter.listenerCount('connection');
    console.log(eventListeners + " 个监听器监听连接事件。");
    
    // 处理 connection 事件 
    eventEmitter.emit('connection');
    
    // 移除监绑定的 listener1 函数
    eventEmitter.removeListener('connection', listener1);
    console.log("listener1 不再受监听。");
    
    // 触发连接事件
    eventEmitter.emit('connection');
    
    eventListeners = eventEmitter.listenerCount('connection');
    console.log(eventListeners + " 个监听器监听连接事件。");
    
    console.log("程序执行完毕。");

执行结果如下：

$ node main.js
    2 个监听器监听连接事件。
    监听器 listener1 执行。
    监听器 listener2 执行。
    listener1 不再受监听。
    监听器 listener2 执行。
    1 个监听器监听连接事件。
    程序执行完毕。

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

var events = require('events'); 
    var emitter = new events.EventEmitter(); 
    emitter.emit('error');

运行结果如下：

node.js:201 
 throw e; // process.nextTick error, or 'error' event on first tick 
 ^ 
 Error: Uncaught, unspecified 'error' event. 
 at EventEmitter.emit (events.js:50:15) 
 at Object.<anonymous> (/home/byvoid/error.js:5:9) 
 at Module._compile (module.js:441:26) 
 at Object..js (module.js:459:10) 
 at Module.load (module.js:348:31) 
 at Function._load (module.js:308:12) 
 at Array.0 (module.js:479:10) 
 at EventEmitter._tickCallback (node.js:192:40)

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

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

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

eventEmitter.on('error',function(err){
        console.error('Error:',err);
    });

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

还有两点咱也赘述上：

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

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

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

eventEmitter.listeners('connection').length

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

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

/*
 EventEmitter发送和接收事件
 HTTPServer和HTTPClient类，它们都继承自EventEmitter
 
 EventEmitter被定义在Node的事件(events)模块中，直接使用EventEmitter类需要先声明require('events')，
 否则不必显式声明require('events')，因为Node中很多对象都无需你调用require('events')就会使用EventEmitter
 */
 var events = require('events');
 var util = require('util');
 
 function Pulser(){
 events.EventEmitter.call(this);
 }
 util.inherits(Pulser, events.EventEmitter);
 
 Pulser.prototype.start = function(){
 var self = this;
 this.id = setInterval(function(){
 util.log('>>>>pulse');
 self.emit('pulse');
 util.log('<<<<pulse');
 }, 1000);
 }
 //定义了一个类Pulser，该类(通过util.inherits)继承自EventEmitter，它的作用是每隔一秒钟向所有监听器发送一个定时事件。
 //start方法使用了setInterval这个函数来定期重复执行回调函数，并调用emit方法将pulse事件发送给每一个监听器
 
 
 //使用Pulser对象
 /*
 创建了一个Pulser对象并处理其pulse事件，执行pulser.on('pulse'..)为pulse事件和回调函数建立联系
 */
 var pulser = new Pulser();
 pulser.on('pulse', function(){
 util.log('pulse received');
 });
 pulser.start();
 
 
 //对象使用emit函数发送事件，所有注册到对应事件的监听器都可以收到事件；
 //通过调用.on方法注册监听器，参数是事件名，并用一个回调函数接收事件
 //通常来说，有一些数据需要伴随着事件同时发送 self.emit('eventName', data1, data2, ..);
 //emitter.on('eventName', function(data1, data2,..){
 //接收到事件后的操作
 // });

输出结果可以自己看下。

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

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