DIV CSS 佈局教程網

深入淺談Node.js的觀察者模式與Events模塊
編輯:關於JavaScript     

一、前言

用Node.js也有一段時間了,最近回頭複習它的API、多用新特性,希望能有更高層次的掌握。這次API總結不同於單純的英文漢化,會多做些擴展並融入自己的理解,希望能對大家有所幫助——先從最核心的 Events 說起。

Node.js的 Events 實現了一種觀察者模式,支撐著Node.js的核心機制;http、fs、mongoose 等模塊都繼承了 Events,可以添加監聽事件。這種設計模式在客戶端組件編程裡也很常見,我們先簡單了解一下。

我第一次接觸觀察者模式是在Extjs框架的 Ext.util.observable 源碼裡,那時剛學JS,感覺這種模式很強大,也是我最早接觸到的設計模式;後來在 underscore.js 源碼裡也見到過,且後者實現更簡潔優雅,我編寫組件時也基本是照這種思想來。

觀察者模式,本質就是為某個對象添加監聽事件,如 on('show', callback),再由該對象在符合條件(如 show)時自行觸發。瀏覽器本身已為DOM實現了監聽機制,例如我們給 input 綁定 keyup,目的是輸出它的 value:

 $( 'input' ).on( 'keyup', function(){ console.log( this.value ); } ); 

這樣輸入時就會自動在控制台輸出 value。但如果我們自己做一個組件如Dialog,該如何監聽最常用的 show/hide 事件呢?

最初級的做法是在實例化時直接把回調配置進去:

 var dialog = new Dialog({ content: '這裡是彈出框的內容', show: function(){ console.log( '當彈框時輸出此段內容' ); } });

這樣也能用,但顯然不夠靈活。如何讓 dialog 像 input 那樣隨時添加事件呢?

二、觀察者模式實現

先實現一個 Events 對象,這裡提供基礎的監聽 on 與觸發 emit,事件以JSON形式壓棧在對象的 _events 裡:

 var Events = { on: function( name, callback){ this._events = this._events || {}; this._events[ name ] = this._events[ name ] || []; this._events[ name ].push( callback ); }, emit: function( name ){ this._events = this._events || {}; var args = Array.prototype.slice.call( arguments, 1 ), me = this; if( this._events[ name ] ){ $.each( this._events[ name ], function( k, v ){ v.call( me, args ); } ) } } } 

再抽象一個函數,用於為對象復制屬性:

 function extend( source ){ var args = Array.prototype.slice.call( arguments, 1 ); for( var i = 0, parent; parent = args[i]; i++ ){ for( var prop in parent ){ source[ prop ] = parent[ prop ]; } } }

