node.JS事件機(jī)制與events事件模塊的使用方法詳解

更新時(shí)間：2020年02月06日 13:02:15 作者：小火柴的藍(lán)色理想

本文將詳細(xì)介紹nodeJS事件機(jī)制與events事件模塊的使用方

node.JS事件機(jī)制說明

多數(shù) Node.js 核心 API 都是采用慣用的異步事件驅(qū)動(dòng)架構(gòu)，其中某些類型的對(duì)象（稱為觸發(fā)器）會(huì)周期性地觸發(fā)命名事件來調(diào)用函數(shù)對(duì)象（監(jiān)聽器）。例如，一個(gè)net.Server對(duì)象會(huì)在每次有新連接時(shí)觸發(fā)一個(gè)事件；一個(gè) fs.ReadStream 會(huì)在文件被打開時(shí)觸發(fā)一個(gè)事件；一個(gè) stream會(huì)在數(shù)據(jù)可讀時(shí)觸發(fā)事件。

EventEmitter

EventEmitter 類由 events 模塊定義和開放的，所有能觸發(fā)事件的對(duì)象都是 EventEmitter 類的實(shí)例

var EventEmitter = require('events');
/*
{ [Function: EventEmitter]
 EventEmitter: [Circular],
 usingDomains: false,
 defaultMaxListeners: [Getter/Setter],
 init: [Function],
 listenerCount: [Function] }
 */
console.log(EventEmitter);

events模塊的EventEmitter屬性指向該模塊本身

var events = require('events');
console.log(events.EventEmitter === events);//true
EventEmitter是一個(gè)構(gòu)造函數(shù)，可以用來生成事件發(fā)生器的實(shí)例emitter
var EventEmitter = require('events');
var emitter = new EventEmitter();
/*
EventEmitter {
 domain: null,
 _events: {},
 _eventsCount: 0,
 _maxListeners: undefined }
 */
console.log(emitter);

方法

emitter.emit(eventName[, ...args])

eventName <any>

...args <any>

該方法按監(jiān)聽器的注冊(cè)順序，同步地調(diào)用每個(gè)注冊(cè)到名為eventName事件的監(jiān)聽器，并傳入提供的參數(shù)。如果事件有監(jiān)聽器，則返回true，否則返回false

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('test1',function(){});
console.log(emitter.emit('test1'));//true
console.log(emitter.emit('test2'));//false

emitter.on(eventName, listener)

該方法用于添加listener函數(shù)到名為eventName的事件的監(jiān)聽器數(shù)組的末尾

eventName <any> 事件名

listener <Function> 回調(diào)函數(shù)

[注意]不會(huì)檢查listener是否已被添加。多次調(diào)用并傳入相同的eventName和listener會(huì)導(dǎo)致listener被添加與調(diào)用多次

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('test',function(){
  console.log(1);
});
emitter.on('test',function(){
  console.log(2);
});
emitter.emit('test');//1 2

