nodejs eventemitter——迹忆客-ag捕鱼王app官网

nodejs 所有的异步 i/o 操作在完成时都会发送一个事件到事件队列。

nodejs 里面的许多对象都会分发事件：一个 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 的属性介绍。

方法

类方法

events.eventemitter.listenercount(emitter, eventname) //已废弃，不推荐
events.emitter.listenercount(eventname) //推荐

事件

实例

以下实例通过 connection（连接）事件演示了 eventemitter 类的应用。

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

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. (/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 不会打乱对象原有的继承关系。