EventEmitter

Node.js 所有的异步 I/O 操作在完成时都会发送一个事件到事件队列。

Node.js 里面的许多对象都会分发事件：一个 net.Server 对象会在每次有新连接时触发一个事件， 一个 fs.readStream 对象会在文件被打开的时候触发一个事件。 所有这些产生事件的对象都是 events.EventEmitter 的实例。

EventEmitter 类

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 的监听器。

$ node event.js 
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 的属性介绍。

实例

以下实例通过 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 个监听器监听连接事件。
程序执行完毕。

error 事件

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

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

为什么要这样做呢？原因有两点：

首先，具有某个实体功能的对象实现事件符合语义， 事件的监听和发生应该是一个对象的方法。

其次 JavaScript 的对象机制是基于原型的，支持 部分多重继承，继承 EventEmitter 不会打乱对象原有的继承关系。

笔记

一楼

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

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

二楼

• EventEmitter 里面的 error 事件，EventEmitter 即使绑定了 error 事件，也是不会输出的。而是会在控制台打印该异常的堆栈信息，并结束进程。 获取异常只能通过 try catch。

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

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

三楼

• 使用类方法 listenerCount 获取指定事件的监听数量替代方案。

eventEmitter.listeners('connection').length

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

四楼

如果大家学过类似的语言可以深切感受到，on 和 emit的真正含义。

举个例子：

// 注册一个监听事件
eventEmitter.on('time_delay_event', function () {
console.log('time_delay_event执行', new Date().getTime());    });// 执行一次
setTimeout(function () {eventEmitter.emit('time_delay_event');}, 2000);// 在尝试一次
setTimeout(function () {eventEmitter.emit('time_delay_event');}, 4000);

• on：注册
• emit：执行 一次注册，不被销毁的情况下可以多次调用执行。

这也是它和 once 之间的区别。

五楼

res.addListener("finish", () => {
    console.log("server response is finished");
});

NodeJS 内置模块像 fs, http 等模块，它们的一些事件在底层也是基于 event 模块实现的。

let http = require("http");

// Returns: <http.Server>
let server = http.createServer((req, res) => {
    // 通过 http 模块的 STATUS_CODES 方法，直接获取一个包含状态码和状态信息的对象。
    // 获取对应状态码 418 的状态信息
    res.writeHead(418, http.STATUS_CODES["418"], {
        'Content-Type': 'text/html'
    });
    // 为 http.ServerResponse 对象绑定对 finish 事件的监听
    res.addListener("finish", () => {
        console.log("server response is finished");
    });
    res.end("<h1>Hello World</h1>");
}).listen(8080, () => {
    console.log("http server starts at 8080 port");
});

// <http.Server> Extends: <net.Server>
// <net.Server> Extends: <EventEmitter>
// 既然最终 <http.Server> 构造函数继承自 <EventEmitter> 构造函数，那么根据原型链的原理，
// 它也可以调用 <EventEmitter> 的 emitter.on(eventName, listener) 方法。
server.on("connection", () => {
    console.log("a client has connected to the server!");
});

/**
 * 用户打开页面8080端口后，Node服务器控制台输出：
 * http server starts at 8080 port
 * a client has connected to the server!
 * a client has connected to the server!
 * server response is finished
 * server response is finished
 */

以上代码中：

res.addListener("finish", () => {
        console.log("server response is finished");
 });

和

server.on("connection", () => {
    console.log("a client has connected to the server!");
});

底层实现都是 event 模块来实现。可以通过查看 NodeJS 文档来看继承关系。

链接

Node.js EventEmitter