在需要按需載入、延遲載入或合併載入第三方腳本的場合,動態載入 JS 是必備技巧。本文整理五種常見做法,並比較同步與非同步的差異。
<script language="javascript">
document.write("<script src='res/extwidget/echarts/xx.js'><\/script>");
</script>
這種方式會重寫整個文件流,一旦在頁面載入完成後調用,當前文件會被清空重寫,實用性很差,如今基本只在極老的程式碼中出現。注意 `<\/script>` 中的反斜線是必需的,否則會提前結束當前 script 標籤。
<script src="" id="xx"></script> <script language="javascript"> xx.src = "test.js" </script>
頁面預先放一個空的 script 標籤,執行時再指定 src。這種做法不會影響頁面元素、不重寫介面,但仍然是非同步載入,腳本執行的時機無法精確保證。
<script>
var body = document.getElementsByTagName('BODY')[0];
var script = document.createElement("script");
script.type = "text/javascript";
script.src = "xx.js";
body.appendChild(script);
</script>
相比方法二,它的優勢是不需要事先在 HTML 中埋一個佔位標籤,隨時創建即可;缺點同樣是非同步,且不提供載入完成的回調。
/**
* 非同步載入 js 腳本
* @param id 需要設置的 <script> 標籤的 id
* @param url js 文件的相對路徑或絕對路徑
*/
loadJs: function(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, true);
xmlHttp.send(null);
xmlHttp.onreadystatechange = function(){
//4 代表數據發送完畢
if (xmlHttp.readyState == 4) {
//0 為訪問本地,200~300 代表訪問服務器成功,304 代表讀取緩存
if ((xmlHttp.status >= 200 && xmlHttp.status < 300) || xmlHttp.status == 0 || xmlHttp.status == 304) {
var myBody = document.getElementsByTagName("BODY")[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;
}
myBody.appendChild(myScript);
}
}
}
}
把 open 的第三個參數設為 false 就是同步載入,此時不需要監聽 onreadystatechange,直接在 send 之後判斷 readyState 與 status 即可。需要注意,同步 XHR 在 Chrome 中對本地 file:// 協議會報跨域錯誤,必須部署到伺服器後才能正常執行。
/**
* 同步載入 js 腳本
* @param id 需要設置的 <script> 標籤的 id
* @param url js 文件的相對路徑或絕對路徑
* @return {Boolean} 返回是否載入成功,true 代表成功,false 代表失敗
*/
loadJs: function(id, url) {
var xmlHttp = null;
if (window.ActiveXObject) { //IE
try {
xmlHttp = new ActiveXObject("Msxml2.XMLHTTP");
} catch (e) {
xmlHttp = new ActiveXObject("Microsoft.XMLHTTP");
}
} else if (window.XMLHttpRequest) {
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 myBody = document.getElementsByTagName("BODY")[0];
var myScript = document.createElement("script");
myScript.language = "javascript";
myScript.type = "text/javascript";
myScript.id = id;
try {
myScript.appendChild(document.createTextNode(xmlHttp.responseText));
} catch (ex) {
myScript.text = xmlHttp.responseText;
}
myBody.appendChild(myScript);
return true;
} else {
return false;
}
} else {
return false;
}
}
前四種方法本質上都是非同步的:腳本開始載入的同時,主頁面的程式碼繼續執行,因此若後續程式碼依賴該腳本提供的變數,就會拿到 undefined。方法五用同步 XHR 換取確定性,代價是阻塞整個執行緒,畫面會凍結,如今已不建議使用。
在現代開發中,更好的選擇包括:動態插入 script 標籤並監聽 load 事件來獲取載入完成通知;使用 ES Module 的 `import()` 動態語法,它原生支援 Promise;或使用 webpack、Vite 等打包工具的程式碼分割能力。若只是非同步載入不阻塞渲染,直接加上 `async` 屬性即可;若需保證執行順序,則用 `defer`。