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

IT技术 javascript jquery html
2021-01-07 16:00:54

有了jQuery，我们都知道奇妙的.ready()功能：

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

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

我知道我可以做到：

window.onload="myFunction()";

或者我可以使用body标签：

<body onload="myFunction()">

或者我什至可以在所有内容之后尝试在页面底部，但结尾body或html标记如下：

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

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

6个回答

在没有为您完成所有跨浏览器兼容性的框架的情况下，最简单的事情就是在正文的末尾调用您的代码。这比onload处理程序执行速度更快，因为它只等待 DOM 准备就绪，而不是所有图像都加载完毕。而且，这适用于所有浏览器。

<!doctype html>
<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>

对于现代浏览器（IE9 及更新版本以及任何版本的 Chrome、Firefox 或 Safari），如果您希望能够实现$(document).ready()可以从任何地方调用的类似 jQuery 的方法（无需担心调用脚本的位置），你可以使用这样的东西：

function docReady(fn) {
    // see if DOM is already available
    if (document.readyState === "complete" || document.readyState === "interactive") {
        // call on next available tick
        setTimeout(fn, 1);
    } else {
        document.addEventListener("DOMContentLoaded", fn);
    }
}

用法：

docReady(function() {
    // DOM is loaded and ready for manipulation here
});

如果您需要完全的跨浏览器兼容性（包括旧版本的 IE）并且您不想等待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 代码路径中有一些我不太了解的变通方法，但看起来它与框架有关。

这是.ready()用纯 javascript 编写的jQuery 的完整替代品：

(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)被调用时，检查就绪处理程序是否已经触发。如果是这样，只需在此 JS 线程以setTimeout(fn, 1).
  4. 如果就绪处理程序尚未触发，则将此新回调添加到稍后要调用的回调列表中。
  5. 检查文件是否已经准备好。如果是，则执行所有准备好的处理程序。
  6. 如果我们还没有安装事件侦听器以了解文档何时准备就绪，那么现在就安装它们。
  7. 如果document.addEventListener存在，则安装.addEventListener()用于"DOMContentLoaded"和"load"事件的事件处理程序。“负载”是安全的备份事件，不需要。
  8. 如果document.addEventListener不存在，则使用.attachEvent()for"onreadystatechange"和"onload"events安装事件处理程序。
  9. 在这种情况onreadystatechange下，检查是否存在document.readyState === "complete"，如果是，则调用一个函数来触发所有就绪的处理程序。
  10. 在所有其他事件处理程序中，调用一个函数来触发所有准备好的处理程序。
  11. 在调用所有就绪处理程序的函数中，检查状态变量以查看我们是否已经触发。如果我们有，什么都不做。如果我们还没有被调用，那么循环遍历就绪函数数组并按照它们添加的顺序调用每个函数。设置一个标志以指示这些都已被调用，因此它们永远不会被执行多次。
  12. 清除函数数组，以便可以释放它们可能使用的任何闭包。

注册的处理程序docReady()保证按照它们注册的顺序被触发。

如果您docReady(fn)在文档准备好后调用，回调将被安排在当前执行线程完成后立即执行setTimeout(fn, 1)。这允许调用代码始终假定它们是稍后将调用的异步回调，即使稍后是在 JS 的当前线程完成并保留调用顺序后。

如果您在不使用 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!");
});

不要与 BELOW 混淆（这并不意味着为 DOM 做好准备）：

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

 Example:

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

这个 IIFE 不会等待你的 DOM 加载。（我什至在谈论最新版本的 Chrome 浏览器！）

play() 失败，因为用户没有先与文档交互
2021-02-14 16:00:54

我想在这里提到一些可能的方法以及一个适用于所有浏览器的纯 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（如uninitializedand 中loading，前两个DOM 就绪状态，共 5 个），我们设置超时并再次检查。否则，我们执行传递的函数。

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

感谢Tutorialzine将其包含在他们的书中。

非常糟糕的方法，使用具有任意 9ms 间隔的超时循环，并使用 eval。也只检查 /in/ 没有多大意义。
2021-02-18 16:00:54

已在 IE9、最新的 Firefox 和 Chrome 中测试，并且在 IE8 中也受支持。

document.onreadystatechange = function () {
  var state = document.readyState;
  if (state == 'interactive') {
      init();
  } else if (state == 'complete') {
      initOnCompleteLoad();
  }
}​;

示例：http : //jsfiddle.net/electricvisions/Jacck/

更新 - 可重用版本

我刚刚开发了以下内容。它与 jQuery 或 Dom ready 相当简单，没有向后兼容性。它可能需要进一步细化。在最新版本的 Chrome、Firefox 和 IE (10/11) 中进行了测试，应该可以在旧浏览器中运行，如评论所述。如果我发现任何问题，我会更新。

window.readyHandlers = [];
window.ready = function ready(handler) {
  window.readyHandlers.push(handler);
  handleState();
};

window.handleState = function handleState () {
  if (['interactive', 'complete'].indexOf(document.readyState) > -1) {
    while(window.readyHandlers.length > 0) {
      (window.readyHandlers.shift())();
    }
  }
};

document.onreadystatechange = window.handleState;

用法：

ready(function () {
  // your code here
});

它是为处理 JS 的异步加载而编写的，但除非您正在缩小，否则您可能希望先同步加载此脚本。我发现它在开发中很有用。

现代浏览器还支持脚本的异步加载，这进一步增强了体验。对异步的支持意味着可以在渲染页面的同时同时下载多个脚本。当依赖其他异步加载的脚本或使用 minifier 或类似 browserify 的东西来处理依赖项时，请注意。

HubSpot 的好人有一个资源，您可以在其中找到实现很多 jQuery 优点的纯 Javascript 方法 - 包括 ready

http://youmightnotneedjquery.com/#ready

function ready(fn) {
  if (document.readyState != 'loading'){
    fn();
  } else if (document.addEventListener) {
    document.addEventListener('DOMContentLoaded', fn);
  } else {
    document.attachEvent('onreadystatechange', function() {
      if (document.readyState != 'loading')
        fn();
    });
  }
}

内联用法示例：

ready(function() { alert('hello'); });
其它你可能感兴趣的问题
上一篇从对象中删除属性 (JavaScript) 下一篇匹配精确字符串