摘要
Node.js所有的异步I/O操作在完成时都会发送一个事件到事件队列。并且许多对象都会分发事件:一个net.Server对象会在每次有新连接时分发一个事件,一个fs.readStream对象会再文件被打开的时候发出一个事件。所有这些产生事件的都是events.EventEmitter的实例。
EventEmitter类
events模块只提供一个对象:events.EventEmitter,EventEmitter的核心就是事件触发与事件监听器功能的封装。可以通过下面的代码访问该模块:
//引入evnets模块var events=require("events");//创建eventEmittervar eventEmitter = new events.EventEmitter();
Note
EventEmitter对象如果在实例化时发生错误,会触发‘error’事件。当添加新的监听器时,‘newListener’事件会触发,当监听器被移除时,‘removeListener’事件被触发。
用法:
//引入events模块var events=require("events");//创建eventEmitter对象var eventEmitter=new events.EventEmitter();//绑定事件以及事件处理程序。eventEmitter.on("any_event",function(){ console.log("any_event事件被触发");});setTimeout(function(){ //触发事件 eventEmitter.emit("any_event");}, 1000);
执行:
运行这段代码,1s后控制台输出‘any_event事件被触发’。其原理是eventEmitter对象注册了事件any_evnet的一个监听器,然后我们通过setTimeout在1s以后向eventEmitter发送事件any_event,此时会调用any_event的监听器。
EventEmitter的每个事件由一个事件名和若干个参数组成,事件名是一个字符串,通常表达一定的语义。对于每个事件,EventEmitter支持若干个事件监听器。当事件触发时,注册到这个事件的事件监听器被依次调用,事件参数作为回调函数参数传递。
一个简单例子
//引入events模块var events=require("events");//创建eventEmitter对象var eventEmitter=new events.EventEmitter();//绑定事件以及事件处理程序。eventEmitter.on("any_event",function(arg1,arg2){ console.log("listener1",arg1,arg2);});eventEmitter.on("any_event",function(arg1,arg2){ console.log("listener2",arg1,arg2);});//触发事件eventEmitter.emit("any_event","arg1 参数","arg2 参数");
执行
以上例子中,eventEmitter为事件any_event注册了两个事件监听器,然后出发了any_event事件。运行结果中可以看到两个事件监听器回调函数被先后调用。EventEmitter提供了多个方法,如on和emit,on函数用于绑定事件函数,emit函数用于触发一个事件。
EventEmitter属性和方法
1、addListener(event,listener)
为指定事件添加一个监听器到监听器数组的尾部。
2、on(event,listener)
为指定事件注册一个监听器,接收一个字符串event和一个回调函数。
server.on('connection', function (stream) { console.log('someone connected!');});
3、once(event,listener)
为指定事件注册一个单次监听器,即监听器最多只会触发一次,触发后立即解除该监听器。
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、removeAllListener(event)
移除所有事件的所有监听器,如果指定事件,则移除指定事件的所有监听器。
6、setMaxListeners(n)
默认情况下,EventEmitters如果你添加的监听器超过10个就会触发警告信息,setMaxListeners函数用于提高监听器的默认限制的数量。
7、listeners(event)
返回指定事件的监听器数组。
8、emit(event,[arg1],[arg2],[...])
按参数的顺序执行每个监听器,如果事件由注册监听返回true,否则返回false。
类方法
1、listener(emitter,event)
返回指定事件的监听器数量。
事件
1、newListener(evnet,listener)
event:字符串,事件名称。listener:事件处理函数。
2、removeListener(event,listener)
event:字符串,事件名称。listener:事件处理函数。
一个例子
//引入events模块var events=require("events");//创建eventEmitter对象var eventEmitter=new events.EventEmitter();//监听器 1var listener1=function(){ console.log("监听器 listenr1 执行了");};//监听器 2var listener2=function(){ console.log("监听器 listenr2 执行了");};//绑定connection事件,处理函数为listener1eventEmitter.addListener("connection",listener1);//绑定connection事件 处理函数为listener2eventEmitter.on("connection",listener2);var eventListeners=require("events").EventEmitter.listenerCount(eventEmitter,"connection");console.log(eventListeners+" 个监听器监听连接事件。");//触发connection事件eventEmitter.emit("connection");//移除绑定的listener1函数eventEmitter.removeListener("connection",listener1);console.log("listener1 不再监听。。。");//触发connection事件eventEmitter.emit("connection");eventListeners=require("events").EventEmitter.listenerCount(eventEmitter,"connection");console.log(eventListeners+" 个监听器监听连接事件。");console.log("程序执行完毕......");
执行
error事件
EventEmitter定义了一个特殊的事件error,它包含了错误的语义,我们在遇到异常的时候通常会触发error事件。当error事件被触发时,EventEmitter规定如果没有响应的监听器,Node.js会把它当做异常,退出程序并输出错误信息。我们一般要为你会触发error事件的对象设置监听器,避免遇到错误后整个程序崩溃。
var events=require("events");var emitter=new events.EventEmitter();emitter.emit("error");
执行会出现下面的错误
throw err; ^Error: Uncaught, unspecified "error" event. (undefined) at EventEmitter.emit (events.js:163:17) at Object.(D:\node\error.js:3:9) at Module._compile (module.js:556:32) at Object.Module._extensions..js (module.js:565:10) at Module.load (module.js:473:32) at tryModuleLoad (module.js:432:12) at Function.Module._load (module.js:424:3) at Module.runMain (module.js:590:10) at run (bootstrap_node.js:394:7) at startup (bootstrap_node.js:149:9)
继承EventEmitter
时候我们不会直接使用 EventEmitter,而是在对象中继承它。包括 fs、net、 http 在内的,只要是支持事件响应的核心模块都是 EventEmitter 的子类。
为什么要这样做呢?原因有两点:
首先,具有某个实体功能的对象实现事件符合语义, 事件的监听和发射应该是一个对象的方法。
其次 JavaScript 的对象机制是基于原型的,支持 部分多重继承,继承 EventEmitter 不会打乱对象原有的继承关系。
学习来源