主流JS框架中DOMReady事件的實現

轉載:http://www.cnblogs.com/JulyZhang/archive/2011/02/12/1952484.html

在實際應用中,我們經常會遇到這樣的場景,當頁面加載完成後去做一些事情:綁定事件DOM操作某些結點等。原來比較常用的是window的onload 事件,而該事件的實際效果是:當頁面解析/DOM樹建立完成,並完成了諸如圖片、腳本、樣式表甚至是iframe中所有資源的下載後才觸發的。這對於很多 實際的應用而言有點太“遲”了,比較影響用戶體驗。爲了解決這個問題,ff中便增加了一個DOMContentLoaded方法,與onload相比,該 方法觸發的時間更早,它是在頁面的DOM內容加載完成後即觸發,而無需等待其他資源的加載。Webkit引擎從版本525(Webkit nightly 1/2008:525+)開始也引入了該事件,Opera中也包含該方法。到目前爲止主的IE仍然沒有要添加的意思。雖然IE下沒有,但總是有解決辦法 的,下文對比了一下幾大主流框架對於該事件的兼容性版本實現方案,涉及的框架包括:

  1. Prototype
  2. jQeury
  3. moontools
  4. dojo
  5. yui
  6. ext

一、Prototype

實現代碼 

複製代碼
1 (function() { 2 /* Support for the DOMContentLoaded event is based on work by Dan Webb, 3 Matthias Miller, Dean Edwards and John Resig. */ 4 var timer; 5 function fireContentLoadedEvent() { 6 if (document.loaded) return; 7 if (timer) window.clearInterval(timer); 8 document.fire("dom:loaded"); 9 document.loaded = true; 10 } 11 if (document.addEventListener) { 12 if (Prototype.Browser.WebKit) { 13 timer = window.setInterval(function() { 14 if (/loaded|complete/.test(document.readyState)) 15 fireContentLoadedEvent(); 16 }, 0); 17 Event.observe(window, "load", fireContentLoadedEvent); 18 } else { 19 document.addEventListener("DOMContentLoaded", 20 fireContentLoadedEvent, false); 21 } 22 } else { 23 document.write("<"+"script id=__onDOMContentLoaded defer src=//:><\/script>"); 24 $("__onDOMContentLoaded").onreadystatechange = function() { 25 if (this.readyState == "complete") { 26 this.onreadystatechange = null; 27 fireContentLoadedEvent(); 28 } 29 }; 30 } 31 })();
複製代碼

實現思路如下:

  1. 如果是webkit則輪詢document的readyState屬性,如果該屬性的值爲loaded或complete則觸發DOMContentLoaded事件,爲保險起見,將該事件註冊到window.onload上。
  2. 如果是FF則直接註冊DOMContentLoaded事件。
  3. 如果是IE則使用document.write往頁面中加入一個script元素,並設置defer屬性,最後是把該腳本的加載完成視作DOMContentLoaded事件來觸發。

該實現方式的問題主要有兩點:第一、通過document.write寫script並設置defer的方法在頁面包含iframe的情況下,會等到 iframe內的內容加載完後才觸發,這與onload沒有太大的區別;第二、Webkit在525以上的版本引入了DOMContentLoaded方 法,因此在這些版本中無需再通過輪詢來實現,可以優化。

二、jQuery