接著實現一個Dialog,僅包含創建,以及 show/hide 兩個方法與事件。看效果時加上這段樣式:

 .dialog{ position: fixed; top: 50%; left: 50%; margin: -50px 0 0 -100px; width: 200px; height: 120px; background: #fff; border: 5px solid #afafaf; }

實現組件:

 var Dialog = function( config ){ this.config = config; this.init( this.config ); };

擴展屬性:

 extend( Dialog.prototype, { init: function( config ){ this.render( config ) }, render: function( config ){ this.el = $( '<div>' ).addClass( 'dialog' ); this.el.html( config.content ); $( 'body' ).append( this.el ); }, show: function( param ){ this.el.fadeIn(); this.emit( 'show', param ); }, hide: function( param ){ this.el.fadeOut(); this.emit( 'hide', param ); } }, Events );

生成實例,並添加三個 show 與三個 hide 監聽:

 var dialog = window.dialog = new Dialog({ content: 'dialog one' }); dialog.on( 'show', function( txt ){ console.log( 'dialog show one ' + txt ); } ); //do something dialog.on( 'show', function( txt ){ console.log( 'dialog show two ' + txt ); } ); //do something dialog.on( 'show', function( txt ){ console.log( 'dialog show three ' + txt ); } ); //do something dialog.on( 'hide', function( txt ){ console.log( 'dialog hide one ' + txt ); } ); //do something dialog.on( 'hide', function( txt ){ console.log( 'dialog hide two ' + txt ); } ); //do something dialog.on( 'hide', function( txt ){ console.log( 'dialog hide three ' + txt ); } );

我們分六次添加了六個不同的監聽事件。當執行 dialog.show() 時就會輸出三條對應日誌,這些事件都保存在 dialog._events 裡:

添加的三個 show 都成功輸出,事件保存在 _events 屬性裡——Node.js的 Events 也正是實現了這一過程。

三、結構

 var Events = require( 'events' ); console.log( Events ); /* 輸出如下數據,可以看出 Events指向其EventEmiter { [Function: EventEmitter] EventEmitter: [Circular], usingDomains: [Getter/Setter], defaultMaxListeners: 10, init: [Function], listenerCount: [Function] } */ var myEmitter = new Events(); console.log( myEmitter ); /* { domain: null, _events: {}, //可以看到實例本身也有_events屬性,添加的監聽的事件就保存在這裡 _maxListeners: undefined} */ console.log( myEmitter.__proto__ ); /* { domain: undefined, _events: undefined, _maxListeners: undefined, setMaxListeners: [Function: setMaxListeners], emit: [Function: emit], addListener: [Function: addListener], on: [Function: addListener], once: [Function: once], removeListener: [Function: removeListener], removeAllListeners: [Function: removeAllListeners], listeners: [Function: listeners] } */ myEmitter.on( 'show', function( txt ){ console.log( 'one ' + txt )}) myEmitter.on( 'show', function( txt ){ console.log( 'tow ' + txt )}) myEmitter.on( 'hide', function( txt ){ console.log( 'one ' + txt )}) myEmitter.emit( 'show', 'show' ); myEmitter.setMaxListeners( 10 ); console.log( myEmitter ); /* { domain: null, _events: { show: [ [Function], [Function] ], hide: [Function] }, //添加後的事情,以json形式存放 _maxListeners: 10 } */

四、API

Events提供的方法中,on 是 addListener 的簡寫,都用來為實例添加監聽;其餘屬性也都顧名思義:

 property _events: undefined, //以壓棧形式存放on進來的事件 _maxListeners: undefined //設置最大監聽數,超出提warn ---------------------------------------------------------------------------------------------------------------- method setMaxListeners: [Function: setMaxListeners], /*設置私有屬性_maxListeners的值,默認Events會在當某監聽事件多於10個時發現警告(見上面Events.defaultMaxListeners),以防止內存洩露,如 (node) warning: possible EventEmitter memory leak detected. 11 show listeners added. Use emitter.setMaxListeners() to increase limit. 但這只是個友好的提醒,可以通過設置最大監聽數來規避這個問題 myEmitter.setMaxListeners( 20 ); */ emit: [Function: emit], /*觸發監聽事件 emitter.emit( event, [arg1], [arg2], ... ) 如myEmitter.on( 'show', 'prompt content' ); 參數1為事件名,參數二供on回調裡的參數 */ addListener: [Function: addListener], /* 添加監聽事件 emitter.addListener( event, listener ); 如 myEmitter.addListener( 'show', function( txt ){ console.log( txt ) } ); 參數一是事件名,參數二是對應的回調,回調裡的參數就是 emit裡的arguments.prototype.slice.call(1); */ on: [Function: addListener], /* 是addListener簡寫 */ once: [Function: once], /* 作用同 on,不過emit一次後就失效了 emitter.once( event, listener ); 如 myEmitter.once( 'show', function( txt ){ console.log( txt ) } ); 當myEmitter.emit執行第二次時沒有輸出 */ removeListener: [Function: removeListener], /* 移除指定事件的指定回調,此時回調不能再用匿名函數。 emitter.removeListener( event, listener ); 如 function show( txt ){ console.log( txt ) }; myEmitter.on( 'show', show ); console.log( myEmitter._events ); // { show: [ Function: show ] } myEmitter.removeListener( 'show', show ); console.log( myEmitter._events ); // {} */ removeAllListeners: [Function: removeAllListeners], /* 刪除指定事件的所有回調 emitter.removeAllListeners( [ event ] ); 如 myEmitter.removeAllListeners( 'show' ); //刪除所有show監聽 myEmitter.removeAllListeners(); //刪除所有監聽 */ listeners: [Function: listeners] /* 查看指定監聽 emitter.listeners( event ); 如 myEmitter.listeners( 'show' ); //返回一個數組 同我們前面使用的 myEmitter._events[ 'show' ] */ 另外Events類本身提供了一個方法 Events.listenerCount( emitter, event ); 獲取指定實例下指定監聽數 如 Event.listenerCount( myEmitter, 'show' ) ----------------------------------------------------------------------------------------------- 還有兩個event newListener / remoteListener,分別應用於為實例添加( on / once )和刪除( removeListener ) 操作。 emitter.on( event, listener ); emitter.on( 'newListener', function( event, listener ){ console.log( emitter.listeners( 'show' ) ); //注意,此時監聽還並沒有添加到 emitter.listeners console.log( arguments ); }); emitter.on( 'removeListener', function(){ console.log( emitter.listeners( 'show' ) ); console.log( arguments ); })

五、應用

使用 Events 時,通常直接實例化即可(如上)。但如果我們在Node.js端也寫了一個組件如Dialog,想讓它也具備 Events 的能力,就可以用類似的 extend 方案把 Events 混入:

 var Dialog = function(){ //do something } //抽象apply函數,提供屬性的深度復制,同上面的extend function apply( source ){ var args = Array.prototype.slice.call( arguments, 1 ); for( var i = 0, parent; parent = args[i]; i++ ){ for( var prop in parent ){ source[ prop ] = parent[ prop ]; } } } //抽象extend函數,用於實現繼承 var extend = function(){ // inline overrides var io = function(o){ for(var m in o){ this[m] = o[m]; } }; var oc = Object.prototype.constructor; return function(sb, sp, overrides){ if(typeof sp == 'object'){ overrides = sp; sp = sb; sb = overrides.constructor != oc ? overrides.constructor : function(){sp.apply(this, arguments);}; } var F = function(){}, sbp, spp = sp.prototype; F.prototype = spp; sbp = sb.prototype = new F(); sbp.constructor=sb; sb.superclass=spp; if(spp.constructor == oc){ spp.constructor=sp; } sb.override = function(o){ apply(sb, o); }; sbp.superclass = sbp.supr = (function(){ return spp; }); sbp.override = io; apply(sb, overrides); sb.extend = function(o){return extend(sb, o);}; return sb; }; }(); //將Events屬性繼承給Dialog Dialog = extend( Dialog, Events ); //為Dialog新增 method show,其內觸發 event show Dialog.prototype.show = function( txt ){ this.emit( 'show', txt ); } var dialog = new Dialog(); //添加監聽事件show dialog.on( 'show', function(txt){ console.log( txt )}); //執行method show時,就會觸發其內定義的show events,輸出 this is show dialog.show( 'this is show' );

這樣就為組件實現了 Events 機制:調用 method 時,會觸發對應的 event。

六、總結

Node.js提供了極佳的監聽機制,並將它應用於所有模塊,支撐起Node.js最具特色的I/O模式——比如啟動http服務時監聽 connect/close,http.request 時監聽 data/end 等。理解這套監聽機制,不僅有助於打好Node.js的基礎,也能提升自己的編程思想。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved