Node.js EventEmitter

events 模块只提供了一个对象： events.EventEmitter。EventEmitter 的核心就是事件触发与事件监听器功能的封装。

你能够经过require("events");来访问该模块。

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

 

EventEmitter 对象若是在实例化时发生错误，会触发 error 事件。

当添加新的监听器时，newListener 事件会触发，当监听器被移除时，removeListener 事件被触发。

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

eventEmitter.on("myfn",function(){
    console.log("myfn被触发了");
})

setTimeout(function(){
    eventEmitter.emit("myfn");//触发事件
},1000)

 

 

 

带参数的状况

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

eventEmitter.on("myfn",function(n1,n2){
    console.log(n1+n2);
})

setTimeout(function(){
    eventEmitter.emit("myfn",3,4);//触发事件
},1000)

 

 

 

EventEmitter() 提供的方法：

addListener(event, listener)
为指定事件添加一个监听器到监听器数组的尾部。

on(event, listener)
为指定事件注册一个监听器，接受一个字符串 event 和一个回调函数。

server.on('connection', function (stream) {
  console.log('someone connected!');
});

once(event, listener)
为指定事件注册一个单次监听器，即 监听器最多只会触发一次，触发后马上解除该监听器。

server.once('connection', function (stream) {
  console.log('Ah, we have our first user!');
});

removeListener(event, listener)

移除指定事件的某个监听器，监听器必须是该事件已经注册过的监听器。

它接受两个参数，第一个是事件名称，第二个是回调函数名称。

var callback = function(stream) {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeAllListeners([event])
移除全部事件的全部监听器， 若是指定事件，则移除指定事件的全部监听器。

setMaxListeners(n)
默认状况下， EventEmitters 若是你添加的监听器超过 10 个就会输出警告信息。 setMaxListeners 函数用于提升监听器的默认限制的数量。

listeners(event)
返回指定事件的监听器数组。

emit(event, [arg1], [arg2], [...])
按监听器的顺序执行执行每一个监听器，若是事件有注册监听返回 true，不然返回 false。

 

类方法：

listenerCount(emitter, event)
返回指定事件的监听器数量。

events.emitter.listenerCount(eventName) 

//引入events模块
var events=require("events");
//建立EventEmitter()对象
var eventEmitter=new events.EventEmitter();
var count=eventEmitter.listenerCount("connection");
console.log("connection事件的监听器数量"+count);

 

事件：

newListener

• event - 字符串，事件名称

• listener - 处理事件函数

该事件在添加新监听器时被触发。

 

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

//监听器listener1
var listener1=function listener1(){
    console.log("监听器listener1执行")
}
//监听器listener2
var listener2=function listener2(){
    console.log("监听器listener2执行")
}

//为connection事件绑定两个监听器
eventEmitter.on("connection",listener1);
eventEmitter.on("connection",listener2);

//打印监听器数量
var count=eventEmitter.listenerCount("connection");
console.log("connection事件的监听器数量"+count);

//触发connection事件
eventEmitter.emit("connection");

//移除监听器listener1
eventEmitter.removeListener("connection",listener1);
console.log("监听器listener1再也不监听");

//触发connection事件
eventEmitter.emit("connection");

//移除监听器listener2
eventEmitter.removeListener("connection",listener2);
console.log("监听器listener2再也不监听");

//再次打印监听器数量
count=eventEmitter.listenerCount("connection");
console.log("connection事件的监听器数量"+count);

console.log("结束");

 

 

removeListener

• event - 字符串，事件名称

• listener - 处理事件函数

从指定监听器数组中删除一个监听器。须要注意的是，此操做将会改变处于被删监听器以后的那些监听器的索引。

 

EventEmitter 定义了一个特殊的事件 error，它包含了错误的语义，咱们在遇到 异常的时候一般会触发 error 事件。

当 error 被触发时，EventEmitter 规定若是没有响 应的监听器，Node.js 会把它看成异常，退出程序并输出错误信息。

咱们通常要为会触发 error 事件的对象设置监听器，避免遇到错误后整个程序崩溃。

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

//触发error
eventEmitter.emit("error");

 

 

大多数时候咱们不会直接使用 EventEmitter，而是在对象中继承它。

包括 fs、net、 http 在内的，只要是支持事件响应的核心模块都是 EventEmitter 的子类。