HoRain云--Node.js EventEmitter

Node.js 所有的异步 I/O 操作在完成时都会发送一个事件到事件队列。Node.js 里面的许多对象都会分发事件一个 net.Server 对象会在每次有新连接时触发一个事件 一个 fs.readStream 对象会在文件被打开的时候触发一个事件。 所有这些产生事件的对象都是 events.EventEmitter 的实例。EventEmitter 是 Node.js 中用于创建、注册和触发事件的核心模块。EventEmitter 是事件驱动编程的基础可以帮助开发者轻松实现事件的发布与订阅机制。EventEmitter 类events 模块只提供了一个对象 events.EventEmitter。EventEmitter 的核心就是事件触发与事件监听器功能的封装。你可以通过 require(events); 来访问该模块。实例// 引入 events 模块var events require(events);// 创建 eventEmitter 对象var eventEmitter new events.EventEmitter();EventEmitter 对象如果在实例化时发生错误会触发 error 事件。当添加新的监听器时newListener 事件会触发当监听器被移除时removeListener 事件被触发。下面我们用一个简单的例子说明 EventEmitter 的用法实例//event.js 文件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 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 的属性介绍。方法序号方法 描述1addListener(event, listener)为指定事件添加一个监听器到监听器数组的尾部。2on(event, listener)为指定事件注册一个监听器接受一个字符串 event 和一个回调函数。server.on(connection, function (stream) { console.log(someone connected!); });3once(event, listener)为指定事件注册一个单次监听器即 监听器最多只会触发一次触发后立刻解除该监听器。server.once(connection, function (stream) { console.log(Ah, we have our first user!); });4removeListener(event, listener)移除指定事件的某个监听器监听器必须是该事件已经注册过的监听器。它接受两个参数第一个是事件名称第二个是回调函数名称。var callback function(stream) { console.log(someone connected!); }; server.on(connection, callback); // ... server.removeListener(connection, callback);5removeAllListeners([event])移除所有事件的所有监听器 如果指定事件则移除指定事件的所有监听器。6setMaxListeners(n)默认情况下 EventEmitters 如果你添加的监听器超过 10 个就会输出警告信息。 setMaxListeners 函数用于改变监听器的默认限制的数量。7listeners(event)返回指定事件的监听器数组。8emit(event, [arg1], [arg2], [...])按监听器的顺序执行执行每个监听器如果事件有注册监听返回 true否则返回 false。类方法序号方法 描述1listenerCount(emitter, event)返回指定事件的监听器数量。events.EventEmitter.listenerCount(emitter, eventName) //已废弃不推荐 events.emitter.listenerCount(eventName) //推荐注册一个事件监听器:实例const EventEmitter require(events);const myEmitter new EventEmitter();// 注册一个事件监听器myEmitter.on(sayHello, (name) {console.log(Hello, ${name}!);});// 触发事件myEmitter.emit(sayHello, Alice);输出Hello, Alice!使用 once() 注册一次性事件:myEmitter.once(init, () { console.log(Initialization event occurred); }); myEmitter.emit(init); // 打印: Initialization event occurred myEmitter.emit(init); // 不会再触发事件触发时可以传递参数供监听器使用实例myEmitter.on(data, (value1, value2) {console.log(Received values: ${value1}, ${value2});});myEmitter.emit(data, Node.js, EventEmitter);// 输出: Received values: Node.js, EventEmitter如果触发的事件没有对应的监听器EventEmitter 会抛出错误:实例myEmitter.on(error, (err) {console.error(Error event triggered:, err);});myEmitter.emit(error, new Error(Something went wrong));// 打印: Error event triggered: Error: Something went wrong事件序号事件 描述1newListenerevent- 字符串事件名称listener- 处理事件函数该事件在添加新监听器时被触发。2removeListenerevent- 字符串事件名称listener- 处理事件函数从指定监听器数组中删除一个监听器。需要注意的是此操作将会改变处于被删监听器之后的那些监听器的索引。实例以下实例通过 connection连接事件演示了 EventEmitter 类的应用。创建 main.js 文件代码如下实例var events require(events);var eventEmitter new events.EventEmitter();// 监听器 #1var listener1 function listener1() {console.log(监听器 listener1 执行。);}// 监听器 #2var listener2 function listener2() {console.log(监听器 listener2 执行。);}// 绑定 connection 事件处理函数为 listener1eventEmitter.addListener(connection, listener1);// 绑定 connection 事件处理函数为 listener2eventEmitter.on(connection, listener2);var eventListeners eventEmitter.listenerCount(connection);console.log(eventListeners 个监听器监听连接事件。);// 处理 connection 事件eventEmitter.emit(connection);// 移除监绑定的 listener1 函数eventEmitter.removeListener(connection, listener1);console.log(listener1 不再受监听。);// 触发连接事件eventEmitter.emit(connection);eventListeners eventEmitter.listenerCount(connection);console.log(eventListeners 个监听器监听连接事件。);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 不会打乱对象原有的继承关系。大多数 Node.js 核心模块如 HTTP、文件系统都继承了 EventEmitter你可以创建自己的类来继承 EventEmitter。实例class MyEmitter extends EventEmitter {}const customEmitter new MyEmitter();customEmitter.on(customEvent, () {console.log(Custom event fired);});customEmitter.emit(customEvent);