搜云库技术团队
文章永久连接：https://tech.souyunku.com/?p=5434
Node.js 所有的异步 I/O 操作在完成时都会发送一个事件到事件队列
Node.js 里面的许多对象都会分发事件：
- 一个 net.Server 对象会在每次有新连接时分发一个事件
- 一个 fs.readStream 对象会在文件被打开的时候发出一个事件
所有这些产生事件的对象都是 events.EventEmitter 的实例
EventEmitter 类
Node.js events 模块只提供了一个对象： events.EventEmitter
EventEmitter 的核心就是事件触发与事件监听器功能的封装
引入模块
var events = require('events');
实例化 EventEmitter
var events = require('events');
var eventEmitter = new events.EventEmitter();
EventEmitter 对象如果在实例化时发生错误，会触发 error 事件
当添加新的监听器时，newListener 事件会触发 当监听器被移除时，removeListener 事件被触发
范例
/*
* filename: main.js
* author: 搜云库技术团队(tech.souyunku.com)
* Copyright © 2015-2065 tech.souyunku.com. All rights reserved.
*/
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 在 1000 毫秒以后向 event 对象发送事件 some_event，此时会调用some_event 的监听器
运行以上 Node.js 范例，输出结果如下
$ node main.js
some_event 事件触发
EventEmitter 的每个事件由一个事件名和若干个参数组成，事件名是一个字符串，通常表达一定的语义。
对于每个事件，EventEmitter 支持 若干个事件监听器。
当事件触发时，注册到这个事件的事件监听器被依次调用，事件参数作为回调函数参数传递。
我们来看一下下面这个范例
main.js
/*
* filename: main.js
* author: 搜云库技术团队(tech.souyunku.com)
* Copyright © 2015-2065 tech.souyunku.com. All rights reserved.
*/
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.js 范例，输出结果如下
$ node main.js
listener1 arg1 参数 arg2 参数
listener2 arg1 参数 arg2 参数
在这个范例中，emitter 为事件 someEvent 注册了两个事件监听器，然后触发了 someEvent 事件
从运行结果中可以看到两个事件监听器回调函数被先后调用，这就是使用 EventEmitter 最简单的用法
EventEmitter 提供了多个属性，如 on 和 emit ：
1、 on 函数用于绑定事件函数
2、 emit 属性用于触发一个事件
EventEmitter 类提供的方法
| 序号 | 方法 & 描述 |
|---|---|
| 1 | addListener(event, listener) 为指定事件添加一个监听器到监听器数组的尾部 |
| 2 | on(event, listener) 为指定事件注册一个监听器，接受一个字符串 event 和一个回调函数 |
| 3 | once(event, listener) 为指定事件注册一个单次监听器，即 监听器最多只会触发一次，触发后立刻解除该监听器 |
| 4 | removeListener(event, listener) 移除指定事件的某个监听器，监听器必须是该事件已经注册过的监听器。它接受两个参数，第一个是事件名称，第二个是回调函数名称 |
| 5 | removeAllListeners([event]) 移除所有事件的所有监听器， 如果指定事件，则移除指定事件的所有监听器 |
| 6 | setMaxListeners(n) 默认情况下， EventEmitters 如果你添加的监听器超过 10 个就会输出警告信息。 setMaxListeners 函数用于提高监听器的默认限制的数量 |
| 7 | listeners(event) 返回指定事件的监听器数组 |
| 8 | emit(event, [arg1], [arg2], […]) 按参数的顺序执行每个监听器，如果事件有注册监听返回 true，否则返回 false |
| 9 | listenerCount(emitter, event) 返回指定事件的监听器数量 |
事件
| 事件 | 描述 |
|---|---|
| newListenerevent | 字符串，事件名称 listener- 处理事件函数该事件在添加新监听器时被触发 |
| removeListenerevent | 字符串，事件名称 listener – 处理事件函数从指定监听器数组中删除一个监听器 需要注意的是，此操作将会改变处于被删监听器之后的那些监听器的索引 |
范例
下面的范例通过 connection（连接）事件演示了 EventEmitter 类的应用
main.js
/*
* filename: main.js
* author: 搜云库技术团队(tech.souyunku.com)
* Copyright © 2015-2065 tech.souyunku.com. All rights reserved.
*/
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 = require('events').EventEmitter.listenerCount(eventEmitter,'connection');
console.log(eventListeners + " 个监听器监听连接事件。");
// 处理 connection 事件
eventEmitter.emit('connection');
// 移除监绑定的 listener1 函数
eventEmitter.removeListener('connection', listener1);
console.log("listener1 不再受监听。");
// 触发连接事件
eventEmitter.emit('connection');
eventListeners = require('events').EventEmitter.listenerCount(eventEmitter,'connection');
console.log(eventListeners + " 个监听器监听连接事件。");
console.log("程序执行完毕。");
运行以上 Node.js 范例，输出结果如下
$ node main.js
2 个监听器监听连接事件。
监听器 listener1 执行。
监听器 listener2 执行。
listener1 不再受监听。
监听器 listener2 执行。
1 个监听器监听连接事件。
程序执行完毕。
error 事件
EventEmitter 定义了一个特殊的事件 error，它包含了错误的语义
当 error 被触发时，EventEmitter 规定如果没有响 应的监听器，Node.js 会把它当作异常，退出程序并输出错误信息
一般情况下，要为会触发 error 事件的对象设置监听器，避免遇到错误后整个程序崩溃
/*
* filename: main.js
* author: 搜云库技术团队(tech.souyunku.com)
* Copyright © 2015-2065 tech.souyunku.com. All rights reserved.
*/
var events = require('events');
var emitter = new events.EventEmitter();
emitter.emit('error');
运行以上 Node.js 范例，输出结果如下
node main.js
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 的子类
为什么要这样做呢？
原因有两点：
1、 首先，具有某个实体功能的对象实现事件符合语义，事件的监听和发射应该是一个对象的方法。
2、 其次 JavaScript 的对象机制是基于原型的，支持部分多重继承，继承 EventEmitter 不会打乱对象原有的继承关系。
干货推荐
附录：Node.js 教程：系列文章
- 一、Node.js 基础教程
- 二、Node.js 环境配置
- 三、Node.js 创建第一个应用
- 四、Node.js NPM 使用介绍
- 五、Node.js 使用淘宝 NPM 镜像
- 六、Node.js REPL ( 交互式解释器 )
- 七、Node.js 回调函数
- 八、Node.js 事件循环
- 【当前读到】九、Node.js EventEmitter
- 十、Node.js Buffer(缓冲区)
- 十一、Node.js Stream (流)
- 十二、Node.js 模块系统
- 十三、Node.js 函数
- 十四、Node.js 开发 URL 路由
- 十五、Node.js 全局对象
- 十六、Node.js 常用工具
- 十七、Node.js 文件系统( fs 模块 )
- 十八、Node.js GET-POST 请求
- 十九、Node.js 内置模块
- 二十、Node.js WEB 模块
- 二十一、Node.js Express 框架
- 二十二、Node.js RESTful API
- 二十三、Node.js 多进程
- 二十四、Node.js JXcore 打包
- 二十五、Node.js 访问 MySQL 数据库
- 二十六、Node.js 访问 MongoDB
- 二十七、Node.js OS 模块
- 二十八、Node.js DNS 模块
- 二十九、Node.js Domain 模块
- 三十、Node.js Path 模块
- 三十一、Node.js Net 模块
