JavaScript动态加载脚本

有时候我们加载脚本时由于一些原因需要用到动态加载,例如异步加载,JS跨域,同步加载等,jQuery封装了大量的ajax加载方式,同样我们可以通过原生js动态加载。

package.js

function functionOne(){
    alert("成功加载");
}

后面的html文件都创建在同一个目录下。

方法一:直接document.write

在同一个文件夹下面创建一个function1.html,代码如下:

<html>
<head>
    <title></title>
    <script type="text/javascript">
        function init()
        {
            //加载js脚本
            document.write("<script src='package.js'><\/script>");
            //加载一个按钮
            document.write("<input type=\"button\" value=\"测试运行效果\" onclick=\"operation()\"\/>");
            //如果马上使用会找不到,因为还没有加载进来,此处会报错
            functionOne();
        }
        function operation()
        {
            //可以运行,显示“成功加载”
            functionOne();
        }
    </script>
</head>
<body>
    <input type="button" value="初始化加载" onclick="init()"/>
</body>
</html>

通过document.write的方式可以往页面写入脚本,如代码所示,点击按钮“初始化加载”后可以加载package.js文件,但是立即运行里面的方法functionOne会找不到此方法,报告错误,而点击第二个按钮(通过document.write动态创建的“测试运行效果”)发现可以执行,此时脚本已经加载完毕了。由于这种方式是异步加载(一边继续执行后面的代码,一边额外开一个线程执行需要加载的脚本),并且document.write会重写界面,明显不实用。

方法二:动态改变已有script的src属性

在同一个文件夹下面创建一个function2.html,代码如下:

<html>
<head>
    <title></title>
    <script type="text/javascript" id="yy" src=""></script>
    <script type="text/javascript">
        function init()
        {
            yy.src = "package.js";
            //如果马上使用会找不到,因为还没有加载进来,此处会报错
            functionOne();
        }
        function operation()
        {
            //可以运行,显示“成功加载”
            functionOne();
        }
    </script>
</head>
<body>
    <input type="button" value="测试按钮" onclick="init()"/>
    <input type="button" value="测试运行效果" onclick="operation()"/>
</body>
</html>

此种方法的好处在于不会改变界面元素,不至于重写界面元素,但是同样是异步加载,会有同样的问题。

方法三:动态创建script元素(异步)

在同一个文件夹下面创建一个function3.html,代码如下:

<html>
<head>
    <title></title>
    <script type="text/javascript">
        function init()
        {
            var myScript= document.createElement("script");
            myScript.type = "text/javascript";
            myScript.src="package.js";
            document.body.appendChild(myScript);
            //如果马上使用会找不到,因为还没有加载进来
            functionOne();
        }
        function operation()
        {
            //可以运行,显示“成功加载”
            functionOne();
        }
    </script>
</head>
<body>
    <input type="button" value="测试按钮" onclick="init()"/>
    <input type="button" value="测试运行效果" onclick="operation()"/>
</body>
</html>

此办法的优势相对于第二种而言就是不需要最开始就在界面写一个script标签,缺点还是异步加载,存在同样的问题。

这三种方法都是异步执行的,所以在加载这些脚本的同时,主页面的脚本继续运行,如果用以上的方法,那下面的代码将得不到预期的效果。

不过可以在functionOne前面加一个alert就可以堵塞一下主页面脚本的运行,然后你发现functionOne就可以运行了,或者你的后期代码需要在另一个按钮下执行,一步一步的来,要不就定义一个计时器,在固定时间后再执行后面的代码,不过在项目里面肯定不可能使用这些方法。

其实第三种方法改一点就变成同步加载了。

方法四:动态创建script元素(同步)

在同一个文件夹下面创建一个function4.html,代码如下:

<html>
<head>
    <title></title>
    <script type="text/javascript">
        function init()
        {

            var myScript= document.createElement("script");
            myScript.type = "text/javascript";
            myScript.appendChild(document.createTextNode("function functionOne(){alert(\"成功运行\"); }"));
            document.body.appendChild(myScript);
            //此处发现可以运行
            functionOne();
        }
    </script>
</head>
<body>
    <input type="button" value="测试按钮" onclick="init()"/>
</body>
</html>

