文章目录

• • 前提
  • 引入
  • 注册事件的两种方式
  • • on
    • addListener
  • 和vue事件绑定做对比
  • removeListener(eventName, listener)
  • events参数的传递
  • eventEmitter.once()
  • 自带的两种特殊事件
  • • newListener 事件
    • removeListener事件
  • removeAllListeners([eventName])
  • 不常用的api
  • • MaxListeners

前提

如果你接触过vue，并学习和使用过里面的事件绑定和事件触发，以及子组件给父组件传参的$emit方式，你可能会觉得，本章的内容异常熟悉。

如果你觉得nodejs官方文档给的api太多，不知道哪些重要，请看下去，否则请前往
https://nodejs.org/dist/latest-v10.x/docs/api/events.html

如果你认为官方文档全是英文，不太容易学，并且不在乎nodejs中文网站版本过低的问题，请前往
https://www.nodeapp.cn/events.html

引入

// events 本身是一个构造函数，或者说是一个类，可以构建一个实例对象。
const Events = require("events");

注册事件的两种方式

on

const Events = require("events");
// events 本身是一个构造函数，或者说是一个类，可以构建一个实例对象。
const myEvent = new  Events()// 实例对象上的on方法，用来注册该实例对象的dx事件
myEvent.on('dx',() => {console.log('触发了dx事件')
})setTimeout(() => {// 实例对象的emit方法，用来触发该实例对象上注册的dx事件myEvent.emit('dx')
}, 1000);

同一个事件对象，同一个事件名称，可以多次注册

const Events = require("events");
const myEvent = new  Events()
myEvent.on('click',() => {console.log('click被触发了')
})myEvent.on('click',() => {console.log('click又被触发了')
})myEvent.emit('click')
// click被触发了
// click又被触发了

addListener

addListener的使用方式与on完全一致

const Events = require("events");
// events 本身是一个构造函数，或者说是一个类，可以构建一个实例对象。
const myEvent = new  Events()// 实例对象上的on方法，用来注册该实例对象的dx事件
myEvent.addListener('dx',() => {console.log('触发了dx事件')
})setTimeout(() => {// 实例对象的emit方法，用来触发该实例对象上注册的dx事件myEvent.emit('dx')
}, 1000);

和vue事件绑定做对比

// 组件本身是一个构造函数，或者说是一个类，可以构建一个实例对象，形成一个组件实例。
components: {myEvent: MyEvent
}// 组件实例上的v-on方法，用来注册该组件实例的dx事件
 {console.log('触发了dx事件')
}" />// 在myEvent组件内部某个时候
setTimeout(() => {// 实例对象的emit方法，用来触发该实例对象上注册的dx事件this.$emit('dx')
}, 1000);

你会发现，events的设计模式和vue事件注册触发的设计模式几乎一致，只是写法不同而已，后面就不作对比了，继续介绍events，但越往后面，越觉得它们是一摸一样的，换汤不换药。

removeListener(eventName, listener)

移除事件对象的事件监听，与js的removeEventListener基本一致，需要确保注册和移除时填入的参数能够分别完全相等,否则将无法移除

"dx" === "dx" // true
handle === handle  // true

const Events = require("events");
const myEvent = new  Events()const handle = () => {console.log("dx被触发了");
};myEvent.on("dx", handle);myEvent.emit("dx"); // dx被触发了
myEvent.removeListener("dx", handle);
myEvent.emit("dx"); // 不会执行handle

events参数的传递

const Events = require("events");// events 本身是一个构造函数，或者说是一个类，可以构建一个实例对象。
const myEvent = new  Events()// 实例对象上的on方法，用来注册该实例对象的事件
myEvent.on('dx',(age,name) => {console.log(`${name}今年${age}岁`) // yx今年18岁
})setTimeout(() => {// 实例对象的emit方法，用来触发该实例对象上注册的某一事件// 第一个参数是事件名称，后面的参数都是传递给回调函数的参数myEvent.emit('dx',18,'yx')
}, 1000);

eventEmitter.once()

eventEmitter.once() 用来注册只能被执行一次的事件，once使用的方式与on一致，这有点像vue里面的事件修饰符once，比如 @click.once

const Events = require("events");
// events 本身是一个构造函数，或者说是一个类，可以构建一个实例对象。
const myEvent = new  Events()// 实例对象上的on方法，用来注册该实例对象的事件
myEvent.once('dx',(age,name) => {console.log(`${name}今年${age}岁`)
})setTimeout(() => {// 实例对象的emit方法，用来触发该实例对象上注册的某一事件myEvent.emit('dx',18,'yx') // yx今年18岁myEvent.emit('dx',20,'dx') // 未执行
}, 1000);