該方法返回一個(gè) EventEmitter 引用，可以鏈?zhǔn)秸{(diào)用

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('test',function(){
  console.log(1);
}).on('test',function(){
  console.log(2);
});
emitter.emit('test');//1 2

emitter.addListener(eventName, listener)

emitter.on(eventName, listener) 的別名

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.addListener('test',function(){
  console.log(1);
});
emitter.emit('test');//1

emitter.prependListener()

與on()方法不同，prependListener()方法可用于將事件監(jiān)聽器添加到監(jiān)聽器數(shù)組的開頭

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('test',function(){
  console.log(1);
}).prependListener('test',function(){
  console.log(2);
});
emitter.emit('test');//2 1

emitter.once(eventName, listener)

該方法添加一個(gè)單次 listener 函數(shù)到名為 eventName 的事件。下次觸發(fā) eventName 事件時(shí)，監(jiān)聽器會(huì)被移除，然后調(diào)用

eventName <any> 事件名

listener <Function> 回調(diào)函數(shù)

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('test',function(){
  console.log(1);
}).once('test',function(){
  console.log(2);
});
emitter.emit('test');//1 2
emitter.emit('test');//1

emitter.prependOnceListener()

該方法用于將事件監(jiān)聽器添加到監(jiān)聽器數(shù)組開頭。下次觸發(fā)eventName事件時(shí)，監(jiān)聽器會(huì)被移除，然后調(diào)用

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('test',function(){
  console.log(1);
}).prependOnceListener('test',function(){
  console.log(2);
});
emitter.emit('test');//2 1
emitter.emit('test');//1

emitter.removeAllListeners([eventName])

eventName <any>

移除全部或指定 eventName 的監(jiān)聽器，返回一個(gè) EventEmitter 引用，可以鏈?zhǔn)秸{(diào)用

[注意]在代碼中移除其他地方添加的監(jiān)聽器是一個(gè)不好的做法，尤其是當(dāng) EventEmitter 實(shí)例是其他組件或模塊（如 socket 或文件流）創(chuàng)建的

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('test',function(){
  console.log(1);
}).removeAllListeners('test');
emitter.emit('test');//''

emitter.removeListener(eventName, listener)

eventName <any>

listener <Function>

從名為 eventName 的事件的監(jiān)聽器數(shù)組中移除指定的 listener

var EventEmitter = require('events');
var emitter = new EventEmitter();
function show(){
  console.log(1);
}
emitter.on('test',show).removeListener('test',show);
emitter.emit('test');//''

[注意]removeListener最多只會(huì)從監(jiān)聽器數(shù)組里移除一個(gè)監(jiān)聽器實(shí)例。如果任何單一的監(jiān)聽器被多次添加到指定eventName的監(jiān)聽器數(shù)組中，則必須多次調(diào)用removeListener才能移除每個(gè)實(shí)例

var EventEmitter = require('events');
var emitter = new EventEmitter();
function show(){
  console.log(1);
}
emitter.on('test',show).on('test',show).removeListener('test',show);
emitter.emit('test');//'1'

[注意]一旦一個(gè)事件被觸發(fā)，所有綁定到它的監(jiān)聽器都會(huì)按順序依次觸發(fā)。這意味著，在事件觸發(fā)后、最后一個(gè)監(jiān)聽器完成執(zhí)行前，任何 removeListener() 或 removeAllListeners() 調(diào)用都不會(huì)從 emit() 中移除它們。隨后的事件會(huì)像預(yù)期的那樣發(fā)生

因?yàn)楸O(jiān)聽器是使用內(nèi)部數(shù)組進(jìn)行管理的，所以調(diào)用它會(huì)改變?cè)诒O(jiān)聽器被移除后注冊(cè)的任何監(jiān)聽器的位置索引。雖然這不會(huì)影響監(jiān)聽器的調(diào)用順序，但意味著由 emitter.listeners() 方法返回的監(jiān)聽器數(shù)組副本需要被重新創(chuàng)建

var EventEmitter = require('events');
var emitter = new EventEmitter();
function show1(){
  console.log(1);
  emitter.removeListener('test',show2);
}
function show2(){
  console.log(2);
}
emitter.on('test',show1).on('test',show2);
emitter.emit('test');//1 2
emitter.emit('test');//1

設(shè)置

emitter.eventNames()

返回一個(gè)列出觸發(fā)器已注冊(cè)監(jiān)聽器的事件的數(shù)組。數(shù)組中的值為字符串或符號(hào)

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.addListener('test1',function(){console.log(1);});
emitter.addListener('test2',function(){console.log(2);});
console.log(emitter.eventNames());//[ 'test1', 'test2' ]

emitter.listenerCount(eventName)

eventName <any> 正在被監(jiān)聽的事件名

返回正在監(jiān)聽名為 eventName 的事件的監(jiān)聽器的數(shù)量

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.addListener('test',function(){console.log(1);});
emitter.addListener('test',function(){console.log(1);});
console.log(emitter.listenerCount('test'));//2

emitter.listeners(eventName)

eventName <any>

返回名為 eventName 的事件的監(jiān)聽器數(shù)組的副本

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.addListener('test',function(){console.log(1);});
emitter.addListener('test',function(){console.log(2);});
console.log(emitter.listeners('test'));//[ [Function], [Function] ]
emitter.listeners('test')[0]();//1

