在实际应用中,我们经常会遇到这样的场景,当页面加载完成后去做一些事情:绑定事件、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
实现代码
(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) {
timer = window.setinterval(function() {
if (/loaded|complete/.test(document.readystate))
firecontentloadedevent();
}, 0);
event.observe(window, "load", firecontentloadedevent);
} else {
document.addeventlistener("domcontentloaded",
firecontentloadedevent, false);
}
} else {
document.write("<"+"script id=__ondomcontentloaded defer src=//:><\/script>");
$("__ondomcontentloaded").onreadystatechange = function() {
if (this.readystate == "complete") {
this.onreadystatechange = null;
firecontentloadedevent();
}
};
}
})();
实现思路如下:
如果是webkit则轮询document的readystate属性,如果该属性的值为loaded或complete则触发domcontentloaded事件,为保险起见,将该事件注册到window.onload上。
如果是ff则直接注册domcontentloaded事件。
如果是ie则使用document.write往页面中加入一个script元素,并设置defer属性,最后是把该脚本的加载完成视作domcontentloaded事件来触发。
该实现方式的问题主要有两点:第一、通过document.write写script并设置defer的方法在页面包含iframe的情况下,会等到 iframe内的内容加载完后才触发,这与onload没有太大的区别;第二、webkit在525以上的版本引入了domcontentloaded方法,因此在这些版本中无需再通过轮询来实现,可以优化。
二、jquery
function bindready(){
if ( readybound ) return;
readybound = true;
// mozilla, opera and webkit nightlies currently support this event
if ( document.addeventlistener ) {
// use the handy event callback
document.addeventlistener( "domcontentloaded", function(){
document.removeeventlistener( "domcontentloaded", arguments.callee, false );
jquery.ready();
}, false );
// if ie event model is used
} else if ( document.attachevent ) {
// ensure firing before onload,
// maybe late but safe also for iframes
document.attachevent("onreadystatechange", function(){
if ( document.readystate === "complete" ) {
document.detachevent( "onreadystatechange", arguments.callee );
jquery.ready();
}
});
// if ie and not an iframe
// continually check to see if the document is ready
if ( document.documentelement.doscroll && typeof window.frameelement === "undefined" ) (function(){
if ( jquery.isready ) return;
try {
// if ie is used, use the trick by diego perini
// http://javascript.nwbox.com/iecontentloaded/
document.documentelement.doscroll("left");
} catch( error ) {
settimeout( arguments.callee, 0 );
return;
}
// and execute any waiting functions
jquery.ready();
})();
}
// a fallback to window.onload, that will always work
jquery.event.add( window, "load", jquery.ready );
}
实现思路如下:
将webkit与firefox同等对待,都是直接注册domcontentloaded事件,但是由于webkit是在525以上版本才引入的,因此存在兼容性的隐患。
对于ie,首先注册document的onreadystatechange事件,经测试,该方式与window.onload相当,依然会等到所有资源下载完毕后才触发。
之后,判断如果是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
(function(){
var domready = function(){
if (browser.loaded) return;
browser.loaded = true;
window.fireevent('domready');
document.fireevent('domready');
};
if (browser.engine.trident){
var temp = document.createelement_x('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){
(function(){
(['loaded', 'complete'].contains(document.readystate)) ? domready() : arguments.callee.delay(50);
})();
} else {
window.addevent('load', domready);
document.addevent('domcontentloaded', domready);
}
})();
四、dojo
// start domcontentloaded
// mozilla and opera 9 expose the event we could use
if(document.addeventlistener){
// note:
// due to a threading issue in firefox 2.0, we can't enable
// domcontentloaded on that platform. for more information, see:
// http://trac.dojotoolkit.org/ticket/1704
if(dojo.isopera || dojo.isff >= 3 || (dojo.ismoz && dojo.config.enablemozdomcontentloaded === true)){
document.addeventlistener("domcontentloaded", dojo._loadinit, null);
}
// mainly for opera 8.5, won't be fired if domcontentloaded fired already.
// also used for mozilla because of trac #1640
window.addeventlistener("load", dojo._loadinit, null);
}
if(dojo.isair){
window.addeventlistener("load", dojo._loadinit, null);
}else if(/(webkit|khtml)/i.test(navigator.useragent)){ // sniff
dojo._khtmltimer = setinterval(function(){
if(/loaded|complete/.test(document.readystate)){
dojo._loadinit(); // call the onload handler
}
}, 10);
}
// end domcontentloaded
}
(function(){
var _w = window;
var _handlenodeevent = function(evtname, fp){
// summary:
// non-destructively adds the specified function to the node's
// evtname handler.
// evtname: should be in the form "onclick" for "onclick" handlers.
// make sure you pass in the "on" part.
var oldhandler = _w[evtname] || function(){};
_w[evtname] = function(){
fp.apply(_w, arguments);
oldhandler.apply(_w, arguments);
};
};
if(dojo.isie){
// for internet explorer. readystate will not be achieved on init
// call, but dojo doesn't need it however, we'll include it
// because we don't know if there are other functions added that
// might. note that this has changed because the build process
// strips all comments -- including conditional ones.
if(!dojo.config.afteronload){
document.write('<scr'+'ipt defer="" src="//:" +="" onreadystatechange="if(this.readystate==\'complete\'){' +
dojo._scopename + '._loadinit();}">'
+ '</scr'+'ipt>'
);
}
try{
document.namespaces.add("v","urn:schemas-microsoft-com:vml");
document.createstylesheet().addrule("v\\:*", "behavior:url(#default#vml)");
}catch(e){}
}
// fixme: dojo.unloaded requires dojo scope, so using anon function wrapper.
_handlenodeevent("onbeforeunload", function() { dojo.unloaded(); });
_handlenodeevent("onunload", function() { dojo.windowunloaded(); });
})();
实现思路如下:
如果是opera或ff3以上版本则直接注册domcontentloaded<事件,为保险起见,同时也注册了window.onload事件。
对于webkit则通过轮询document.readystate来实现。
如果是air则只注册widnow.onload事件。
如果是ie则通过往页面写带defer属性的script并注册其onreadystatechange事件来实现。
dojo在ie下的实现方案同样无法解决iframe的问题,而由于在ff2 下会有一个非常奇怪的bug,因此默认只在ff3以上版本上使用domcontentloaded事件,同时又给了一个配置 -dojo.config.enablemozdomcontentloaded,如果在ff下将该配置设置为true则依然会使用 domcontentloaded来实现,这一点充分考虑到了灵活性。对于webkit的实现,与prototype一样有优化的空间。
五、yui
// internet explorer: use the readystate of a defered script.
// this isolates what appears to be a safe moment to manipulate
// the dom prior to when the document's readystate suggests
// it is safe to do so.
if (eu.isie) {
// process onavailable/oncontentready items when the
// dom is ready.
yahoo.util.event.ondomready(
yahoo.util.event._trypreloadattach,
yahoo.util.event, true);
var n = document.createelement_x('p');
eu._dri = setinterval(function() {
try {
// throws an error if doc is not ready
n.doscroll('left');
clearinterval(eu._dri);
eu._dri = null;
eu._ready();
n = null;
} catch (ex) {
}
}, eu.poll_interval);
// the document's readystate in safari currently will
// change to loaded/complete before images are loaded.
} else if (eu.webkit && eu.webkit < 525) {
eu._dri = setinterval(function() {
var rs=document.readystate;
if ("loaded" == rs || "complete" == rs) {
clearinterval(eu._dri);
eu._dri = null;
eu._ready();
}
}, eu.poll_interval);
// firefox and opera: these browsers provide a event for this
// moment. the latest webkit releases now support this event.
} else {
eu._simpleadd(document, "domcontentloaded", eu._ready);
}
/////////////////////////////////////////////////////////////
eu._simpleadd(window, "load", eu._load);
eu._simpleadd(window, "unload", eu._unload);
eu._trypreloadattach();
})();
实现思路与moontools一样
六、ext
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);
}
// no matter what, make sure it fires on 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 ){
(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){
(function(){
if( isready ) return;
if (/loaded|complete/.test(document.readystate))
doready();
else
settimeout( arguments.callee, 0 );
})();
window.addeventlistener('load',doready,false);
}
else{
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事件的六种实现方法总结就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持。
更多jsdomready事件的六种实现方法总结。