此方法并没有加载外部的js文件,而是给myScript添加了子项。在Firefox、Safari、Chrome、Opera和IE9中,这些代码可以正常运行。但是在IE8以及以下的版本中会导致错误。IE将<script>视为一个特殊的元素,不允许DOM访问其子节点。不过可以用<script>元素的text属性来制定js代码,想下面的例子这样:

            var myScript= document.createElement("script");
            myScript.type = "text/javascript";
            myScript.text = "function functionOne(){alert(\"成功运行\"); }";
            document.body.appendChild(myScript);
            //此处可以运行
            functionOne();

经过这样修改之后的代码可以在IE、Firefox、Opera和Safari3及之后版本中运行。Safari3.0之前的版本虽然不能正确地支持text属性,但却允许使用文本节点技术来指定代码。如果需要兼容早期版本的Safari,可以使用下面代码:

            var myScript= document.createElement("script");
            myScript.type = "text/javascript";
            var code = "function functionOne(){alert(\"成功运行\"); }";
            try{
                myScript.appendChild(document.createTextNode(code));
            }
            catch (ex){
                myScript.text = code;
            }
            document.body.appendChild(myScript);
            //此处发现可以运行
            functionOne();

这里,首先尝试标准的DOM文本节点方法,因为除了IE8以及以下,所有浏览器都支持这种方式。如果这行代码抛出了错误,那么说明是IE8以及以下,于是就必须使用text属性了。整个过程可以用以下函数来表示:

 function loadScriptString(code)
        {
            var myScript= document.createElement("script");
            myScript.type = "text/javascript";
            try{
                myScript.appendChild(document.createTextNode(code));
            }
            catch (ex){
                myScript.text = code;
            }
            document.body.appendChild(myScript);
        }

然后你可以在其他地方使用此方法来加载需要使用的代码。实际上,这样执行代码与在全局作用于中把相同字符串传递给eval()是一样的。但是我们这里只能使用字符串形式的代码,也有局限性,用户一般希望提供的方法形如loadScriptAddress("package.js")的方式,所以我们还需要继续讨论。

方法五:XMLHttpRequest/ActiveXObject异步加载

在同一个文件夹下面创建一个function5.html,代码如下:

<html>
<head>
    <title></title>
    <script type="text/javascript">
        function init()
        {
            //加载package.js文件,设置script的id为yy
            ajaxPage("yy","package.js");
            //此方法为package.js里面的方法,此处执行方法成功
            functionOne();
        }
        function ajaxPage(sId,url)
        {
            var oXmlHttp = getHttpRequest();
            oXmlHttp.onreadystatechange = function()
            {
                //4代表数据发送完毕
                if ( oXmlHttp.readyState == 4 )
                {
                    //0为访问的本地,200代表访问服务器成功,304代表没做修改访问的是缓存
                    if(oXmlHttp.status == 200 || oXmlHttp.status == 0 || oXmlHttp.status == 304)
                    {
                        includeJS(sId,oXmlHttp.responseText);
                    }
                    else
                    {
                    }
                }
            }
            oXmlHttp.open("GET",url,true);
            oXmlHttp.send(null);
        }
        function getHttpRequest()
        {
            if(window.ActiveXObject)//IE
            {
                return new ActiveXObject("MsXml2.XmlHttp");
            }
            else if(window.XMLHttpRequest)//其他
            {
                return new XMLHttpRequest();
            }
        }
        function includeJS(sId,source)
        {
            if((source != null)&&(!document.getElementById(sId)))
            {
                var myHead = document.getElementsByTagName("HEAD").item(0);
                var myScript = document.createElement( "script" );
                myScript.language = "javascript";
                myScript.type = "text/javascript";
                myScript.id = sId;
                try{
                    myScript.appendChild(document.createTextNode(source));
                }
                catch (ex){
                    myScript.text = source;
                }
                myHead.appendChild( myScript );
            }
        }
    </script>
</head>
<body>
    <input type="button" value="测试按钮" onclick="init()"/>
</body>
</html>

ActiveXObject只有IE里面才有,其他浏览器大部分支持XMLHttpRequest,通过此办法我们可以实现动态加载脚本了,不过是异步加载,也没法运行functionOne,第二次就可以运行了,但是可惜的是在IE、Firefox、Safari下可以运行,在Opera、Chrome下会出错,Chrome下的错误如下:

07133542-1817a14bd8474189abad2a394dafc703

不过只要发布之后在Chrome和Opera下就不会出现错误了。

其实这里把open里面设置为false就是同步加载了,同步加载不需要设置onreadystatechange事件。

方法六:XMLHttpRequest/ActiveXObject同步加载

在这里我把一些情况考虑在内,写成了一个方法,封装为loadJS.js,方便以后直接调用,代码如下:

