主流JS框架中DOMReady事件的实现

以你之姓@ 2022-05-18 02:27 104阅读 0赞

<table> 
 <tbody> 
  <tr> 
   <td> <p>在实际应用中，我们经常会遇到这样的场景，当页面加载完成后去做一些事情：<a href="http://www.popo4j.com/tag/bind.html" rel="nofollow">绑定事件</a>、<a href="http://www.popo4j.com/tag/DOM.html" rel="nofollow">DOM</a>操作某些结点等。原来比较常用的是window的onload&nbsp;<a href="http://www.popo4j.com/tag/ShiJian.html" rel="nofollow">事件</a>，而该事件的实际效果是：当页面解析/DOM树建立完成，并完成了诸如图片、脚本、样式表甚至是iframe中所有资源的下载后才触发的。这对于很多 实际的应用而言有点太“迟”了，比较影响用户体验。为了解决这个问题，<a href="http://www.popo4j.com/tag/ff.html" rel="nofollow">ff</a>中便增加了一个DOMContentLoaded方法，与onload相比，该 方法触发的时间更早，它是在页面的DOM内容加载完成后即触发，而无需等待<a href="http://www.popo4j.com/tag/QiTa.html" rel="nofollow">其他</a>资源的加载。Webkit引擎从版本525（Webkit nightly 1/2008:525+）开始也引入了该事件，Opera中也包含该方法。到目前为止主<a href="http://www.popo4j.com/tag/Liu.html" rel="nofollow">流</a>的IE仍然没有要添加的意思。虽然IE下没有，但总是有解决办法 的，下文对比了一下几大主流框架对于该事件的兼容性版本实现方案，涉及的框架包括：</p> 
    <ol> 
     <li>Prototype</li> 
     <li>jQeury</li> 
     <li>moontools</li> 
     <li>dojo</li> 
     <li>yui</li> 
     <li>ext</li> 
    </ol><h3>一、Prototype</h3> <pre><code>(function() {
    /* Support for the DOMContentLoaded event is based on work by Dan Webb,
Matthias Miller, Dean Edwards and John Resig. */
    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("&lt;"+"script id=__onDOMContentLoaded defer src=//:&gt;&lt;\/script&gt;");
        $("__onDOMContentLoaded").onreadystatechange = function() {
            if (this.readyState == "complete") {
                this.onreadystatechange = null;
                fireContentLoadedEvent();
            }
        };
    }
})();</code></pre> <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td> <p>实现思路如下：</p> 
    <ol> 
     <li>如果是webkit则轮询document的readyState属性，如果该属性的值为loaded或complete则触发DOMContentLoaded事件，为保险起见，将该事件注册到window.onload上。</li> 
     <li>如果是FF则直接注册DOMContentLoaded事件。</li> 
     <li>如果是IE则使用document.write往页面中加入一个script元素，并设置defer属性，最后是把该脚本的加载完成视作DOMContentLoaded事件来触发。</li> 
    </ol><p>该实现方式的问题主要有两点：第一、通过document.write写script并设置defer的方法在页面包含iframe的情况下，会等到 iframe内的<a href="http://www.popo4j.com/tag/NeiRong.html" rel="nofollow">内容</a>加载完后才触发，这与onload没有太大的区别；第二、Webkit在525以上的版本引入了DOMContentLoaded方 法，因此在这些版本中无需再通过轮询来实现，可以优化。</p> <h3>二、jQuery</h3> <pre><code>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 &amp;&amp; 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 );
}</code></pre> <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td> <p>实现思路如下：</p> 
    <ol> 
     <li>将Webkit与Firefox同等对待，都是直接注册DOMContentLoaded事件，但是由于Webkit是在525以上版本才引入的，因此存在兼容性的隐患。</li> 
     <li>对于IE，首先注册document的onreadystatechange事件，经<a href="http://www.popo4j.com/tag/CeShi.html" rel="nofollow">测试</a>，该方式与window.onload相当，依然会等到所有资源下载完毕后才触发。</li> 
     <li>之后，判断如果是IE并且页面不在iframe当中，则通过setTiemout来不断的调用documentElement的doScroll方法，直到调用成功则出触发DOMContentLoaded</li> 
    </ol><p><a href="http://www.popo4j.com/tag/jQuery.html" rel="nofollow">jQuery</a>对于IE的解决方案，使用了一种新的方法，该方法源自<a href="http://javascript.nwbox.com/IEContentLoaded/" rel="nofollow">http://javascript.nwbox.com/IEContentLoaded/</a>。 它的原理是，在IE下，DOM的某些方法只有在DOM解析完成后才可以调用，doScroll就是这样一个方法，反过来当能调用doScroll的时候即 是DOM解析完成之时，与<a href="http://www.popo4j.com/tag/prototype.html" rel="nofollow">prototype</a>中的document.write相比，该方案可以解决页面有iframe时失效的问题。此外，jQuery 似乎担心当页面处于iframe中时，该方法会失效，因此实现代码中做了判断，如果是在iframe中则通过document的 onreadystatechange来实现，否则通过doScroll来实现。不过经测试，即使是在iframe中，doScroll依然有效。</p> <h3>三、Moontools</h3> <pre><code>(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('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 &amp;&amp; Browser.Engine.version &lt; 525){
        (function(){
            (['loaded', 'complete'].contains(document.readyState)) ? domready() : arguments.callee.delay(50);
        })();
    } else {
        window.addEvent('load', domready);
        document.addEvent('DOMContentLoaded', domready);
    }
})();</code></pre> <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td> <p>&nbsp;</p> <p>实现思路如下：</p> 
    <ol> 
     <li>如果是IE则使用doScroll方法来实现。</li> 
     <li>如果是小于525版本的Webkit则通过轮询document.readyState来实现。</li> 
     <li>其他的(FF/Webkit高版/Opera)则直接注册DOMContentLoaded事件</li> 
    </ol><p>Moontools的实现方案prototype和jQeury中的综合体，对webkit做了版本判断则使得该方案更加的健壮。在doScroll的实现方面，与jQuery相比，这里是新建了一个div元素，并且在使用完毕后进行销毁，而jQuery则直接使用了documentElement的 doScroll来检测，更简单高效一些。</p> <h3>四、Dojo</h3> <pre><code>// 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 &gt;= 3 || (dojo.isMoz &amp;&amp; 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

<table> 
 <tbody> 
  <tr> 
   <td> <p>&nbsp;</p> <p>实现思路与Dojo的一致，不再赘诉。</p> <h3>总结</h3> <p>总结各大主流框架的做法，写了以下这个版本。主要是尽量的做到优化并考虑到FF2下的Bug，提供一个是否使用DOMContentLoaded的开关配置。</p> </td> 
  </tr> 
 </tbody> 
</table>

/*
    * 注册浏览器的DOMContentLoaded事件
    * @param { Function } onready [必填]在DOMContentLoaded事件触发时需要执行的函数
    * @param { Object } config [可选]配置项
    */
    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();
        }
        /*IE*/
        if( Browser.ie ){
            (function(){
                if ( isReady ) return;
                try {
                    document.documentElement.doScroll("left");
                } catch( error ) {
                    setTimeout( arguments.callee, 0 );
                    return;
                }
                doReady();
            })();
            window.attachEvent('onload',doReady);
        }
        /*Webkit*/
        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);
        }
        /*FF Opera 高版webkit 其他*/
        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);
        }
    }