Node.js - 事件 - events.EventEmitter

Node.js 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();

EventEmitter 对象如果在实例化时发生错误,会触发 error 事件。当添加新的监听器时,newListener 事件会触发,当监听器被移除时,removeListener 事件被触发。

EventEmitter 的用法举例:

//event.js 文件
var EventEmitter = require('events').EventEmitter; 
var event_emitter = new EventEmitter(); 
// 注册,监听 `some_event` 事件
event_emitter.on('some_event', function() { 
    console.log('some_event 事件触发'); 
}); 
setTimeout(function() { 
    // 触发 `some_event` 事件
    event_emitter.emit('some_event'); 
}, 1000); 

EventEmitter 的每个事件由:
一个事件名和若干个参数组成。
事件名是一个字符串,通常表达一定的语义。对于每个事件,EventEmitter 支持 若干个事件监听器。
当事件触发时,注册到这个事件的事件监听器被依次调用,事件参数作为回调函数参数传递。
eg:

//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 的方法介绍:

  1. 方法:
    1)addListener(event, listener)
    为指定事件添加一个监听器到监听器数组的尾部。
    2)on(event, listener)
    为指定事件注册一个监听器,接受一个字符串 event 和一个回调函数。
server.on('connection', function (stream) {
  console.log('someone connected!');
});

on 和 addListener 是完全相同的,

"Experimental: 'on' as alias to 'addListener'".

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。

2.类方法
1)listenerCount(emitter, event)
返回指定事件的监听器数量。
eg:

events.EventEmitter.listenerCount(emitter, 'my_event')

3.事件
1)newListener

event - 字符串,事件名称
listener - 处理事件函数

该事件在添加新监听器时被触发。

2)removeListener

event - 字符串,事件名称
listener - 处理事件函数

从指定监听器数组中删除一个监听器。需要注意的是,此操作将会改变处于被删监听器之后的那些监听器的索引。

你可能感兴趣的:(Node.js - 事件 - events.EventEmitter)