實際開發中經常遇到這樣的場景:頁面加載完成後再去做一些事情,比如綁定事件、操作某些節點。
早期最常用的做法是 window 的 onload 事件,但它的觸發時機偏晚——必須等頁面解析完成、DOM 樹建立完成,並且圖片、腳本、樣式表甚至 iframe 中的所有資源都下載完畢之後才會觸發。對很多應用來說這實在太「遲」了,直接影響用戶體驗。
為了解決這個問題,Firefox 率先提供了 DOMContentLoaded 事件。與 onload 相比它觸發得更早:頁面的 DOM 內容加載完成即觸發,無需等待其他資源。Webkit 從 525 版本(2008 年初的 nightly 構建)開始也引入了該事件,Opera 同樣支持。而彼時的主流 IE 仍然沒有要添加的意思。
IE 下沒有原生支持,但總有變通辦法。下面對比幾大主流框架的兼容方案,涉及 Prototype、jQuery、MooTools、Dojo、YUI 與 Ext。
(function() {
var timer;
function fireContentLoadedEvent() {
if (document.loaded) return;
if (timer) window.clearInterval(timer);
document.fire("dom:loaded");
document.loaded = true;
}
if (document.addEventListener) {
if (Prototype.Browser.WebKit) {
// Webkit:輪詢 readyState
timer = window.setInterval(function() {
if (/loaded|complete/.test(document.readyState)) fireContentLoadedEvent();
}, 0);
Event.observe(window, "load", fireContentLoadedEvent);
} else {
document.addEventListener("DOMContentLoaded", fireContentLoadedEvent, false);
}
} else {
// IE:寫入帶 defer 的 script,以其加載完成作為觸發時機
document.write("<" + "script id=__onDOMContentLoaded defer src=//:><\/script>");
$("__onDOMContentLoaded").onreadystatechange = function() {
if (this.readyState == "complete") {
this.onreadystatechange = null;
fireContentLoadedEvent();
}
};
}
})();
實現思路:Webkit 下輪詢 document.readyState,值為 loaded 或 complete 時觸發,並掛一份到 window.onload 保險;Firefox 直接註冊 DOMContentLoaded;IE 則用 document.write 插入帶 defer 屬性的 script,把該腳本的加載完成視為 DOM 就緒。
問題:一是 document.write + defer 的方案在頁面含 iframe 時,會等 iframe 內容加載完才觸發,和 onload 差別不大;二是 Webkit 525 以上已原生支持,仍走輪詢顯得多餘,有優化空間。
function bindReady() {
if (readyBound) return;
readyBound = true;
if (document.addEventListener) {
// 支持 DOMContentLoaded 的瀏覽器
document.addEventListener("DOMContentLoaded", function() {
document.removeEventListener("DOMContentLoaded", arguments.callee, false);
jQuery.ready();
}, false);
} else if (document.attachEvent) {
// IE:先掛 onreadystatechange
document.attachEvent("onreadystatechange", function() {
if (document.readyState === "complete") {
document.detachEvent("onreadystatechange", arguments.callee);
jQuery.ready();
}
});
// 非 iframe 場景下,用 doScroll 探測
if (document.documentElement.doScroll && typeof window.frameElement === "undefined") {
(function() {
if (jQuery.isReady) return;
try {
document.documentElement.doScroll("left");
} catch (error) {
setTimeout(arguments.callee, 0);
return;
}
jQuery.ready();
})();
}
}
// 兜底:window.onload
jQuery.event.add(window, "load", jQuery.ready);
}
實現思路:把 Webkit 與 Firefox 同等對待,直接註冊 DOMContentLoaded(存在舊版 Webkit 的兼容隱患);IE 下先掛 onreadystatechange(實測與 onload 差不多,仍要等資源),再判斷若非 iframe 則用 setTimeout 反覆嘗試調用 doScroll,一旦成功即說明 DOM 已解析完成。
價值:doScroll 這個技巧(源自 Diego Perini 的方案)巧妙的點在於,IE 下 DOM 的某些方法只有在解析完成後才能調用,反過來「能調用」就等於「已就緒」,相比 document.write 徹底解決了 iframe 失效的問題。
(function() {
var domready = function() {
if (Browser.loaded) return;
Browser.loaded = true;
window.fireEvent('domready');
document.fireEvent('domready');
};
if (Browser.Engine.trident) {
// IE:doScroll 探測
var temp = document.createElement('div');
(function() {
($try(function() {
temp.doScroll('left');
return $(temp).inject(document.body).set('html', 'temp').dispose();
})) ? domready() : arguments.callee.delay(50);
})();
} else if (Browser.Engine.webkit && Browser.Engine.version < 525) {
// 舊版 Webkit:輪詢 readyState
(function() {
(['loaded', 'complete'].contains(document.readyState)) ? domready() : arguments.callee.delay(50);
})();
} else {
window.addEvent('load', domready);
document.addEvent('DOMContentLoaded', domready);
}
})();
// Mozilla / Opera 9 可直接使用原生事件
if (document.addEventListener) {
// 注意:Firefox 2.0 存在線程問題,預設不在該平台啟用
if (dojo.isOpera || dojo.isFF >= 3 ||
(dojo.isMoz && dojo.config.enableMozDomContentLoaded === true)) {
document.addEventListener("DOMContentLoaded", dojo._loadInit, null);
}
window.addEventListener("load", dojo._loadInit, null);
}
if (/(WebKit|khtml)/i.test(navigator.userAgent)) {
// Webkit:輪詢 readyState
dojo._khtmlTimer = setInterval(function() {
if (/loaded|complete/.test(document.readyState)) {
dojo._loadInit();
}
}, 10);
}
實現思路:Opera 與 FF3 以上直接註冊 DOMContentLoaded,同時掛 onload 保險;Webkit 輪詢 readyState;Air 只掛 onload;IE 則寫入帶 defer 的 script 並註冊其 onreadystatechange。
Dojo 在 IE 下的方案同樣無法解決 iframe 問題;而由於 FF2 下有奇怪的 Bug,預設只在 FF3 以上啟用 DOMContentLoaded,同時提供了 dojo.config.enableMozDomContentLoaded 開關,需要時可在 FF 下強制開啟,靈活性考慮得不錯。
if (EU.isIE) {
// IE:用 defer script 的 readyState,或 doScroll 探測
var n = document.createElement('p');
EU._dri = setInterval(function() {
try {
n.doScroll('left');
clearInterval(EU._dri);
EU._dri = null;
EU._ready();
n = null;
} catch (ex) { }
}, EU.POLL_INTERVAL);
} else if (EU.webkit && EU.webkit < 525) {
// 舊版 Safari:readyState 會先於圖片變成 loaded/complete
EU._dri = setInterval(function() {
var rs = document.readyState;
if ("loaded" == rs || "complete" == rs) {
clearInterval(EU._dri);
EU._dri = null;
EU._ready();
}
}, EU.POLL_INTERVAL);
} else {
// Firefox、Opera 與新版 Webkit
EU._simpleAdd(document, "DOMContentLoaded", EU._ready);
}
EU._simpleAdd(window, "load", EU._load);
EU._simpleAdd(window, "unload", EU._unload);
思路與 MooTools 基本一致:按瀏覽器分三支,IE 用 doScroll,舊 Webkit 用輪詢,其餘直接監聽原生事件。
function initDocReady() {
var COMPLETE = "complete";
docReadyEvent = new Ext.util.Event();
if (Ext.isGecko || Ext.isOpera) {
DOC.addEventListener(DOMCONTENTLOADED, fireDocReady, false);
} else if (Ext.isIE) {
DOC.write("<s" + 'cript id="' + IEDEFERED + '" defer="defer" src="/' + '/:"></s' + 'cript>');
DOC.getElementById(IEDEFERED).onreadystatechange = function() {
if (this.readyState == COMPLETE) fireDocReady();
};
} else if (Ext.isWebKit) {
docReadyProcId = setInterval(function() {
if (DOC.readyState == COMPLETE) fireDocReady();
}, 10);
}
// 無論如何都要在 load 時兜底觸發
E.on(WINDOW, "load", fireDocReady);
}
實現思路與 Dojo 一致,此處不再贅述。
綜合以上做法,寫了下面這個版本,重點是盡量優化,同時考慮 FF2 的 Bug,並提供一個是否使用 DOMContentLoaded 的開關:
function onDOMContentLoaded(onready, config) {
// 瀏覽器檢測對象,此處為節省篇幅未實現,實際使用時需自行補全
// var Browser = {};
// 是否在 FF 下使用 DOMContentLoaded(FF2 特定場景有 Bug)
this.conf = { enableMozDOMReady: true };
if (config) for (var p in config) this.conf[p] = config[p];
var isReady = false;
function doReady() {
if (isReady) return; // 確保 onready 只執行一次
isReady = true;
onready();
}
if (Browser.ie) {
// IE:doScroll 探測
(function() {
if (isReady) return;
try {
document.documentElement.doScroll("left");
} catch (error) {
setTimeout(arguments.callee, 0);
return;
}
doReady();
})();
window.attachEvent('onload', doReady);
} else if (Browser.webkit && Browser.version < 525) {
// 舊版 Webkit:輪詢 readyState
(function() {
if (isReady) return;
if (/loaded|complete/.test(document.readyState)) doReady();
else setTimeout(arguments.callee, 0);
})();
window.addEventListener('load', doReady, false);
} else {
// 其餘:直接用原生事件,FF2 可通過配置關閉
if (!Browser.ff || Browser.version != 2 || this.conf.enableMozDOMReady) {
document.addEventListener("DOMContentLoaded", function() {
document.removeEventListener("DOMContentLoaded", arguments.callee, false);
doReady();
}, false);
}
window.addEventListener('load', doReady, false);
}
}
以上就是 JS 中 DOMReady 事件六種實現方案的總結。值得一提的是,如今 IE8 及更早版本已基本退出歷史舞台,直接監聽 DOMContentLoaded 並用 load 兜底即可,上面這些兼容技巧主要作為原理理解保留。
希望對大家有所幫助。