DIV CSS 佈局教程網

js 動態載入腳本的七種方法完整彙整
編輯:關於JavaScript     

本文彙整了 js 實現動態載入腳本的多種方法,分享給大家參考。

近期公司的前端地圖產品需要進行模組化劃分,希望使用者用到哪一塊功能,就載入哪一塊模組,藉此提升使用體驗。

於是四處查資料研究 js 動態腳本的載入。令人感慨的是,網路上幾乎都是同一篇文章、同樣的四種方法,其中一種還有錯誤。經過兩天的研究與查閱,在此與大家分享整理後的成果。

首先我們需要一個被載入的 js 檔案。我在固定資料夾下建立了一個 package.js,裡面寫了一個方法 functionOne,很簡單,程式碼如下:

 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 和 Safari 3 及之後的版本中運行。Safari 3.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 下的錯誤如下:

不過,只要發布之後,在 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>

這種方式所有瀏覽器都支援,但後續程式碼必須放進回呼函式裡,也就是屬於非同步載入。該怎麼選,就看你的需求了!我个人比較偏好第六種方法。若採用非同步載入,方法其實還有好幾種,不過我的初衷是實現同步載入,這裡就不再對非同步載入另做總結了。

希望本文所述能對大家的 JavaScript 程式設計有所幫助。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved