Node.js 事件
Node.js 所有的异步 I/O 操作在完成时都会发送一个事件到事件队列。
Node.js 里面的许多对象都会分发事件:一个net.Server对象会在每次有新连接时分发一个事件, 一个fs.readStream对象会在文件被打开的时候发出一个事件。 所有这些产生事件的对象都是 events.EventEmitter 的实例。 你可以通过require(“events”);来访问该模块。
EventEmitter 类
events 模块只提供了一个对象: events.EventEmitter。EventEmitter 的核心就是事件触发与事件监听器功能的封装。可以通过require(“events”);来访问该模块。
例子
event.js:
//引入events并创建EventMitter对象 var EventEmitter = require('events').EventEmitter; //创建事件 var event = new EventEmitter(); //注册一个监听器,参数包括事件名和回调函数 event.on('some_event', function() { console.log('some_event 事件触发'); }); //在10秒后事件触发 setTimeout(function() { event.emit('some_event'); }, 10*1000);
运行:
运行原理:
event 对象注册了事件 some_event 的一个监听器,然后通过 setTimeout 在 1o秒以后向 event 对象发送事件 some_event,此时会调用some_event 的监听器。
当事件触发时,注册到这个事件的事件监听器被依次调用,事件参数作为回调函数参数传递。
实例
eventb.js:
var events = require('events'); var emitter = new events.EventEmitter(); //someEvent事件监听器1 emitter.on('someEvent', function(arg1, arg2) { console.log('listener1', arg1, arg2); }); //someEvent事件监听器2 emitter.on('someEvent', function(arg1, arg2) { console.log('listener2', arg1, arg2); }); //触发事件 emitter.emit('someEvent', 'arg1 参数', 'arg2 参数');
运行:
emitter 为事件 someEvent 注册了两个事件监听器,然后触发了 someEvent 事件。
运行结果中可以看到两个事件监听器回调函数被先后调用。
EventEmitter api
方法
序号 | 方法 | 描述 |
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。 |
类方法
序号 | 方法 | 描述 |
1 | listenerCount(emitter, event) | 返回指定事件的监听器数量。 |
事件
序号 | 事件 | 描述 |
1 | newListener | event - 字符串,事件名称 listener - 处理事件函数 该事件在添加新监听器时被触发。 |
2 | removeListener | event - 字符串,事件名称 listener - 处理事件函数 从指定监听器数组中删除一个监听器。需要注意的是,此操作将会改变处于被删监听器之后的那些监听器的索引。 |
实例
eventmain.js:
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 = 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("程序执行完毕。");
运行:
参考:
【1】、https://www.runoob.com/nodejs/nodejs-event.html
【2】、https://www.w3cschool.cn/nodejs/nodejs-event.html