说明
Node.js 所有的异步 I/O 操作在完成时都会发送一个事件到事件队列。
Node.js里面的许多对象都会分发事件:一个net.Server对象会在每次有新连接时分发一个事件, 一个fs.readStream对象会在文件被打开的时候发出一个事件。 所有这些产生事件的对象都是 events.EventEmitter 的实例。
events 模块只提供了一个对象: events.EventEmitter。EventEmitter 的核心就是事件触发与事件监听器功能的封装。
你可以通过require("events");来访问该模块。
// 引入 events 模块 var events = require('events'); // 创建 eventEmitter 对象 var eventEmitter = new events.EventEmitter();
EventEmitter 对象如果在实例化时发生错误,会触发 'error' 事件。当添加新的监听器时,'newListener' 事件会触发,当监听器被移除时,'removeListener' 事件被触发。
EventEmitter对象常用API1.添加事件监听
addListener(event, listener)
为指定事件添加一个监听器到监听器数组的尾部。
on(event, listener)
为指定事件注册一个监听器,接受一个字符串 event 和一个回调函数。
once(event, listener)
为指定事件注册一个单次监听器,即 监听器最多只会触发一次,触发后立刻解除该监听器。removeListener(event, listener)
移除指定事件的某个监听器,监听器 必须是该事件已经注册过的监听器。
2.移除事件监听
removeListener(event, listener)
移除指定事件的某个监听器,监听器 必须是该事件已经注册过的监听器。
removeAllListeners([event])
移除所有事件的所有监听器, 如果指定事件,则移除指定事件的所有监听器。
3. 手动触发事件
emit(event, [arg1], [arg2], [...])
按参数的顺序执行每个监听器,如果事件有注册监听返回 true,否则返回 false。
4.其他接口
listenerCount(emitter, event)
返回指定事件的监听器数量。
setMaxListeners(n)
默认情况下, EventEmitters 如果你添加的监听器超过 10 个就会输出警告信息。 setMaxListeners 函数用于提高监听器的默认限制的数量。
listeners(event)
返回指定事件的监听器数组。
5.EventEmitter已定义事件
newListener
-
event - 字符串,事件名称
-
listener - 处理事件函数
该事件在添加新监听器时被触发。
removeListener-
event - 字符串,事件名称
-
listener - 处理事件函数
从指定监听器数组中删除一个监听器。需要注意的是,此操作将会改变处于被删监听器之后的那些监听器的索引。
实例1:
var events=require('events');
var myEmitter=new events.EventEmitter();
//如果事件已经注册,执行事件,返回true
//如果事件没有注册,返回false
var result=myEmitter.emit('sayHello');
console.log(result);//false
实例2,添加或移除事件:
var events=require('events');
var emitter=new events.EventEmitter();
//注册事件链
emitter.on('someEvent',(arg1,arg2)=>{
console.log('listener1,',arg1,arg2);
});
emitter.on('someEvent',(arg1,arg2)=>{
console.log('listener2,',arg1,arg2);
});
var sayHello=()=>{
console.log('Hello events');
};
emitter.on('sayHello',sayHello);
//移除单个事件
//emitter.removeListener('sayHello',sayHello);
//移除所有事件
//emitter.removeAllListeners();
//移除事件链
//emitter.removeAllListeners('someEvent');
//获取事件数量,如果没有指定事件名称返回0
var count=emitter.listenerCount('someEvent');
console.log(count); //2
setTimeout(()=>{
//触发事件
emitter.emit('someEvent','参数1','参数2');
//触发事件
emitter.emit('sayHello','参数1');
console.log('事件触发完毕');
},2000);
实例3.EventEmitter已定义事件:
//EventEitter 中事件监听
var events = require('events');
var util=require('util');
var emitters = new events.EventEmitter();
//如果有移除事件时触发
//一般建议先注册移除监听,再注册添加监听,否则,当注册removeListener时也会触发newListener
emitters.on('removeListener',(event,listener)=>{
console.log('remove:'+event); //sayHello
//console.log(listener);
});
//如果有新注册事件时触发
//每次注册都触发,例如sayHello 注册了两个函数,则触发两次
emitters.on('newListener', (event, listenter) => {
console.log('add:'+event); //sayHello
//console.info(listenter); // [Function]
//console.log(util.inspect(listenter,true)); //{ [Function] [length]: 0, [name]: '' }
});
//注册自定义事件
emitters.on('sayHello',()=>{
console.log('Hello events');
});
emitters.on('sayHello',()=>{
console.log('Hello events 2');
});
//移除自定义事件
emitters.removeAllListeners('sayHello');
// //触发事件
emitters.emit('sayHello');