複製代碼
1 function bindReady(){ 2 if ( readyBound ) return; 3 readyBound = true; 4 // Mozilla, Opera and webkit nightlies currently support this event 5   if ( document.addEventListener ) { 6 // Use the handy event callback 7   document.addEventListener( "DOMContentLoaded", function(){ 8 document.removeEventListener( "DOMContentLoaded", arguments.callee, false ); 9 jQuery.ready(); 10 }, false ); 11 // If IE event model is used 12 } else if ( document.attachEvent ) { 13 // ensure firing before onload, 14 // maybe late but safe also for iframes 15 document.attachEvent("onreadystatechange", function(){ 16 if ( document.readyState === "complete" ) { 17 document.detachEvent( "onreadystatechange", arguments.callee ); 18 jQuery.ready(); 19 } 20 }); 21 // If IE and not an iframe 22 // continually check to see if the document is ready 23 if ( document.documentElement.doScroll && typeof window.frameElement === "undefined" ) (function(){ 24 if ( jQuery.isReady ) return; 25 try { 26 // If IE is used, use the trick by Diego Perini 27 // http://javascript.nwbox.com/IEContentLoaded/ 28 document.documentElement.doScroll("left"); 29 } catch( error ) { 30 setTimeout( arguments.callee, 0 ); 31 return; 32 } 33 // and execute any waiting functions 34 jQuery.ready(); 35 })(); 36 } 37 // A fallback to window.onload, that will always work 38 jQuery.event.add( window, "load", jQuery.ready ); 39 }
複製代碼

實現思路如下:

  1. 將Webkit與Firefox同等對待,都是直接註冊DOMContentLoaded事件,但是由於Webkit是在525以上版本才引入的,因此存在兼容性的隱患。
  2. 對於IE,首先註冊document的onreadystatechange事件,經測試,該方式與window.onload相當,依然會等到所有資源下載完畢後才觸發。
  3. 之後,判斷如果是IE並且頁面不在iframe當中,則通過setTiemout來不斷的調用documentElement的doScroll方法,直到調用成功則出觸發DOMContentLoaded

jQuery對於IE的解決方案,使用了一種新的方法,該方法源自http://javascript.nwbox.com/IEContentLoaded/。 它的原理是,在IE下,DOM的某些方法只有在DOM解析完成後纔可以調用,doScroll就是這樣一個方法,反過來當能調用doScroll的時候即 是DOM解析完成之時,與prototype中的document.write相比,該方案可以解決頁面有iframe時失效的問題。此外,jQuery 似乎擔心當頁面處於iframe中時,該方法會失效,因此實現代碼中做了判斷,如果是在iframe中則通過document的 onreadystatechange來實現,否則通過doScroll來實現。不過經測試,即使是在iframe中,doScroll依然有效。

三、Moontools

複製代碼
1 (function(){ 2 var domready = function(){ 3 if (Browser.loaded) return; 4 Browser.loaded = true; 5 window.fireEvent('domready'); 6 document.fireEvent('domready'); 7 }; 8 if (Browser.Engine.trident){ 9 var temp = document.createElement('div'); 10 (function(){ 11 ($try(function(){ 12 temp.doScroll('left'); 13 return $(temp).inject(document.body).set('html', 'temp').dispose(); 14 })) ? domready() : arguments.callee.delay(50); 15 })(); 16 } else if (Browser.Engine.webkit && Browser.Engine.version < 525){ 17 (function(){ 18 (['loaded', 'complete'].contains(document.readyState)) ? domready() : arguments.callee.delay(50); 19 })(); 20 } else { 21 window.addEvent('load', domready); 22 document.addEvent('DOMContentLoaded', domready); 23 } 24 })();
複製代碼

實現思路如下:

  1. 如果是IE則使用doScroll方法來實現。
  2. 如果是小於525版本的Webkit則通過輪詢document.readyState來實現。
  3. 其他的(FF/Webkit高版/Opera)則直接註冊DOMContentLoaded事件

Moontools的實現方案prototype和jQeury中的綜合體,對webkit做了版本判斷則使得該方案更加的健壯。在doScroll的實現方面,與jQuery相比,這裏是新建了一個div元素,並且在使用完畢後進行銷燬,而jQuery則直接使用了documentElement的 doScroll來檢測,更簡單高效一些。

四、Dojo

複製代碼
1 // START DOMContentLoaded 2 // Mozilla and Opera 9 expose the event we could use 3 if(document.addEventListener){ 4 // NOTE: 5 // due to a threading issue in Firefox 2.0, we can't enable 6 // DOMContentLoaded on that platform. For more information, see: 7 // http://trac.dojotoolkit.org/ticket/1704 8 if(dojo.isOpera || dojo.isFF >= 3 || (dojo.isMoz && dojo.config.enableMozDomContentLoaded === true)){ 9 document.addEventListener("DOMContentLoaded", dojo._loadInit, null); 10 } 11 // mainly for Opera 8.5, won't be fired if DOMContentLoaded fired already. 12 // also used for Mozilla because of trac #1640 13 window.addEventListener("load", dojo._loadInit, null); 14 } 15 if(dojo.isAIR){ 16 window.addEventListener("load", dojo._loadInit, null); 17 }else if(/(WebKit|khtml)/i.test(navigator.userAgent)){ // sniff 18 dojo._khtmlTimer = setInterval(function(){ 19 if(/loaded|complete/.test(document.readyState)){ 20 dojo._loadInit(); // call the onload handler 21 } 22 }, 10); 23 } 24 // END DOMContentLoaded 25 26 (function(){ 27 var _w = window; 28 var _handleNodeEvent = function(/*String*/evtName, /*Function*/fp){ 29 // summary: 30 // non-destructively adds the specified function to the node's 31 // evtName handler. 32 // evtName: should be in the form "onclick" for "onclick" handlers. 33 // Make sure you pass in the "on" part. 34 var oldHandler = _w[evtName] || function(){}; 35 _w[evtName] = function(){ 36 fp.apply(_w, arguments); 37 oldHandler.apply(_w, arguments); 38 }; 39 }; 40 if(dojo.isIE){ 41 // for Internet Explorer. readyState will not be achieved on init 42 // call, but dojo doesn't need it however, we'll include it 43 // because we don't know if there are other functions added that 44 // might. Note that this has changed because the build process 45 // strips all comments -- including conditional ones. 46 if(!dojo.config.afterOnLoad){ 47 document.write('<scr'+'ipt defer="" src="//:" +="" onreadystatechange="if(this.readyState==\'complete\'){' + dojo._scopeName + '._loadInit();}">' 48 + '</scr'+'ipt>' 49 ); 50 } 51 try{ 52 document.namespaces.add("v","urn:schemas-microsoft-com:vml"); 53 document.createStyleSheet().addRule("v\\:*", "behavior:url(#default#VML)"); 54 }catch(e){} 55 } 56 // FIXME: dojo.unloaded requires dojo scope, so using anon function wrapper. 57 _handleNodeEvent("onbeforeunload", function() { 58 dojo.unloaded(); 59 }); 60 _handleNodeEvent("onunload", function() { 61 dojo.windowUnloaded(); 62 }); 63 })();
複製代碼

實現思路如下:

  1. 如果是Opera或FF3以上版本則直接註冊DOMContentLoaded<事件,爲保險起見,同時也註冊了window.onload事件。
  2.  對於webkit則通過輪詢document.readyState來實現。
  3.  如果是Air則只註冊widnow.onload事件。
  4. 如果是IE則通過往頁面寫帶defer屬性的script並註冊其onreadystatechange事件來實現。

Dojo在IE下的實現方案同樣無法解決iframe的問題,而由於在FF2 下會有一個非常奇怪的Bug,因此默認只在FF3以上版本上使用DOMContentLoaded事件,同時又給了一個配置 -dojo.config.enableMozDomContentLoaded,如果在FF下將該配置設置爲true則依然會使用 DOMContentLoaded來實現,這一點充分考慮到了靈活性。對於webkit的實現,與prototype一樣有優化的空間。

五、YUI

複製代碼
1 (function() { 2 /*! DOMReady: based on work by: Dean Edwards/John Resig/Matthias Miller */ 3 // Internet Explorer: use the readyState of a defered script. 4 // This isolates what appears to be a safe moment to manipulate 5 // the DOM prior to when the document's readyState suggests 6 // it is safe to do so. 7 if (EU.isIE) { 8 // Process onAvailable/onContentReady items when the 9 // DOM is ready. 10 YAHOO.util.Event.onDOMReady( 11 YAHOO.util.Event._tryPreloadAttach, 12 YAHOO.util.Event, true); 13 var n = document.createElement('p'); 14 EU._dri = setInterval(function() { 15 try { 16 // throws an error if doc is not ready 17 n.doScroll('left'); 18 clearInterval(EU._dri); 19 EU._dri = null; 20 EU._ready(); 21 n = null; 22 } catch (ex) { 23 } 24 }, EU.POLL_INTERVAL); 25 // The document's readyState in Safari currently will 26 // change to loaded/complete before images are loaded. 27 } else if (EU.webkit && EU.webkit < 525) { 28 EU._dri = setInterval(function() { 29 var rs=document.readyState; 30 if ("loaded" == rs || "complete" == rs) { 31 clearInterval(EU._dri); 32 EU._dri = null; 33 EU._ready(); 34 } 35 }, EU.POLL_INTERVAL); 36 // FireFox and Opera: These browsers provide a event for this 37 // moment. The latest WebKit releases now support this event. 38 } else { 39 EU._simpleAdd(document, "DOMContentLoaded", EU._ready); 40 } 41 ///////////////////////////////////////////////////////////// 42 EU._simpleAdd(window, "load", EU._load); 43 EU._simpleAdd(window, "unload", EU._unload); 44 EU._tryPreloadAttach(); 45 })();
複製代碼

實現思路與Moontools一樣

六、EXT

複製代碼
1 function initDocReady(){ 2 var COMPLETE = "complete"; 3 docReadyEvent = new Ext.util.Event(); 4 if (Ext.isGecko || Ext.isOpera) { 5 DOC.addEventListener(DOMCONTENTLOADED, fireDocReady, false); 6 } else if (Ext.isIE){ 7 DOC.write("<script id=" + IEDEFERED + " defer=defer src='/%27+%27/:'></script>"); 8 DOC.getElementById(IEDEFERED).onreadystatechange = function(){ 9 if(this.readyState == COMPLETE){ 10 fireDocReady(); 11 } 12 }; 13 } else if (Ext.isWebKit){ 14 docReadyProcId = setInterval(function(){ 15 if(DOC.readyState == COMPLETE) { 16 fireDocReady(); 17 } 18 }, 10); 19 } 20 // no matter what, make sure it fires on load 21 E.on(WINDOW, "load", fireDocReady); 22 }
複製代碼

實現思路與Dojo的一致,不再贅訴。

總結

總結各大主流框架的做法,寫了以下這個版本。主要是儘量的做到優化並考慮到FF2下的Bug,提供一個是否使用DOMContentLoaded的開關配置。

複製代碼
1 /* 2 * 註冊瀏覽器的DOMContentLoaded事件 3 * @param { Function } onready [必填]在DOMContentLoaded事件觸發時需要執行的函數 4 * @param { Object } config [可選]配置項 5 */ 6 function onDOMContentLoaded(onready,config){ 7 //瀏覽器檢測相關對象,在此爲節省代碼未實現,實際使用時需要實現。 8 //var Browser = {}; 9 //設置是否在FF下使用DOMContentLoaded(在FF2下的特定場景有Bug) 10 this.conf = { 11 enableMozDOMReady:true 12 }; 13 if( config ) 14 for( var p in config) 15 this.conf[p] = config[p]; 16 var isReady = false; 17 function doReady(){ 18 if( isReady ) return; 19 //確保onready只執行一次 20 isReady = true; 21 onready(); 22 } 23 /*IE*/ 24 if( Browser.ie ){ 25 (function(){ 26 if ( isReady ) return; 27 try { 28 document.documentElement.doScroll("left"); 29 } catch( error ) { 30 setTimeout( arguments.callee, 0 ); 31 return; 32 } 33 doReady(); 34 })(); 35 window.attachEvent('onload',doReady); 36 } 37 /*Webkit*/ 38 else if (Browser.webkit && Browser.version < 525){ 39 (function(){ 40 if( isReady ) return; 41 if (/loaded|complete/.test(document.readyState)) 42 doReady(); 43 else 44 setTimeout( arguments.callee, 0 ); 45 })(); 46 window.addEventListener('load',doReady,false); 47 } 48 /*FF Opera 高版webkit 其他*/ 49 else{ 50 if( !Browser.ff || Browser.version != 2 || this.conf.enableMozDOMReady) 51 document.addEventListener( "DOMContentLoaded", function(){ 52 document.removeEventListener( "DOMContentLoaded", arguments.callee, false ); 53 doReady(); 54 }, false ); 55 window.addEventListener('load',doReady,false); 56 } 57 }
複製代碼

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章