协慌网

登录 贡献 社区

纯 JavaScript 相当于 jQuery 的 $ .ready() - 如何在页面 / DOM 准备就绪时调用函数

好吧,这可能只是一个愚蠢的问题,但我确信还有很多其他人不时会问同样的问题。我,我只是想以任何方式 100%确定。有了 jQuery,我们都知道这很精彩

$('document').ready(function(){});

但是,假设我想运行一个用标准 JavaScript 编写的函数,没有库支持它,并且我想在页面准备好处理它时立即启动一个函数。什么是正确的方法来解决这个问题?

我知道我能做到:

window.onload="myFunction()";

... 或者我可以使用body标签:

<body onload="myFunction()">

... 或者我甚至可以在所有内容之后尝试在页面底部,但最终bodyhtml标记如:

<script type="text/javascript">
   myFunction();
</script>

什么是以 jQuery 的$.ready()方式发布一个或多个函数的跨浏览器(旧 / 新)兼容方法?

答案

在没有为您提供所有跨浏览器兼容性的框架的情况下,最简单的方法就是在正文末尾调用代码。这比onload处理程序执行起来更快,因为它只等待 DOM 准备就绪,而不是所有图像都要加载。而且,这适用于每个浏览器。

<html>
<head>
</head>
<body>
Your HTML here

<script>
// self executing function here
(function() {
   // your page initialization code here
   // the DOM will be available here

})();
</script>
</body>
</html>

如果你真的不想这样做,你需要跨浏览器兼容性,你不想等待window.onload ,那么你可能应该去看看像 jQuery 这样的框架如何实现它的$(document).ready()方法。根据浏览器的功能,它相当复杂。

为了让您了解 jQuery 的功能(在脚本标记放置的任何位置都可以使用)。

如果支持,它会尝试标准:

document.addEventListener('DOMContentLoaded', fn, false);

回落:

window.addEventListener('load', fn, false )

或者对于旧版本的 IE,它使用:

document.attachEvent("onreadystatechange", fn);

回落:

window.attachEvent("onload", fn);

并且,在 IE 代码路径中有一些我没有完全遵循的解决方法,但看起来它与帧有关。


以下是用简单的 javascript 编写的 jQuery 的.ready()的完全替代:

(function(funcName, baseObj) {
    // The public function name defaults to window.docReady
    // but you can pass in your own object and own function name and those will be used
    // if you want to put them in a different namespace
    funcName = funcName || "docReady";
    baseObj = baseObj || window;
    var readyList = [];
    var readyFired = false;
    var readyEventHandlersInstalled = false;

    // call this when the document is ready
    // this function protects itself against being called more than once
    function ready() {
        if (!readyFired) {
            // this must be set to true before we start calling callbacks
            readyFired = true;
            for (var i = 0; i < readyList.length; i++) {
                // if a callback here happens to add new ready handlers,
                // the docReady() function will see that it already fired
                // and will schedule the callback to run right after
                // this event loop finishes so all handlers will still execute
                // in order and no new ones will be added to the readyList
                // while we are processing the list
                readyList[i].fn.call(window, readyList[i].ctx);
            }
            // allow any closures held by these functions to free
            readyList = [];
        }
    }

    function readyStateChange() {
        if ( document.readyState === "complete" ) {
            ready();
        }
    }

    // This is the one public interface
    // docReady(fn, context);
    // the context argument is optional - if present, it will be passed
    // as an argument to the callback
    baseObj[funcName] = function(callback, context) {
        if (typeof callback !== "function") {
            throw new TypeError("callback for docReady(fn) must be a function");
        }
        // if ready has already fired, then just schedule the callback
        // to fire asynchronously, but right away
        if (readyFired) {
            setTimeout(function() {callback(context);}, 1);
            return;
        } else {
            // add the function and context to the list
            readyList.push({fn: callback, ctx: context});
        }
        // if document already ready to go, schedule the ready function to run
        if (document.readyState === "complete") {
            setTimeout(ready, 1);
        } else if (!readyEventHandlersInstalled) {
            // otherwise if we don't have event handlers installed, install them
            if (document.addEventListener) {
                // first choice is DOMContentLoaded event
                document.addEventListener("DOMContentLoaded", ready, false);
                // backup is window load event
                window.addEventListener("load", ready, false);
            } else {
                // must be IE
                document.attachEvent("onreadystatechange", readyStateChange);
                window.attachEvent("onload", ready);
            }
            readyEventHandlersInstalled = true;
        }
    }
})("docReady", window);

