Node.js 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‘,arg2) { 
    console.log(‘listener2‘,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 的属性介绍。

addListener(event,listener)
为指定事件添加一个监听器到监听器数组的尾部。

on(event,listener)
为指定事件注册一个监听器，接受一个字符串 event 和一个回调函数。

server.on(‘connection‘,function (stream) {
  console.log(‘someone connected!‘);
});

addListener和on是一样的，都是注册监听器

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

removeListener(event,listener)

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

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

removeAllListeners([event])
移除所有事件的所有监听器，如果指定事件，则移除指定事件的所有监听器。

实例

以下实例通过 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

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

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

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

摘自：

http://www.runoob.com/nodejs/nodejs-event.html

Node.js EventEmitter

Node.js EventEmitter

EventEmitter 类

实例

继承 EventEmitter

相关推荐