events模块
只提供了一个对象:events.EventEmitter。EventEmitter 的核心就是事件触发与事件监听器功能的封装。
//引入events模块
let event =require('events')
//创建eventEmitter对象
let eventEmitter=new events.EventEmitter()
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);
上例代码运行后会输出’some_event 事件触发‘,原因是先给event添加了‘some_event’事件监听,在1秒后利用.emit想event发送了‘some_event‘事件。
EventEmitter 提供了多个属性,如 on 和 emit。on 函数用于绑定事件函数,emit 属性用于触发一个事件。
EventEmitter 的属性介绍
1 | addListener(event, listener) 为指定事件添加一个监听器到监听器数组的尾部。 |
---|---|
2 | on(event, listener) 为指定事件注册一个监听器,接受一个字符串 event 和一个回调函数。```js`server.on(‘connection’, function (stream) { console.log(‘someone connected!’); });```` |
3 | once(event, listener) 为指定事件注册一个单次监听器,即 监听器最多只会触发一次,触发后立刻解除该监听器。```js`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。 |
9 | events.emitter.listenerCount(eventName) ,返回指定时间的监听器数量 |
事件
1 | newListener event - 字符串,事件名称listener - 处理事件函数该事件在添加新监听器时被触发。 |
---|---|
2 | removeListener event - 字符串,事件名称listener - 处理事件函数从指定监听器数组中删除一个监听器。需要注意的是,此操作将会改变处于被删监听器之后的那些监听器的索引。 |
例子:
let events = require('events')
let eventEmitter = new events.EventEmitter()
//设置监听器1
let listener1 = function listener1() {
console.log('listener1执行');
}
//设置监听器2
let listener2 = function listener2() {
console.log('listener2执行');
}
//绑定connection事件,监听器1
eventEmitter.addListener('connection', listener1)
//绑定connection事件,监听器2
eventEmitter.addListener('connection', listener2)
let eventListeners = eventEmitter.listenerCount('connection')
console.log(eventListeners + '个监听器链接connection事件');
//触发connection事件
eventEmitter.emit('connection')
//移除绑定的监听器
eventEmitter.removeListener('connection', listener1)
console.log('eventEmitter不再受监听器1的监听');
//触发connection事件
eventEmitter.emit('connection')
//更新监听器数量
eventListeners = eventEmitter.listenerCount('connection')
console.log(eventListeners + '个监听器链接connection事件');
输入结果:
error事件
error是EventEmitter 定义的一个特殊事件
继承EventEmitter
fs,net,http支持事件响应的核心模块都是EventEmitter的子类