Node.js之EventEmitter开发

什么是EventEmitter

Node.js 所有的异步 I/O 操作在完成时都会发送一个事件到事件队列。
Node.js里面的许多对象都会分发事件：一个net.Server对象会在每次有新连接时分发一个事件， 一个fs.readStream对象会在文件被打开的时候发出一个事件。 所有这些产生事件的对象都是 events.EventEmitter 的实例。

EventEmitter类

在事件循环中我们介绍了EventEmitter的on（监听）和emit（触发）函数。下面会更详细的介绍EventEmitter更多有用的函数

events 模块只提供了一个对象： events.EventEmitter。EventEmitter 的核心就是事件触发与事件监听器功能的封装。
你可以通过require(“events”);来访问该模块。

//event.js 文件var EventEmitter = require('events').EventEmitter; 或者// 引入 events 模块var events = require('events');// 创建 eventEmitter 对象var eventEmitter = new events.EventEmitter();

事件和函数的关系

EventEmitter 的每个事件由一个事件名和若干个参数组成，事件名是一个字符串，通常表达一定的语义。对于每个事件，EventEmitter 支持 若干个事件监听器。事件和函数的关系如下

1. 一个事件可以监听多个函数，相反一个函数可以绑定到多个事件上
2. 一个函数我们通常认为是一个事件监听器也就是所谓的观察者
3. 当一个观察者进入一个事件时候，会触发newListenner事件，当一个观察者被移除时候，会掉用removeListenner事件

main.js文件如下

var eventEmitter = require('events').EventEmitter;var event = new eventEmitter();event.on("some_evet",function(){    console.log('some_evet 事件触发');    event.removeAllListeners('some_evet');});setTimeout(function () {   event.emit('some_evet');},3000);event.on('newListener',function(arg1,arg2,arg3){   console.log("new:");   console.log(arg1);   console.log(arg2);   console.log('arg2:'+arg2);   var func1 = arg2;});event.on('removeListener',function(arg1,arg2) {  console.log("remove:");  console.log(arg1);  console.log("arg2:"+arg2);})

在终端输入

node main.js

输出结果如下

new:removeListener[Function]arg2:function (arg1,arg2) {  console.log("remove:");  console.log(arg1);  console.log("arg2:"+arg2);}some_evet 事件触发remove:some_evetarg2:function (){    console.log('some_evet 事件触发');    event.removeAllListeners('some_evet');}

通过上面的输出结果我们很容易发现，当添加监听器时候我们传入的第一个参数arg1是事件名removeListener，arg2是我们注册函数对象，输出成字符串就是函数代码内容。
当我们移除监听器时候我们传入第一个参数arg1是要被移除事件的名some_event，参数arg2是被移除的监听者（即函数）

事件多监听器多参数传递

//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 参数

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)
  移除指定事件的某个监听器，监听器 必须是该事件已经注册过的监听器。
• removeAllListeners([event])
  移除所有事件的所有监听器， 如果指定事件，则移除指定事件的所有监听器。
• setMaxListeners(n)
  默认情况下， EventEmitters 如果你添加的监听器超过 10 个就会输出警告信息。 setMaxListeners 函数用于提高监听器的默认限制的数量。
• listeners(event)
  返回指定事件的监听器数组。
• emit(event, [arg1], [arg2], […])
  按参数的顺序执行每个监听器，如果事件有注册监听返回 true，否则返回 false。

类方法

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

内置事件

1. newListener
   event - 字符串，事件名称
   listener - 处理事件函数
   该事件在添加新监听器时被触发。

2. removeListener
   event - 字符串，事件名称
   listener - 处理事件函数
   从指定监听器数组中删除一个监听器。需要注意的是，此操作将会改变处于被删监听器之后的那些监听器的索引。

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 不会打乱对象原有的继承关系。