最新版本的代码在 GitHub 上公开共享, 网址https://github.com/jfriend00/docReady

用法:

// pass a function reference
docReady(fn);

// use an anonymous function
docReady(function() {
    // code here
});

// pass a function reference and a context
// the context will be passed to the function as the first argument
docReady(fn, context);

// use an anonymous function with a context
docReady(function(context) {
    // code here that can use the context argument that was passed to docReady
}, ctx);

这已经过测试:

IE6 and up
Firefox 3.6 and up
Chrome 14 and up
Safari 5.1 and up
Opera 11.6 and up
Multiple iOS devices
Multiple Android devices

工作实施和试验台: http//jsfiddle.net/jfriend00/YfD3C/


以下是其工作原理的摘要:

  1. 创建一个IIFE (立即调用的函数表达式),这样我们就可以拥有非公共状态变量。
  2. 声明一个公共函数docReady(fn, context)
  3. docReady(fn, context) ,检查 ready 处理程序是否已经触发。如果是这样,只需在 JS 的这个线程完成后使用setTimeout(fn, 1)安排新添加的回调。
  4. 如果尚未触发就绪处理程序,则将此新回调添加到稍后要调用的回调列表中。
  5. 检查文档是否已准备好。如果是,请执行所有就绪处理程序。
  6. 如果我们尚未安装事件侦听器但尚未知道文档何时就绪,请立即安装它们。
  7. 如果document.addEventListener存在,则使用.addEventListener()"DOMContentLoaded""load"事件安装事件处理程序。 “加载” 是安全的备份事件,不应该需要。
  8. 如果document.addEventListener不存在,则使用.attachEvent()"onreadystatechange""onload"事件安装事件处理程序。
  9. onreadystatechange事件中,检查document.readyState === "complete" ,如果是,则调用函数来触发所有就绪处理程序。
  10. 在所有其他事件处理程序中,调用函数来触发所有准备好的处理程序。
  11. 在调用所有就绪处理程序的函数中,检查一个状态变量以查看我们是否已经触发了。如果我们有,什么也不做。如果我们还没有被调用,那么循环遍历 ready 函数数组并按照它们被添加的顺序调用每个函数。设置一个标志以指示这些都已被调用,因此它们永远不会被执行多次。
  12. 清除函数数组,以便释放它们可能正在使用的任何闭包。

使用docReady()注册的处理程序将保证按其注册顺序触发。

如果在文档准备就绪后调用docReady(fn) ,则会在使用setTimeout(fn, 1)完成当前执行线程后立即执行回调。这允许调用代码总是假设它们是稍后将调用的异步回调,即使稍后在 JS 的当前线程完成并且它保留调用顺序之后。

我想在这里提到一些可能的方法以及适用于所有浏览器纯 javascript 技巧

// with jQuery 
$(document).ready(function(){ /* ... */ });

// shorter jQuery version 
$(function(){ /* ... */ });

// without jQuery (doesn't work in older IEs)
document.addEventListener('DOMContentLoaded', function(){ 
    // your code goes here
}, false);

// and here's the trick (works everywhere)
function r(f){/in/.test(document.readyState)?setTimeout('r('+f+')',9):f()}
// use like
r(function(){
    alert('DOM Ready!');
});

正如原作者所解释的,这里的技巧是我们正在检查document.readyState属性。如果它包含字符串in (如在uninitializedloading ,前两个DOM 就绪状态 5 分),我们设置了超时,并再次检查。否则,我们执行传递的函数。

这里是适用于所有浏览器的技巧的jsFiddle

感谢Tutorialzine将其纳入本书。

如果您正在使用没有 jQuery 的VANILLA普通JavaScript ,那么您必须使用(Internet Explorer 9 或更高版本):

document.addEventListener("DOMContentLoaded", function(event) {
    // Your code to run since DOM is loaded and ready
});

上面相当于 jQuery .ready

$(document).ready(function() {
    console.log("Ready!");
});

这也可以写成速记这样,这 jQuery 将就绪后运行,即使发生

$(function() {
    console.log("ready!");
});

不要与下面的混淆 (这不是为 DOM 做好准备):

不要使用像这样自行执行的IIFE

Example:

(function() {
   // Your page initialization code here  - WRONG
   // The DOM will be available here   - WRONG
})();

此 IIFE 不会等待您的 DOM 加载。 (我甚至在谈论最新版的 Chrome 浏览器!)