nodejs-EventEmitter

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

例子----------------------------------------------------
// 引入 events 模块
var EventEmitter = require('events').EventEmitter; 
// 创建 eventEmitter 对象
var event = new EventEmitter(); 

event.on('some_event', function() { 
    console.log('some_event 事件触发'); 
}); 
setTimeout(function() { 
    event.emit('some_event'); 
}, 1000); 
结果.............................
some_event 事件触发

例子----------------------------------------------------
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');
结果.............................
listener1 arg1 arg2
listener2 arg1 arg2

例子----------------------------------------------------
const events = require('events');
const eventEmitter = new events.EventEmitter();

const listener1 = function listener1() {
    console.log('listener1...');
}

const listener2 = function listener2() {
    console.log('listener2...');
}

// 绑定 connection 事件,处理函数为 listener1 
eventEmitter.addListener('connection', listener1);

// 绑定 connection 事件,处理函数为 listener2
eventEmitter.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("程序执行完毕。");
结果.............................
2 个监听器监听连接事件。
listener1...
listener2...
listener1 不再受监听。
listener2...
1 个监听器监听连接事件。
程序执行完毕。

API----------------------------------------------------

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)返回指定事件的监听器数量。
	events.EventEmitter.listenerCount(emitter, eventName) //已废弃,不推荐
	events.emitter.listenerCount(eventName) //推荐
事件
1.newListener 
	event - 字符串,事件名称
	listener - 处理事件函数
	该事件在添加新监听器时被触发。

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

补充----------------------------------------------------
大多数时候我们不会直接使用 EventEmitter,而是在对象中继承它。包括 fs、net、 http 在内的,只要是支持事件响应的核心模块都是 EventEmitter 的子类


原文地址:https://www.cnblogs.com/csnd/p/12061867.html