幾乎所有 Node.js 的事件操作,都從 emitter.on 開始。它是註冊事件監聽器最基礎、也最常使用的方法。
它為指定事件註冊一個監聽器函數,當事件被觸發時便會執行該函數。
emitter.on(event, listener) emitter.addListener(event, listener)
其中 addListener 是 on 的別名,兩者效果完全相同。
server.on('connection', function (stream) {
console.log('someone connected!');
});
從原始碼可以看到幾個值得注意的設計細節:它會先觸發 newListener 事件、對單一監聽器做了效能優化(不額外包成陣列),並內建了「監聽器洩漏」的偵測機制——當同一事件的監聽器數量超過上限時,會印出警告:
EventEmitter.prototype.addListener = function(type, listener) {
var m;
if (!util.isFunction(listener))
throw TypeError('listener must be a function');
if (!this._events)
this._events = {};
// To avoid recursion in the case that type === "newListener"!
if (this._events.newListener)
this.emit('newListener', type,
util.isFunction(listener.listener) ?
listener.listener : listener);
if (!this._events[type])
this._events[type] = listener;
else if (util.isObject(this._events[type]))
this._events[type].push(listener);
else
this._events[type] = [this._events[type], listener];
// Check for listener leak
if (util.isObject(this._events[type]) && !this._events[type].warned) {
var m;
if (!util.isUndefined(this._maxListeners)) {
m = this._maxListeners;
} else {
m = EventEmitter.defaultMaxListeners;
}
if (m && m > 0 && this._events[type].length > m) {
this._events[type].warned = true;
console.error('(node) warning: possible EventEmitter memory ' +
'leak detected. %d listeners added. ' +
'Use emitter.setMaxListeners() to increase limit.',
this._events[type].length);
console.trace();
}
}
return this;
};
這個「記憶體洩漏」的提醒機制,能幫助你及早發現未清除的監聽器所引發的潛在問題。