前端对事件肯定不陌生,为 window 绑定 scroll 事件

  1. window.addEventListener('scroll', ev => {
  2. console.log(ev);
  3. });

Node.js 大部分异步操作使用事件驱动,所有可以触发事件的对象都继承了 EventEmitter

事件监听

on

Node.js 事件监听使用和 jQuery API 非常类似emitter.on(eventName, listener)

  1. const ee = new EventEmitter();
  2. ee.on('foo', () => console.log('a'));
  1. EventEmitter 实例会维护一个 listener 数组,每次 listener 默认会被添加到数组尾部
  2. 每次添加 listener 不会检查是否添加过,多次调用 on 传入相同的 eventName 和 listener,会导致 listener 被添加多次

    prependListener

    emitter.prependListener(eventName, listener)
    通过 prependListener 可以把 listener 添加到 listener 数组头部
    1. const ee = new EventEmitter();
    2. ee.prependListener('foo', () => console.log('a'));

    once

    如果希望 listener 被触发一次后就不再触发,可以使用 once 来绑定事件
    1. const ee = new EventEmitter();
    2. ee.once('foo', () => console.log('a'));

    事件触发

    emitter.emit(eventName[, ...args])
    在浏览器环境中开发者事件相关的大部分工作是订阅事件,也就是绑定事件处理函数 listener,在 Node.js 事件编程中经常需要创建事件对象,在合理实际触发事件。使用 emit 方法可以按照 listener 注册的顺序,同步地调用每个注册到名为 eventName 的事件的监听器,并传入提供的参数 ```javascript const EventEmitter = require(‘events’); const myEmitter = new EventEmitter();

// 第一个监听器。 myEmitter.on(‘event’, function firstListener() { console.log(‘第一个监听器’); }); // 第二个监听器。 myEmitter.on(‘event’, function secondListener(arg1, arg2) { console.log(第二个监听器中的事件有参数 ${arg1}、${arg2}); }); // 第三个监听器 myEmitter.on(‘event’, function thirdListener(…args) { const parameters = args.join(‘, ‘); console.log(第三个监听器中的事件有参数 ${parameters}); });

console.log(myEmitter.listeners(‘event’));

myEmitter.emit(‘event’, 1, 2, 3, 4, 5);

// Prints: // [ // [Function: firstListener], // [Function: secondListener], // [Function: thirdListener] // ] // 第一个监听器 // 第二个监听器中的事件有参数 1、2 // 第三个监听器中的事件有参数 1, 2, 3, 4, 5

  1. <a name="3caTN"></a>
  2. ### this 指向
  3. `eventEmitter.emit()` 方法可以传任意数量的参数到 listener, `this` 关键词会被指向 listener 所绑定的 EventEmitter 实例
  4. ```javascript
  5. const myEmitter = new MyEmitter();
  6. myEmitter.on('event', function(a, b) {
  7. console.log(a, b, this, this === myEmitter);
  8. // 打印:
  9. // a b MyEmitter {
  10. // domain: null,
  11. // _events: { event: [Function] },
  12. // _eventsCount: 1,
  13. // _maxListeners: undefined } true
  14. });
  15. myEmitter.emit('event', 'a', 'b');

也可以使用 ES6 的箭头函数作为监听器。但 this 关键词不会指向 EventEmitter 实例:

  1. const myEmitter = new MyEmitter();
  2. myEmitter.on('event', (a, b) => {
  3. console.log(a, b, this);
  4. // 打印: a b {}
  5. });
  6. myEmitter.emit('event', 'a', 'b');

异步调用

EventEmitter 以注册的顺序同步地调用所有 listener,这样可以确保事件的正确排序,listener 可以使用 setImmediate()process.nextTick() 方法切换到异步的操作模式

  1. const myEmitter = new MyEmitter();
  2. myEmitter.on('event', (a, b) => {
  3. setImmediate(() => {
  4. console.log('异步地发生');
  5. });
  6. });
  7. myEmitter.emit('event', 'a', 'b');

事件卸载

Node.js 提供了几种卸载事件绑定的方法

off/removeListener

off 方法是 removeListener 方法的别名,用于清理事件绑定 emitter.removeListener(eventName, listener)

  1. const callback = (stream) => {
  2. console.log('已连接');
  3. };
  4. server.on('connection', callback);
  5. // ...
  6. server.removeListener('connection', callback);

removeListener() 最多只会从监听器数组中移除一个监听器。 如果监听器被多次添加到指定 eventName 的监听器数组中,则必须多次调用 removeListener() 才能移除所有实例

removeAllListeners

emitter.removeAllListeners([eventName])
移除指定的 eventName 事件的 listener,如果没有指定 eventName,则移除事件对象的所有 listener。可以通过 emitter.eventNames() 获取事件对象上的 eventName 数组

  1. const EventEmitter = require('events');
  2. const myEE = new EventEmitter();
  3. myEE.on('foo', () => {});
  4. myEE.on('bar', () => {});
  5. myEE.eventNames().forEach(eventName => myEE.removeAllListeners);