node.JS事件機制與events事件模塊的使用方法詳解
node.JS事件機制說明
多數(shù) Node.js 核心 API 都是采用慣用的異步事件驅(qū)動架構(gòu),其中某些類型的對象(稱為觸發(fā)器)會周期性地觸發(fā)命名事件來調(diào)用函數(shù)對象(監(jiān)聽器)。例如,一個net.Server對象會在每次有新連接時觸發(fā)一個事件;一個 fs.ReadStream 會在文件被打開時觸發(fā)一個事件;一個 stream會在數(shù)據(jù)可讀時觸發(fā)事件。
EventEmitter
EventEmitter 類由 events 模塊定義和開放的,所有能觸發(fā)事件的對象都是 EventEmitter 類的實例
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òu)造函數(shù),可以用來生成事件發(fā)生器的實例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)聽器的注冊順序,同步地調(diào)用每個注冊到名為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ù)
[注意]不會檢查listener是否已被添加。多次調(diào)用并傳入相同的eventName和listener會導致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
該方法返回一個 EventEmitter 引用,可以鏈式調(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)
該方法添加一個單次 listener 函數(shù)到名為 eventName 的事件。 下次觸發(fā) eventName 事件時,監(jiān)聽器會被移除,然后調(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事件時,監(jiān)聽器會被移除,然后調(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)聽器,返回一個 EventEmitter 引用,可以鏈式調(diào)用
[注意]在代碼中移除其他地方添加的監(jiān)聽器是一個不好的做法,尤其是當 EventEmitter 實例是其他組件或模塊(如 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最多只會從監(jiān)聽器數(shù)組里移除一個監(jiān)聽器實例。如果任何單一的監(jiān)聽器被多次添加到指定eventName的監(jiān)聽器數(shù)組中,則必須多次調(diào)用removeListener才能移除每個實例
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'
[注意]一旦一個事件被觸發(fā),所有綁定到它的監(jiān)聽器都會按順序依次觸發(fā)。這意味著,在事件觸發(fā)后、最后一個監(jiān)聽器完成執(zhí)行前,任何 removeListener() 或 removeAllListeners() 調(diào)用都不會從 emit() 中移除它們。 隨后的事件會像預期的那樣發(fā)生
因為監(jiān)聽器是使用內(nèi)部數(shù)組進行管理的,所以調(diào)用它會改變在監(jiān)聽器被移除后注冊的任何監(jiān)聽器的位置索引。 雖然這不會影響監(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
設置
emitter.eventNames()
返回一個列出觸發(fā)器已注冊監(jiān)聽器的事件的數(shù)組。 數(shù)組中的值為字符串或符號
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 當前的最大監(jiān)聽器限制值
var EventEmitter = require('events'); var emitter = new EventEmitter(); console.log(emitter.getMaxListeners());//10
emitter.setMaxListeners(n)
默認情況下,如果為特定事件添加了超過 10 個監(jiān)聽器,則 EventEmitter 會打印一個警告。 此限制有助于尋找內(nèi)存泄露。 但是,并不是所有的事件都要被限為 10 個。 emitter.setMaxListeners() 方法允許修改指定的 EventEmitter 實例的限制。 值設為 Infinity(或 0)表明不限制監(jiān)聽器的數(shù)量。返回一個 EventEmitter 引用,可以鏈式調(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
每個事件默認可以注冊最多10個監(jiān)聽器。單個EventEmitter實例的限制可以使用emitter.setMaxListeners(n)方法改變。所有EventEmitter實例的默認值可以使用EventEmitter.defaultMaxListeners屬性改變
[注意]設置 EventEmitter.defaultMaxListeners 要謹慎,因為會影響所有EventEmitter 實例,包括之前創(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事件注冊與刪除
'newListener' 事件
eventName <any> 要監(jiān)聽的事件的名稱
listener <Function> 事件的句柄函數(shù)
EventEmitter 實例會在一個監(jiān)聽器被添加到其內(nèi)部監(jiān)聽器數(shù)組之前觸發(fā)自身的 'newListener' 事件
注冊了 'newListener' 事件的監(jiān)聽器會傳入事件名與被添加的監(jiān)聽器的引用。事實上,在添加監(jiān)聽器之前觸發(fā)事件有一個微妙但重要的副作用: 'newListener' 回調(diào)中任何額外的被注冊到相同名稱的監(jiān)聽器會在監(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);//''
更多關于node.js事件的相關文章大家可以點擊下面的相關鏈接
相關文章
node將geojson轉(zhuǎn)shp返回給前端的實現(xiàn)方法
這篇文章主要介紹了node將geojson轉(zhuǎn)shp返回給前端的實現(xiàn)方法,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2019-05-05Nestjs自定義注解實現(xiàn)接口權(quán)限控制詳解
這篇文章主要為大家介紹了Nestjs自定義注解實現(xiàn)接口權(quán)限控制詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2022-12-12教你如何用Node實現(xiàn)API的轉(zhuǎn)發(fā)(某音樂)
這篇文章主要介紹了教你如何用Node實現(xiàn)API的轉(zhuǎn)發(fā)(某音樂),文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2019-09-09node.js利用socket.io實現(xiàn)多人在線匹配聯(lián)機五子棋
這篇文章主要介紹了node.js利用socket.io實現(xiàn)多人在線匹配聯(lián)機五子棋的操作方法,非常不錯,具有一定的參考借鑒價值,需要的朋友可以參考下2018-05-05