Node.js EventEmitter
2016-02-29 10:46
483 查看
Node.js EventEmitter
Node.js 所有的异步 I/O 操作在完成时都会发送一个事件到事件队列。
Node.js里面的许多对象都会分发事件:一个net.Server对象会在每次有新连接时分发一个事件, 一个fs.readStream对象会在文件被打开的时候发出一个事件。 所有这些产生事件的对象都是 events.EventEmitter 的实例。
你可以通过require(“events”);来访问该模块。
[/code]
EventEmitter 对象如果在实例化时发生错误,会触发 ‘error’ 事件。当添加新的监听器时,’newListener’ 事件会触发,当监听器被移除时,’removeListener’ 事件被触发。
下面我们用一个简单的例子说明 EventEmitter 的用法:
[/code]
执行结果如下:
运行这段代码,1 秒后控制台输出了 ‘some_event 事件触发’。其原理是 event 对象注册了事件 some_event 的一个监听器,然后我们通过 setTimeout 在 1000 毫秒以后向 event 对象发送事件 some_event,此时会调用some_event 的监听器。
[/code]
以上例子中,emitter 为事件 someEvent 注册了两个事件监听器,然后触发了 someEvent 事件。
运行结果中可以看到两个事件监听器回调函数被先后调用。 这就是EventEmitter最简单的用法。
EventEmitter 提供了多个属性,如 on 和 emit。on 函数用于绑定事件函数,emit 属性用于触发一个事件。接下来我们来具体看下 EventEmitter 的属性介绍。
当 error 被触发时,EventEmitter 规定如果没有响 应的监听器,Node.js 会把它当作异常,退出程序并输出错误信息。
我们一般要为会触发 error 事件的对象设置监听器,避免遇到错误后整个程序崩溃。例如:var events = require('events');var emitter = new events.EventEmitter();
emitter.emit('error'); 运行时会显示以下错误:node.js:201throw 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)
为什么要这样做呢?原因有两点:
首先,具有某个实体功能的对象实现事件符合语义, 事件的监听和发射应该是一个对象的方法。
其次 JavaScript 的对象机制是基于原型的,支持 部分多重继承,继承 EventEmitter 不会打乱对象原有的继承关系。
Node.js 所有的异步 I/O 操作在完成时都会发送一个事件到事件队列。
Node.js里面的许多对象都会分发事件:一个net.Server对象会在每次有新连接时分发一个事件, 一个fs.readStream对象会在文件被打开的时候发出一个事件。 所有这些产生事件的对象都是 events.EventEmitter 的实例。
EventEmitter 类
events 模块只提供了一个对象: events.EventEmitter。EventEmitter 的核心就是事件触发与事件监听器功能的封装。你可以通过require(“events”);来访问该模块。
// 引入 events 模块var events = require('events');// 创建 eventEmitter 对象var eventEmitter = new events.EventEmitter();
[/code]
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);
[/code]
执行结果如下:
运行这段代码,1 秒后控制台输出了 ‘some_event 事件触发’。其原理是 event 对象注册了事件 some_event 的一个监听器,然后我们通过 setTimeout 在 1000 毫秒以后向 event 对象发送事件 some_event,此时会调用some_event 的监听器。
$ node event</span><span class="pun">.</span><span class="pln">js </span></code></li><li class="L1"><code class="language-js"><span class="pln">some_event </span><span class="pun">事件触发</span></code></li></ol></pre></div><p style="border: 0px; padding: 0px; line-height: 2em; font-size: 12px; font-family: 'Microsoft Yahei', 'Helvetica Neue', Helvetica, Arial, sans-serif; color: rgb(51, 51, 51); widows: 1; background-color: rgb(255, 255, 255);">EventEmitter 的每个事件由一个事件名和若干个参数组成,事件名是一个字符串,通常表达一定的语义。对于每个事件,EventEmitter 支持 若干个事件监听器。</p><p style="border: 0px; padding: 0px; line-height: 2em; font-size: 12px; font-family: 'Microsoft Yahei', 'Helvetica Neue', Helvetica, Arial, sans-serif; color: rgb(51, 51, 51); widows: 1; background-color: rgb(255, 255, 255);">当事件触发时,注册到这个事件的事件监听器被依次调用,事件参数作为回调函数参数传递。</p><p style="border: 0px; padding: 0px; line-height: 2em; font-size: 12px; font-family: 'Microsoft Yahei', 'Helvetica Neue', Helvetica, Arial, sans-serif; color: rgb(51, 51, 51); widows: 1; background-color: rgb(255, 255, 255);">让我们以下面的例子解释这个过程:</p><div><pre class="prettyprint linenums prettyprinted"><ol class="linenums"><li class="L0"><code class="language-js"><span class="com">//event.js 文件var events = require('events');var emitter = new events.EventEmitter(); </span></code></li><li class="L1"><code class="language-js"><span class="pln">emitter</span><span class="pun">.</span><span class="pln">on</span><span class="pun">(</span><span class="str">'someEvent'</span><span class="pun">,</span><span class="pln"> </span><span class="kwd">function</span><span class="pun">(</span><span class="pln">arg1</span><span class="pun">,</span><span class="pln"> arg2</span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln"> </span></code></li><li class="L2"><code class="language-js"><span class="pln"> console</span><span class="pun">.</span><span class="pln">log</span><span class="pun">(</span><span class="str">'listener1'</span><span class="pun">,</span><span class="pln"> arg1</span><span class="pun">,</span><span class="pln"> arg2</span><span class="pun">);});</span><span class="pln"> </span></code></li><li class="L3"><code class="language-js"><span class="pln">emitter</span><span class="pun">.</span><span class="pln">on</span><span class="pun">(</span><span class="str">'someEvent'</span><span class="pun">,</span><span class="pln"> </span><span class="kwd">function</span><span class="pun">(</span><span class="pln">arg1</span><span class="pun">,</span><span class="pln"> arg2</span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln"> </span></code></li><li class="L4"><code class="language-js"><span class="pln"> console</span><span class="pun">.</span><span class="pln">log</span><span class="pun">(</span><span class="str">'listener2'</span><span class="pun">,</span><span class="pln"> arg1</span><span class="pun">,</span><span class="pln"> arg2</span><span class="pun">);});</span><span class="pln"> </span></code></li><li class="L5"><code class="language-js"><span class="pln">emitter</span><span class="pun">.</span><span class="pln">emit</span><span class="pun">(</span><span class="str">'someEvent'</span><span class="pun">,</span><span class="pln"> </span><span class="str">'arg1 参数'</span><span class="pun">,</span><span class="pln"> </span><span class="str">'arg2 参数'</span><span class="pun">);</span><span class="pln"> </span></code></li></ol></pre></div><p style="border: 0px; padding: 0px; line-height: 2em; font-size: 12px; font-family: 'Microsoft Yahei', 'Helvetica Neue', Helvetica, Arial, sans-serif; color: rgb(51, 51, 51); widows: 1; background-color: rgb(255, 255, 255);">执行以上代码,运行的结果如下:</p><div><pre class="prettyprint linenums prettyprinted"><ol class="linenums"><li class="L0"><code class="language-js"><span class="pln">$ node event.js
listener1 arg1 参数 arg2 参数
listener2 arg1 参数 arg2 参数
[/code]
以上例子中,emitter 为事件 someEvent 注册了两个事件监听器,然后触发了 someEvent 事件。
运行结果中可以看到两个事件监听器回调函数被先后调用。 这就是EventEmitter最简单的用法。
EventEmitter 提供了多个属性,如 on 和 emit。on 函数用于绑定事件函数,emit 属性用于触发一个事件。接下来我们来具体看下 EventEmitter 的属性介绍。
方法
序号 | 方法 & 描述 |
---|---|
1 | addListener(event, listener) 为指定事件添加一个监听器到监听器数组的尾部。 |
2 | on(event, listener) 为指定事件注册一个监听器,接受一个字符串 event 和一个回调函数。 server.on('connection', function (stream) { console.log('someone connected!');}); |
3 | once(event, listener) 为指定事件注册一个单次监听器,即 监听器最多只会触发一次,触发后立刻解除该监听器。 server.once('connection', function (stream) { console.log('Ah, we have our first user!');}); |
4 | removeListener(event, listener) 移除指定事件的某个监听器,监听器 必须是该事件已经注册过的监听器。 var callback = function(stream) { console.log('someone connected!');}; server.on('connection', callback);// ... server.removeListener('connection', callback); |
5 | removeAllListeners([event]) 移除所有事件的所有监听器, 如果指定事件,则移除指定事件的所有监听器。 |
6 | setMaxListeners(n) 默认情况下, EventEmitters 如果你添加的监听器超过 10 个就会输出警告信息。 setMaxListeners 函数用于提高监听器的默认限制的数量。 |
7 | listeners(event) 返回指定事件的监听器数组。 |
8 | emit(event, [arg1], [arg2], […]) 按参数的顺序执行每个监听器,如果事件有注册监听返回 true,否则返回 false。 |
类方法
序号 | 方法 & 描述 |
---|---|
1 | 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:201throw 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 不会打乱对象原有的继承关系。
相关文章推荐
- Python动态类型的学习---引用的理解
- 使用 HTTP 上传 G 级的文件之 Node.js 版本
- mongo实现消息队列
- Node.js压缩web项目中的js,css和图片
- async.js 学习记录
- 异步流程控制:7 行代码学会 co 模块
- 土人系列AS入门教程 -- 对象篇
- 交换机升级排障实例
- ruby实现的一个异步文件下载HttpServer实例
- C#异步绑定数据实现方法
- C#托管堆对象实例包含内容分析
- C#实现获取不同对象中名称相同属性的方法
- 科学知识:同步、异步、阻塞和非阻塞区别
- javascript asp教程第十一课--Application 对象
- 探讨Ajax中同步与异步之间的区别
- PowerShell中使用Out-String命令把对象转换成字符串输出的例子
- VBS教程:对象-正则表达式(RegExp)对象
- C#中异步回调函数用法实例
- C#检查指定对象是否存在于ArrayList集合中的方法
- node.js中的fs.mkdir方法使用说明