参考内容:
Node.js EventEmitter
四、Node.js EventEmitter
Node.js所有异步I/O操作在完成时都会发送一个事件到事件队列;
Node.js里许多对象都会分发事件:一个net.Server对象会在每次有新连接时分发一个事件,一个fs.readStream对象会在文件被打开时发出一个事件。所有这些产生事件的对象都是events.EventEmitter的实例。
EventEmitter类
- events模块只提供了一个对象:events.EventEmitter,它的核心是事件触发与事件监听器功能的封装。可以通过
require('events');
来访问该模块。
// 引入events模块
var events = require('events');
// 创建eventEmitter对象
var eventEmitter = new events.EventEmitter();
- EventEmitter对象如果在实例化时发生错误,会触发error事件;当添加新监听器时,newListener事件会触发;当监听器被移除时,removeListener事件被触发。该对象用法如下:
// 2.4.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);
-
运行代码,1s后控制台输出'some_event 事件触发'。原理是event对象注册了事件some_event的一个监听器,然后我们通过serTimeout在1000毫秒后向event对象发送事件some_event,此时调用some_event的监听器。
EventEmitter的每个事件由一个事件名和若干参数组成,事件名是一个字符串,通常表达一定的语义;对于每个事件,Event Emitter支持若干个事件监听器。
当事件触发时,注册到这个事件的监听器被依次调用,事件参数作为回调函数参数传递。
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参数');
方法
NO. | 方法&描述(详情见参考链接) |
---|---|
1 | addListener(event, listener) 为指定事件添加一个监听器到监听器数组的尾部。 |
2 | on(event, listener) 为指定事件注册一个监听器,接受一个字符串event和一个回调函数。 |
3 | once(event, listener) 为指定事件注册一个单次监听器,即监听器最多只会触发一次,触发后立刻解除该监听器。 |
4 | removeListener(event, listener) 移除指定事件的某个监听器,监听器必须是该事件已经注册过的监听器。 它接受两个参数,第一个是事件名称,第二个是回调函数名称。 |
5 | removeAllListener([event]) 移除所有事件的所有监听器,如果指定事件,则移除指定事件的所有监听器。 |
6 | setMaxListener(n) 默认情况下, EventEmitters 如果你添加的监听器超过 10 个就会输出警告信息。 setMaxListeners 函数用于提高监听器的默认限制的数量。 |
7 | listeners(event) 返回指定事件的监听器数组。 |
8 | emit(event, [arg1], [arg2], [...]) 按参数的顺序执行每个监听器,如果事件有注册监听返回 true,否则返回 false。 |
类方法
NO. | 方法&描述(详情见参考链接) |
---|---|
1 | listenerCount(emitter, event) 返回指定事件的监听器数量。 |
其余参见参考内容链接