Node.js EventEmitter

Node.js 所有的异步 I/O 操作在完成时都会发送一个事件到事件队列。

Node.js里面的许多对象都会分发事件:一个net.Server对象会在每次有新连接时分发一个事件, 一个fs.readStream对象会在文件被打开的时候发出一个事件。 

所有这些产生事件的对象都是events.EventEmitter 的实例。 

EventEmitter类

EventEmitter是event模块提供的唯一一个对象,它的核心就是事件出发与事件监听器功能的封装。

可以通过require("events");来访问该模块。

实例:

// 引入events模块
var events = require('events');
// 创建eventEmitter对象
var eventEmitter = new events.EventEmitter();

EventEmitter 对象如果在实例化时发生错误,会触发 error 事件。当添加新的监听器时,newListener 事件会触发,当监听器被移除时,removeListener 事件被触发。

实例:

//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);

说明:运行这段代码,1 秒后控制台输出了 'some_event 事件触发'。其原理是 event 对象注册了事件 some_event 的一个监听器,然后我们通过 setTimeout 在 1000 毫秒以后向 event 对象发送事件 some_event,此时会调用some_event 的监听器。

运行结果如下:

$ node event.js 
some_event 事件触发

 EventEmitter 的每个事件由一个事件名和若干个参数组成,事件名是一个字符串,通常表达一定的语义。对于每个事件,EventEmitter 支持 若干个事件监听器。

当事件触发时,注册到这个事件的事件监听器被依次调用,事件参数作为回调函数参数传递。

实例:

//event.js文件
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 参数');

运行结果如下:

$ node event.js 
listener1 arg1 参数 arg2 参数
listener2 arg1 参数 arg2 参数

说明:emitter 为事件 someEvent 注册了两个事件监听器,然后触发了 someEvent 事件。运行结果中可以看到两个事件监听器回调函数被先后调用。 这就是EventEmitter最简单的用法。

EventEmitter 属性

方法说明
addListener(event,listener)为指定事件添加一个监听器到监听器数组的尾部
on(event,listener)
为指定事件注册一个监听器,接受一个字符串event和一个回调函数
once(event,listener)
为指定事件注册一个单次监听器,即监听器最多只会触发一次,触发后立即解除该监听器。
removeListener(event,listener)移除指定事件的某个监听器,监听器必须是该时间已经注册过的监听器。它接受两个参数,第一个是事件名称,第二个是回调函数名称。
removeAllListeners([event])
移除所有事件的所有监听器,如果指定事件,则移除指定事件的所有监听器。
setMaxListeners(n)默认情况下,EventEmitter添加的监听器超过10个就会输出警告信息。此函数用于提高监听器的默认限制的数量。
Listeners(event)返回指定事件的监听器数组。
emit(event,[arg1],[arg2],[...])按参数的顺序执行每个监听器,如果事件有注册监听返回true,否则返回false。
listenerCount(emitter,event)返回指定事件的监听器数量。
事件说明
newListener
该事件在添加新监听器时被触发。
removeListener

从指定监听器数组中删除一个监听器。

需要注意的是,这个操作将会改变处于被监听器之后的监听器的索引。


本内容均来自互联网,仅供参考,如有侵权请及时通知本站予以删除。邮箱:wiki#imooc.com (#改成@)

意见反馈 帮助中心 APP下载
官方微信