Node.js EventEmitter

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 事件被触发。

例子：

//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);

$ node event.js
some_event 事件触发

EventEmitter 的每个事件由一个事件名和若干个参数组成，事件名是一个字符串，通常表达一定的语义。对于每个事件，EventEmitter 支持 若干个事件监听器。

当事件触发时，注册到这个事件的事件监听器被依次调用，事件参数作为回调函数参数传递。

var events = require('events');
var emitter = new events.EventEmitter();
//用匿名函数绑定someEvent事件
emitter.on('someEvent',function(arg1,arg2){
console.log('listener1',arg1,arg2);
});
emitter.on('someEvent',function(arg1,arg2){
console.log('listener2',arg1,arg2);
});

//触发事件SomeEvent
emitter.emit('someEvent','arg参数1'，'arg参数2');

$node event.js
listener1 arg参数1 arg参数2
listener2 arg参数1 arg参数2

EventEmitter属性

1 addListener(event, listener)

为指定事件添加一个监听器到监听器数组的尾部。

2 on(event, listener)

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

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

3 once(event, listener)

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

server.once('connection', function (stream) {
console.log('Ah, we have our first user!');
});

4 removeListener(event, listener)

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

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

var callback = function(stream) {
console.log('someone connected!');
};

server.on('connection', callback);

// …

server.removeListener('connection', callback);

5 removeAllListeners([event])

移除所有事件的所有监听器， 如果指定事件，则移除指定事件的所有监听器。事件参数可有可无；

6 setMaxListeners(n)

默认情况下， EventEmitters 如果你添加的监听器超过 10 个就会输出警告信息。 setMaxListeners 函数用于提高监听器的默认限制的数量。

7 listeners(event)

返回指定事件的监听器数组。

8 emit(event, [arg1], [arg2], […])

按参数的顺序执行每个监听器，如果事件有注册监听返回 true，否则返回 false。

var events = require('events');

var eventEmitter = new events.EventEmitter();

var connection = function(){
console.log('someone connected');
};

eventEmitter.on('connection',connection);

var cancleConnection = function(){
console.log('cancle connection');
};

eventEmitter.on('connection',cancleConnection);

eventEmitter.emit('connection',connection,cancleConnection);

类方法：

1 listenerCount(emitter, event)

返回指定事件的监听器数量。

console.log(eventEmitter.listenerCount(eventEmitter,connection));

事件

1 newListener

event - 字符串，事件名称

listener - 处理事件函数

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

2 removeListener

event - 字符串，事件名称

listener - 处理事件函数

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

实例：

var events = require('events');

var eventEmitter = new events.EventEmitter();

var listener1 = function listener1(){
console.log('监听器 listener1 执行');
}

var listener2 = function listener2(){
console.log('监听器 listener2 执行');
}

//增加监听器
eventEmitter.addListener('connection',listener1);

//绑定监听器到时间上
eventEmitter.on('connection',listener2);

var eventListeners = require('events').EventEmitter.listenerCount(eventEmitter,'connection');

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

eventEmitter.emit('connection');

//移除绑定的listener1
eventEmitter.removeListener('connection',listener1);
console.log("listener1 不在受监听");

eventEmitter.emit('connection');

var eventListeners = require('events').EventEmitter.listenerCount(eventEmitter,'connection');

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

console.log("执行完毕");

$ node /Users/mac/Desktop/js/5.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)