EventEmitter顾名思义,就是事件发射器的意思;和java中的Listener类似。
Node.js 所有的异步 I/O 操作在完成时都会发送一个事件到事件队列。
Node.js里面的许多对象都会分发事件:一个net.Server对象会在每次有新连接时分发一个事件, 一个fs.readStream对象会在
文件被打开的时候发出一个事件。 所有这些产生事件的对象都是 events.EventEmitter 的实例。
EventEmitter 类
创建一个EventEmitter.js文件,内容为:
var events = require('events');
var eventEmitter = new events.EventEmitter();
eventEmitter.on('someEvent', function() {
console.log('someEvent 事件触发');
});
setTimeout(function() {
eventEmitter.emit('someEvent');
}, 1000);
执行node EventEmitter.js后,结果如下图:
运行代码1 秒后,控制台输出了 'someEvent 事件触发'。其原理是 eventEmitter对象注册了事件 someEvent 的一个监听器,
然后我们通过 setTimeout 在 1000 毫秒(为了效果明显,你可以设置为10秒)后让 eventEmitter对象发送了事件 someEvent ,
此时会调用someEvent 事件。
EventEmitter 的每个事件由一个事件名和若干个参数组成,事件名是一个字符串,通常表达一定的语义。对于每个事件,
EventEmitter 支持若干个事件监听器。当事件触发时,注册到这个事件的事件监听器被依次调用,事件参数作为回调函数参数传递。代码如下:
var events = require('events');
var eventEmitter = new events.EventEmitter();
eventEmitter.on('someEvent', function() {
console.log('someEvent 事件触发');
});
eventEmitter.on('someEvent', function(arg1) {
console.log('someEvent 事件触发' , arg1);
});
eventEmitter.on('someEvent', function(arg1 , arg2) {
console.log('someEvent 事件触发' , arg2);
});
setTimeout(function() {
eventEmitter.emit('someEvent' , "arg1" , "arg2");
}, 1000);
执行结果如下:
可以看出Node.js的语法还是比较自由的,不要求参数完全对应。
方法(Methods)
1.addListener(eventName, listener)
为指定事件添加一个监听器到监听器数组的尾部,on(eventName, listener)的别名。
2.on(eventName, listener)
为指定事件添加一个监听器到监听器数组的尾部,例子见上面。
3.once(eventName, listener)
只调用当前事件的当前监听器一次,事件调用后监听器会被移除,第二次无法调用。示例如下:
var events = require('events') ;
var eventEmitter = new events.EventEmitter() ;
eventEmitter.once('someEvent' , function(){
console.log("someEvent1") ;
}) ;
eventEmitter.on('someEvent' , function(){
console.log("someEvent2") ;
}) ;
eventEmitter.emit('someEvent') ;
setTimeout(function(){
console.log("----------------------");
eventEmitter.emit('someEvent') ;
} , 3000);
输出结果:
someEvent1
someEvent2
可见第一次的监听器被移除了。
4.removeListener(eventName, listener)
移除某个事件的一个监听器,示例如下:
var events = require('events') ;
var eventEmitter = new events.EventEmitter() ;
function function01(){
console.log("function01") ;
}
function function02(){
console.log("function02") ;
}
eventEmitter.on('someEvent' , function01) ;
eventEmitter.on('someEvent' , function02) ;
eventEmitter.emit('someEvent') ;
setTimeout(function(){
console.log("-----------------");
eventEmitter.removeListener('someEvent' , function01) ;
eventEmitter.emit('someEvent') ;
} , 3000);
输出结果:
function01
function02
5.removeAllListeners([eventName])
移除某个事件的所有监听器。
6.setMaxListeners(n)
设置监听器的上限,默认情况下,如果你添加的监听器超过 10 个就会输出警告信息。 setMaxListeners 函数用于提高监听器的默认限制的数量。
7.listeners(eventName)
返回事件的所有监听器。返回格式如下:
[
[Function: listener],
...
]
8.emit(eventName[, arg1][, arg2][, …])
以事件监听器注册的顺序唤醒该事件的所有监听器,并传递参数,如果该事件有监听器返回true,否则返回false 。
备注
EventEmiter的类方法已经不建议使用,所以本文没有列举。
error 事件
EventEmitter 定义了一个特殊的事件 error,它包含了错误的语义,我们在遇到 异常的时候通常会触发 error 事件。
当 error 被触发时,EventEmitter 规定如果没有响 应的监听器,Node.js 会把它当作异常,退出程序并输出错误信息。
我们一般要为会触发 error 事件的对象设置监听器,避免遇到错误后整个程序崩溃。例如:
...
eventEmitter.on('error', function(err){
console.log('whoops! there was an error by eventEmitter\n' + err);
});
eventEmitter.emit('error', new Error('whoops!'));
...
输出结果:
whoops! there was an error by eventEmitter
Error: whoops!