emitter.getMaxListeners()

返回 EventEmitter 當(dāng)前的最大監(jiān)聽器限制值

var EventEmitter = require('events');
var emitter = new EventEmitter();
console.log(emitter.getMaxListeners());//10

emitter.setMaxListeners(n)

默認(rèn)情況下，如果為特定事件添加了超過 10 個(gè)監(jiān)聽器，則 EventEmitter 會(huì)打印一個(gè)警告。此限制有助于尋找內(nèi)存泄露。但是，并不是所有的事件都要被限為 10 個(gè)。 emitter.setMaxListeners() 方法允許修改指定的 EventEmitter 實(shí)例的限制。值設(shè)為 Infinity（或 0）表明不限制監(jiān)聽器的數(shù)量。返回一個(gè) EventEmitter 引用，可以鏈?zhǔn)秸{(diào)用

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){});
/*
Warning: Possible EventEmitter memory leak detected. 11 a listeners added. Use emitter.setMaxListeners() to increase limit
 */
var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.setMaxListeners(11);
emitter.on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){});

EventEmitter.defaultMaxListeners

每個(gè)事件默認(rèn)可以注冊(cè)最多10個(gè)監(jiān)聽器。單個(gè)EventEmitter實(shí)例的限制可以使用emitter.setMaxListeners(n)方法改變。所有EventEmitter實(shí)例的默認(rèn)值可以使用EventEmitter.defaultMaxListeners屬性改變

[注意]設(shè)置 EventEmitter.defaultMaxListeners 要謹(jǐn)慎，因?yàn)闀?huì)影響所有EventEmitter 實(shí)例，包括之前創(chuàng)建的。因而，調(diào)用 emitter.setMaxListeners(n) 優(yōu)先于 EventEmitter.defaultMaxListeners

var EventEmitter = require('events');
var emitter = new EventEmitter();
EventEmitter.defaultMaxListeners = 11;
emitter.on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){});

node.JS事件注冊(cè)與刪除

'newListener' 事件

eventName <any> 要監(jiān)聽的事件的名稱

listener <Function> 事件的句柄函數(shù)

EventEmitter 實(shí)例會(huì)在一個(gè)監(jiān)聽器被添加到其內(nèi)部監(jiān)聽器數(shù)組之前觸發(fā)自身的 'newListener' 事件

注冊(cè)了 'newListener' 事件的監(jiān)聽器會(huì)傳入事件名與被添加的監(jiān)聽器的引用。事實(shí)上，在添加監(jiān)聽器之前觸發(fā)事件有一個(gè)微妙但重要的副作用： 'newListener' 回調(diào)中任何額外的被注冊(cè)到相同名稱的監(jiān)聽器會(huì)在監(jiān)聽器被添加之前被插入

var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('newListener',function(){
  console.log(2);
})
emitter.on('test',function(){
  console.log(1);
})
emitter.emit('test');//2 1
var EventEmitter = require('events');
var emitter = new EventEmitter();
emitter.on('test',function(){
  console.log(1);
})
emitter.on('newListener',function(){
  console.log(2);
})
emitter.emit('test');//1

'removeListener' 事件

eventName <any> 事件名

listener <Function> 事件句柄函數(shù)

'removeListener' 事件在 listener 被移除后觸發(fā)

var EventEmitter = require('events');
var emitter = new EventEmitter();
function show(){
  console.log(1);
}
emitter.on('removeListener',function(){
  console.log(2);//2
})
emitter.on('test',show).removeListener('test',show);
var EventEmitter = require('events');
var emitter = new EventEmitter();
function show(){
  console.log(1);
}
emitter.on('test',show).removeListener('test',show);
emitter.on('removeListener',function(){
  console.log(2);//''
})
var EventEmitter = require('events');
var emitter = new EventEmitter();
function show(){
  console.log(1);
}
emitter.removeListener('test',show);
emitter.on('removeListener',function(){
  console.log(2);//''

更多關(guān)于node.js事件的相關(guān)文章大家可以點(diǎn)擊下面的相關(guān)鏈接

您可能感興趣的文章: