Node,js EvebrEmitter
Node.js所有的异步I/O操作在完成时都会发送一个事件到队列
Node.js里面的许多对象都会分发事件:一个net Serve对象会在每次有新连接时触发一个事件,一个fs.readStream对象会在文件被打开时触发一个事件;所有这些产生事件的对象都是events.EventEmitter的实例
EventEmitter类
event模块只提供了一个对象:events.EventEmitter;EventEmitter的核心就是事件触发于事件监听器功能的封装;可以通过require(“eventes”);来访问该模块
// 引入events模块
var events = require('events');
// 创建eventsEmitter对象
var eventsEmitter = new events.EventEmitter();
EveentEmitter对象如果在实例化时发生错误,会触发error事件;当添加新的监听器时,newListener事件会触发,当监听器被移除时,removeListener事件会被触发
下面例子说明了EventEmitter的用法:
// event.js文件
var EventEmitter = require('events').EventEmitter;
var event = new EventEmitter();
event.on('some_events',function() {
console.log('some_event事件触发');
});
setTimeout(function() {
event.emit('some_event');
}, 2000);
执行上面代码,两秒后控制台输出了“some_events事件触发”;其原理是event对象注册了事件some_event的一个监听器,然后通过setTimeout在2000毫秒后想event对象发送事件some_event,此时会调用some_event的监听器
$ node event.js
some.event 事件触发
EventEmitter的每个事件由一个事件名和若干个参数组成,事件名是一个字符串,通常表达一定的语义;对于每个事件,EventEmitter支持若干个事件监听器
当触发事件的时候,注册到这个事件的事件监听器被依次调用,事件参数作为回调函数参数传递
下面写个例子来解释过程
// event.js 文件
var events = rquire('events');
var emitter = new events.EventEmitter();
emitterr.on('so,eEvent', function(arg1, arg2) {
console.log('listener1', arg1, arg2);
})
emitter.on('someEvent', fumction(arg1, arg2) {
console.log('listener2', arg1, arg2);
});
emitter.emit('someEvent', 'arg1 参数', 'arg2 参数')
运行结果如下:
$ node events.js
listener1 arg1 参数 arg2 参数
listener2 arg1 参数 arg2 参数
上面的例子上,emitter为事件someEvent注册了两个事件监听器,然后触发了someEvent事件
运行结果中科院看到两个事件监听器回调函数呗先后调用,这就是EventEmitter最简单的用法
EventEmitter提供了多个属性,如on和emit;on函数用于绑定事件函数,emit属性用于触发一个事件;下面看天EventEmitter的属性具体介绍
方法
排序 | 方法&描述 |
---|---|
1 | addListener(event,listener) 为指定事件添加一个监听器数组的尾部 |
2 | on(event,listener) 为指定事件注册一个监听器,接受一个字符串event和一个回调函数 server.on(‘connection’, function (stram) { console.log(‘someone connected!’); }); |
3 | once(event,listener) 为指定事件注册一个单次监听器,注: 监听器最多只会触发一次,触发后立即解除该监听器 server.once(‘connection’, function (stram) { 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(‘connction’, callback); |
5 | removeAllListeners([event]) 移除所有事件的监听器,如果指定事件,则移除指定事件的所有监听器 |
6 | setMaxListeners(n) 默认情况下,EventEmitters如果添加的监听器超过10个就会输出警告信息;setMaxLsiteners函数用于改变监听器的默认限制的数量 |
7 | listeners(event) 返回指定事件的监听器数组 |
8 | emit(event, [arg1], [arg2], […]) 按监听器的顺序执行每个监听器,如果有事件注册监听返回true,否则返回false |
类方法
排序 | 方法&描述 |
---|---|
1 | listenerCount(emitter,event) 返回指定事件的监听器数量 |
events.EventEmitter.listenerCount(emitter,eventName) // 已经废弃了,不推荐使用
events.emitter.listenerCount(eventName) // 推荐使用
排序 | 方法&描述 |
---|---|
1 | newListener event-字符串,事件名称 listener-处理事件函数 该事件在添加新监听器时被触发 |
2 | removeListener event-字符串,事件名称 lsitener-处理事件函数 从指定监听器数组中删除一个监听器;需要注意的是,此操作将会改变处于被删除监听器之后的那些监听器的索引 |
实例
下面的实例通过connection(链接)事件演示了EventEmitter类的应用
创建main.js,如下
var events = require('events');
var eventEmitter = new events.EventEmitter();
// 监听器 1
var listener1 = function listener1() {
console.log('监听器 litsener1 执行')
}
// 监听器 2
var litsener2 = function listener2() {
console.log('监听器 listener2 执行')
}
// 绑定connection事件,处理函数为listener1
eventEmitter.addListener('connction', listener1);
// 绑定connection事件,处理函数listener2
eventEmitter.on('connction', listener2);
var eventListeners = eventEmitter.listenerCount('connction');
console.log(eventListeners + "个监听器监听连接事件");
// 处理connection事件
eventEmitter.emit('connection');
// 移除监绑定的listener1函数
eventEmitter.removeListener('connection',listener1);
console.log('listener1 不再受监听');
// 触发连接事件
eventEmitter.emit('connection');
eventListeners = eventEmitter.listenerCount('connection');
console.log(eventListeners + "个监听器连接事件");
console.log("执行完成")
执行结果:
$ node main.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');
继承EventEmitter
大多数时候,我们不会直接使用EventEmitter,而是在对象中继承它;包括fs、net、http在内的,只要是支持事件相应的核心模块都是EventEmitter的子类
为什么要这样做呢?原因有两点
- 具有某个实体功能的对象实现事件符号语义,事件的监听和发生应该是一个对象的方法
- javaScript的对象机制是基于原型的,支持部分多重继承,继承EventEmitter不会打乱对象原有的继承关系
ps:前两天顺序发错了,直接发了第六天的