自带的两种特殊事件

newListener 事件

newListener是一个特殊的事件名称，它能监听到事件对象每一次有事件被注册，你也许有许多通用的逻辑需要处理.

newListener事件的回调，只会在被绑定的事件对象（myEvent），有事件绑定时才会触发，当myEvent触发事件时，不会触发newListener的回调。

const Events = require("events");
const myEvent = new  Events()
// event 就是事件的名称 handle就是对应的回调函数
myEvent.on('newListener',(event,handle) => {console.log(event)// ... 你还可以写一些其它的通用逻辑handle()
})myEvent.on('click',() => {console.log('click被注册了')
})myEvent.on('dx',() => {console.log('dx被注册了')
})// click
// click被注册了
// dx
// dx被注册了

即使在事件对象上重复注册同一个事件，newListener的回调每一次都会触发

const Events = require("events");
const myEvent = new  Events()myEvent.on('newListener',(event,handle) => {console.log(event)// ... 你还可以写一些其它的通用逻辑handle()
})myEvent.on('click',() => {console.log('click被注册了')
})myEvent.on('click',() => {console.log('click又被注册了')
})// click
// click被注册了
// click
// click又被注册了

removeListener事件

removeListener 也是一个特殊的事件名称，它能监听到事件对象每一次有事件被成功移除，你也许有许多通用的逻辑需要处理.

const Events = require("events");
const myEvent = new  Events()myEvent.on("removeListener", (event, handle) => {handle();console.log(`${event}被移除了`)
});const handle = () => {console.log("dx事件回调被执行了");
};myEvent.on("dx", handle);myEvent.removeListener("dx", handle);// dx事件回调被执行了
// dx被移除了

如果移除某一事件失败，removeListener事件的回调是不会触发的

const Events = require("events");
const myEvent = new  Events()myEvent.on("removeListener", (event, handle) => {handle();console.log(`${event}被移除了`)
});const handle = () => {console.log("dx事件回调被执行了");
};// myEvent.on("dx", handle);myEvent.removeListener("dx", handle); 
// dx未被注册是不可能移除成功的，所以没有任何代码被console.log

removeAllListeners([eventName])

移除全部或指定 eventName 的监听器。世界瞬间安静了。

const Events = require("events");
const myEvent = new  Events()
myEvent.removeAllListeners() // 移除所有绑定的事件

移除dx和click事件所有绑定的回调

myEvent.removeAllListeners(['dx','click'])

不常用的api

MaxListeners

默认的MaxListeners是10，意味着同一个事件对象上的同一个事件名，不能被绑定超过10个回调，如果超过会报一个警告，用以防止内存泄漏。
这个警告不是在你触发(click)事件才会出现,而是在你绑定的超过的时候就会出现。

const Events = require("events");
const myEvent = new  Events()myEvent.on('click',() => {console.log('click被触发了1')
})myEvent.on('click',() => {console.log('click又被触发了2')
})myEvent.on('click',() => {console.log('click被触发了3')
})myEvent.on('click',() => {console.log('click又被触发了4')
})myEvent.on('click',() => {console.log('click被触发了5')
})myEvent.on('click',() => {console.log('click又被触发了6')
})myEvent.on('click',() => {console.log('click被触发了7')
})myEvent.on('click',() => {console.log('click又被触发了8')
})
myEvent.on('click',() => {console.log('click被触发了9')
})myEvent.on('click',() => {console.log('click又被触发了10')
})
myEvent.on('click',() => {console.log('click被触发了11')
})myEvent.on('click',() => {console.log('click又被触发了12')
})
myEvent.on('click',() => {console.log('click被触发了13')
})myEvent.emit('click')
// click被触发了1
// click又被触发了2
// click被触发了3
// click又被触发了4
// click被触发了5
// click又被触发了6
// click被触发了7
// click又被触发了8
// click被触发了9
// click又被触发了10
// click被触发了11
// click又被触发了12
// click被触发了13
// (node:24276) MaxListenersExceededWarning: Possible EventEmitter memory leak detected. 11 click listeners added to [EventEmitter]. Use emitter.setMaxListeners() to increase limit
// (Use `node --trace-warnings ...` to show where the warning was created)

可以通过setMaxListeners(n)修改这个值

const Events = require("events");
const myEvent = new  Events()myEvent.setMaxListeners(20)