/**
 * 同步加载js脚本
 * @param id   需要设置的<script>标签的id
 * @param url   js文件的相对路径或绝对路径
 * @return {Boolean}   返回是否加载成功,true代表成功,false代表失败
 */
function loadJS(id,url){
    var  xmlHttp = null;
    if(window.ActiveXObject)//IE
    {
        try {
            //IE6以及以后版本中可以使用
            xmlHttp = new ActiveXObject("Msxml2.XMLHTTP");
        }
        catch (e) {
            //IE5.5以及以后版本可以使用
            xmlHttp = new ActiveXObject("Microsoft.XMLHTTP");
        }
    }
    else if(window.XMLHttpRequest)//Firefox,Opera 8.0+,Safari,Chrome
    {
        xmlHttp = new XMLHttpRequest();
    }
    //采用同步加载
    xmlHttp.open("GET",url,false);
    //发送同步请求,如果浏览器为Chrome或Opera,必须发布后才能运行,不然会报错
    xmlHttp.send(null);
    //4代表数据发送完毕
    if ( xmlHttp.readyState == 4 )
    {
        //0为访问的本地,200到300代表访问服务器成功,304代表没做修改访问的是缓存
        if((xmlHttp.status >= 200 && xmlHttp.status <300) || xmlHttp.status == 0 || xmlHttp.status == 304)
        {
            var myHead = document.getElementsByTagName("HEAD").item(0);
            var myScript = document.createElement( "script" );
            myScript.language = "javascript";
            myScript.type = "text/javascript";
            myScript.id = id;
            try{
                //IE8以及以下不支持这种方式,需要通过text属性来设置
                myScript.appendChild(document.createTextNode(xmlHttp.responseText));
            }
            catch (ex){
                myScript.text = xmlHttp.responseText;
            }
            myHead.appendChild( myScript );
            return true;
        }
        else
        {
            return false;
        }
    }
    else
    {
        return false;
    }
}

此处考虑到了浏览器的兼容性以及当为Chrome、Opera时必须是发布,注释还是写的比较清楚的,以后需要加载某个js文件时,只需要一句话就行了,如loadJS("myJS","package.js")。方便实用。

如果想要实现不发布还非要兼容所有浏览器,至少我还没找出这样的同步加载的办法,我们只能通过异步加载开出回调函数来实现。

方法七:回调函数方式

在同一个文件夹下面创建一个function7.html,代码如下:

<html>
<head>
    <title></title>
    <script type="text/javascript">
        function init()
        {
            //加载package.js文件,设置script的id为yy
            loadJs("yy","package.js",callbackFunction);

        }
        function callbackFunction()
        {
            functionOne();
        }
        function loadJs(sid,jsurl,callback){
            var nodeHead = document.getElementsByTagName('head')[0];
            var nodeScript = null;
            if(document.getElementById(sid) == null){
                nodeScript = document.createElement('script');
                nodeScript.setAttribute('type', 'text/javascript');
                nodeScript.setAttribute('src', jsurl);
                nodeScript.setAttribute('id',sid);
                if (callback != null) {
                    nodeScript.onload = nodeScript.onreadystatechange = function(){
                        if (nodeScript.ready) {
                            return false;
                        }
                        if (!nodeScript.readyState || nodeScript.readyState == "loaded" || nodeScript.readyState == 'complete') {
                            nodeScript.ready = true;
                            callback();
                        }
                    };
                }
                nodeHead.appendChild(nodeScript);
            } else {
                if(callback != null){
                    callback();
                }
            }
        }
    </script>
</head>
<body>
    <input type="button" value="测试按钮" onclick="init()"/>
</body>
</html>

这种方式所有浏览器都支持,但是后面的代码必须放在回调函数里面,也就是异步加载了。看需求使用把!我还是比较喜欢第六种方法的。如果是异步加载的话,方法还有好几种,不过我的出发点是希望实现同步加载,这里就不对异步加载做总结了。

文章来自:js动态加载脚本

原创文章:JavaScript动态加载脚本 ,未经许可,禁止转载,©版权所有
原文出处:前端开发博客 (http://caibaojian.com/create-script.html)

“JavaScript动态加载脚本”有2个评论

  1. 懒人建站

    改成不需要传ID会更有用

    登录回复
  2. 懒人建站

    封装个好用的异步加载,加载完成执行回调,要是还可以加载多个就更好,要是可以多段多个并行加载顺序执行,更好,不能再往下写了,再往下就要写成requirejs了,

    登录回复