纯 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 准备就绪,而不等待所有图像加载。而且,这适用于所有浏览器。

<!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),如果您希望能够实现 jQuery,例如$(document).ready()方法,您可以从任何地方调用它(而不必担心)调用脚本所在的位置),您可以使用类似以下内容的代码:

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 的功能(无论将 script 标记放置在何处都可以使用)。

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

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) ,请检查就绪处理程序是否已启动。如果是这样,只需安排新添加的回调在此 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. 在调用所有就绪处理程序的函数中,检查一个状态变量以查看是否已经解雇了。如果有,什么也不做。如果尚未调用,请遍历准备好的函数数组,并按添加顺序调用每个函数。设置一个标志以指示所有这些都已被调用,因此它们永远不会被执行多次。
  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 (如未uninitializedloadinguninitialized 5 中的前两个DOM 就绪状态开始),我们设置一个超时并再次检查。否则,我们执行传递的函数。

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

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

如果要使用不带 jQuery 的VANILLAJavaScript ,则必须使用(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 将在 ready 甚至发生后运行。

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

不要与以下混淆 (这并不意味着要准备 DOM):

请勿使用这种会自行执行的IIFE

Example:

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

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

在 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 相当简单。它可能需要进一步完善。已在最新版本的 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 的异步加载而编写的,但除非您精简,否则您可能要先对其进行同步加载。我发现它在开发中很有用。

现代浏览器还支持脚本的异步加载,从而进一步增强了体验。支持异步意味着可以同时下载多个脚本,同时仍渲染页面。只需注意何时依赖于异步加载的其他脚本,或者使用缩小器或类似 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'); });

我不确定您要问的是什么,但这可能会有所帮助:

window.onload = function(){
    // Code. . .

}

要么:

window.onload = main;

function main(){
    // Code. . .

}

您的方法(将脚本放在结束 body 标签之前)

<script>
   myFunction()
</script>
</body>
</html>

是支持新旧浏览器的可靠方法。

准备

function ready(fn){var d=document;(d.readyState=='loading')?d.addEventListener('DOMContentLoaded',fn):fn();}

使用方式

ready(function(){
    //some code
});

对于自调用代码

(function(fn){var d=document;(d.readyState=='loading')?d.addEventListener('DOMContentLoaded',fn):fn();})(function(){

    //Some Code here
    //DOM is avaliable
    //var h1s = document.querySelector("h1");

});

支持:IE9 +

这是Ram-swaroop 的 “可在所有浏览器中使用的” 版本的清理后的非评估版,可在所有浏览器中使用!

function onReady(yourMethod) {
  var readyStateCheckInterval = setInterval(function() {
    if (document && document.readyState === 'complete') { // Or 'interactive'
      clearInterval(readyStateCheckInterval);
      yourMethod();
    }
  }, 10);
}
// use like
onReady(function() { alert('hello'); } );

但是,它确实要等待额外的 10 毫秒才能运行,因此,这是不应该使用的更复杂的方法:

function onReady(yourMethod) {
  if (document.readyState === 'complete') { // Or also compare to 'interactive'
    setTimeout(yourMethod, 1); // Schedule to run immediately
  }
  else {
    readyStateCheckInterval = setInterval(function() {
      if (document.readyState === 'complete') { // Or also compare to 'interactive'
        clearInterval(readyStateCheckInterval);
        yourMethod();
      }
    }, 10);
  }
}

// Use like
onReady(function() { alert('hello'); } );

// Or
onReady(functionName);

另请参阅如何在没有框架的情况下检查 DOM 是否准备就绪?

document.ondomcontentready=function(){}应该可以解决问题,但是它不具有完全的浏览器兼容性。

似乎您应该只使用 jQuery min