Node.js EventEmitter
Node.js EventEmitter
参考https://www.runoob.com/nodejs/nodejs-event.html
- Node.js中所有的异步IO操作在完成时都会发送一个事件到事件队列。
- Node.js里面的许多对象都会触发事件:
1. 一个net Server对象会在每次有新连接时触发一个事件; 2. 一个fs.readStream对象会在文件被打开的时候触发一个事件。
- 所有这些可以触发事件的对象都是events.Emitter的实例。
EventEmitter类
events模块只提供了一个对象:eventEmitter。EventEmitter的核心就是事件触发和事件监听器功能的封装。我们通过require('events')来引入events模块:
// 引入events模块
var events = require('events');
// 创建eventEmitter对象
var eventEmitter = new event.EventEmitter();
-
EventEmitter对象如果在实例化的过程中发生错误,会触发error事件;
-
当添加新的监听器时,newListener事件会被触发;
-
当监听器被移除时,removeListener事件被触发。
例如:var EventEmitter = require('events').EventEmitter; var event = new EventEmitter(); event.on('some_event', function(){ console.log('some_event事件触发'); }); // 1s后触发some_event事件 setTimeout(function(){ event.emit('some_event'); }, 1000);
结果:
some_event事件触发
方法
-
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。
类方法
listenerCount(emitter, event),返回指定事件的监听器数量。
var events = require('events');
events.EventEmitter.listenerCount(emitter, eventName);// 已废弃,不推荐
events.EventEmitter.listenerCount(eventName);// 推荐
事件
- newListener(event, listener),在添加新监听器时被触发;
- removeListener(event, listener),在移除监听器时被触发。
error事件
EventEmitter定义了一个特殊的事件error,就是错误的意思,程序执行错误的时候会触发error事件。
当error事件被触发的时候,如果没有响应的监听器,它就会被当作异常,并退出程序和输出错误信息。
所以我们一般会为可能会触发error事件的对象设置监听器,避免出发后程序直接崩溃,例如:
var events = require('events');
var emitter = new events.EventEmitter();
emitter.on('error',function(){
console.log('error事件触发');
})
emitter.emit('error');
console.log('程序执行结束');
结果:
由于设置了error事件的监听器(事件处理),所以程序可以继续向下执行。
继承EventEmitter
大多数时候我们不会直接使用EventEmitter,而是在在对象中继承它。像fs、net、http等,只要是支持事件响应的黑核心模块都是EventEmitter的子类。
为什么这样做呢?
- 首先,事件的监听和发生应该是一个对象的方法;
- 其次,JavaScript的对象机制是基于原型的,支持部分多重继承,继承EventEmitter*8不会打乱原有对象的继承关系。