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 的子类。