nodejs-08-EventEmitter

Posted gnuzsx

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了nodejs-08-EventEmitter相关的知识,希望对你有一定的参考价值。


nodejs EventEmitter

nodejs 所有的异步I/O操作,在完成的时候,都会发送一个事件,到事件队列当中。

nodejs 里面的很多对象,都会分发事件:

一个 net.Server对象,会在每次有新连接的时候,就触发一个事件,
一个 fs.readStream对象,会在文件被打开的时候,触发一个事件。

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


EventEmitter类

events模块,只提供了一个对象: events.EventEmitter()。

EventEmitter的核心就是事件触发与事件监听器功能的封装。

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

// 引入events模块
var events = require(‘events‘);

// 创建eventEmitter对象
var eventEmitter = new events.EventEmitter();

EventEmitter对象,如果在实例化时发生错误,会触发error事件。

当添加新的监听器时,newListener事件会触发,

当监听器被移除时,removeListener 事件被触发。

下面我们用一个简单的例子说明 EventEmitter的用法:

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 在 1000ms以后 向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提供了多个属性,如on和emit。

on函数,是用于绑定事件函数的。

emit属性是用于触发一个事件的。

接下来,我们来具体看下EventEmitter的属性介绍。


方法
  • addListener(event,listener):为指定事件,添加一个监听器,到监听器数组的底部。
  • on(evnet,listener):为指定事件注册一个监听器,接受一个字符串event和一个回调函数。
server.on(‘connection‘,function(stream){
  console.log(‘someone connected!‘);
});
  • once(event,listener):为指定事件注册一个单次监听器,也就是说这个监听器最多只会触发一次,触发后立刻解除这个监听器。
server.once(‘connection‘,function(stream){
  console.log(‘An,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.

1. addListener(event,listener) - 绑定
2. on(event,listener) - 绑定
3. once(event,listener) - 一次性绑定
4. removeListener(event,listener) - 移除
5. removeAllListeners([event]) - 移除
6. setMaxListeners(n) - 设置最大监听器数量
7. listeners(event) - 监听器数组
8. emit(event,[arg1],[arg2],[...]) - 触发

类方法
  • listenerCount(emitter,event):返回指定事件的监听器数量。
events.EventEmitter.listenerCount(emitter,eventName) // 已废弃,不推荐
events.emitter.listenerCount(eventName) //推荐

事件
  • newListener:该事件在添加新监听器时被触发 - event - 字符串,事件名称 - listener - 处理事件函数
  • removeListener:- event - 字符串,事件名称 - listener - 处理事件函数
    从指定监听器数组中删除一个监听器。需要注意的是,此操作会改变处于,被删监听器之后的那些监听器的索引。

实例

以下实例通过 connection(连接) 事件演示了 EventEmitter类的应用。

创建main.js文件,代码如下:

var events = require(‘events‘);
var eventEmitter = new events.EventEmitter();

//监听器 #1
var listener1 = function listener1(){
  console.log(‘监听器 listener1 执行‘);
}

//监听器 #2
var listener2 = function listener2(){
  console.log(‘监听器 listener2 执行‘);
}

// 绑定connection事件,处理函数为listener1
eventEmitter.addListener(‘connection‘,listener1);

// 绑定connection事件,处理函数为listener2
eventEmitter.on(‘connection‘,listener2);

var eventListeners = eventEmitter.listenerCount(‘connection‘);
console.log(eventListeners + ‘个监听器监听连接事件。‘);

//处理 connection 事件
eventEmitter.emit(‘connection‘);

//移除绑定的listener1函数
eventEmitter.removeListener(‘connection‘,listener1);

//触发连接事件
eventEmitter.emit(‘connection‘);

eventListeners = eventEmitter.listenerCount(‘connection‘);
console.log(eventListners + "个监听器监听连接事件。");

console.log("程序执行完毕。");

以上代码,执行结果如下所示:

$ node main.js
2 个监听器监听连接事件。
监听器 listener1 执行。
监听器 listener2 执行。
listener1 不再受监听。
监听器 listener2 执行。
1 个监听器监听连接事件。
程序执行完毕。

error事件

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

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

我们一般要为会触发 error 事件的对象设置监听器,
避免遇到错误后整个程序崩溃。

例如:

var events = require(‘events‘); 
var emitter = new events.EventEmitter(); 
emitter.emit(‘error‘); 

运行时会显示以下错误:

node.js:201 
throw e; // process.nextTick error, or ‘error‘ event on first tick 
^ 
Error: Uncaught, unspecified ‘error‘ event. 
at EventEmitter.emit (events.js:50:15) 
at Object.<anonymous> (/home/byvoid/error.js:5:9) 
at Module._compile (module.js:441:26) 
at Object..js (module.js:459:10) 
at Module.load (module.js:348:31) 
at Function._load (module.js:308:12) 
at Array.0 (module.js:479:10) 
at EventEmitter._tickCallback (node.js:192:40)

继承 EventEmitter

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

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

为什么要这样做呢?

原因有两点:

首先,具有某个实体功能的对象,实现事件,符合语义, 事件的监听和发生应该是一个对象的方法。

其次 javascript 的对象机制是基于原型的,支持 部分多重继承,继承 EventEmitter 不会打乱对象原有的继承关系。


总结
  1. 不会直接使用EventEitter,而是对象中继承。
  2. 对error事件要设置监听器







以上是关于nodejs-08-EventEmitter的主要内容,如果未能解决你的问题,请参考以下文章

Android Adapter代码片

代码片|水波纹

代码片--练习匿名内部类

一个简单的时间片轮转内核代码的分析(课程作业)

markdown 放代码片

代码片-下拉树实现