在 Node.js 中,事件驱动编程主要通过 EventEmitter 类来实现。
EventEmitter 是一个内置类,位于 events
模块中,通过继承 EventEmitter
,你可以创建自己的事件发射器,并注册和触发事件。
通过这种机制,Node.js 可以高效地处理异步任务,即使在单线程的环境下也能实现并发处理。
Node.js 里面的许多对象都会分发事件:一个 net.Server
对象会在每次有新连接时触发一个事件, 一个 fs.readStream
对象会在文件被打开的时候触发一个事件。 所有这些产生事件的对象都是 events.EventEmitter
的实例。
// 引入 events 模块
var events = require('events');
// 创建 eventEmitter 事件对象
var eventEmitter = new events.EventEmitter();
// 注册事件
eventEmitter.on('my_event', function() {
console.log('my_event 事件触发');
});
// 触发事件
eventEmitter.emit('my_event')
大多数时候我们不会直接使用 EventEmitter,而是在对象中继承它,包括 fs、net、http 在内的,只要是支持事件响应的核心模块都是 EventEmitter 的子类。
class MyEmitter extends EventEmitter {}
const customEmitter = new MyEmitter();
customEmitter.on('customEvent', () => {
console.log('Custom event fired');
});
customEmitter.emit('customEvent');
方法 | 描述 |
---|---|
addListener(event, listener) |
为指定事件添加一个监听器到监听器数组的尾部。 |
on(event, listener) |
为指定事件注册一个监听器,接受一个字符串 event 和一个回调函数。server.on('connection', function (stream) { console.log('someone connected!'); }); |
once(event, listener) |
为指定事件注册一个单次监听器,即 监听器最多只会触发一次,触发后立刻解除该监听器。server.once('connection', function (stream) { console.log('Ah, we have our first user!'); }); |
removeListener(event, listener) |
移除指定事件的某个监听器,监听器必须是该事件已经注册过的监听器。它接受两个参数,第一个是事件名称,第二个是回调函数名称。var callback = function(stream) { console.log('someone connected!'); }; server.on('connection', callback); server.removeListener('connection', callback); |
removeAllListeners([event]) |
移除所有事件的所有监听器, 如果指定事件,则移除指定事件的所有监听器。 |
setMaxListeners(n) |
默认情况下, EventEmitters 如果你添加的监听器超过 10 个就会输出警告信息。 setMaxListeners 函数用于改变监听器的默认限制的数量。 |
listeners(event) |
返回指定事件的监听器数组。 |
emit(event, [arg1], [arg2], [...]) |
按监听器的顺序执行执行每个监听器,如果事件有注册监听返回 true,否则返回 false。 |
EventEmitter 定义了一个特殊的事件 error,它包含了错误的语义,我们在遇到异常的时候通常会触发 error 事件。
当 error 被触发时,EventEmitter 规定如果没有响应的监听器,Node.js 会把它当作异常,退出程序并输出错误信息。
我们一般要为会触发 error 事件的对象设置监听器,避免遇到错误后整个程序崩溃。
const EventEmitter = require("events");
class MyEmitter extends EventEmitter{}
class MyError extends Error{
constructor(message){
super(message)
Error.captureStackTrace(this,this.constructor)
}
}
var myEmitter = new MyEmitter()
myEmitter.on('error',(e) => {
console.log(e)
})
myEmitter.emit('error',new MyError("错误啦"))
console.log("程序还在执行。。。")
// MyError: 错误啦
// at Object.<anonymous> (/Users/yanggang/develop/nodejs-project/nodejs-demo/index.js:18:24)
// at Module._compile (node:internal/modules/cjs/loader:1198:14)
// at Object.Module._extensions..js (node:internal/modules/cjs/loader:1252:10)
// at Module.load (node:internal/modules/cjs/loader:1076:32)
// at Function.Module._load (node:internal/modules/cjs/loader:911:12)
// at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)
// at node:internal/main/run_main_module:22:47
// 程序还在执行