DIV CSS 佈局教程網

動態載入 JS 的五種方法與同步、非同步之別
編輯:關於JavaScript     

按需載入腳本是控制首屏體積的常見手段。JavaScript 提供了好幾種動態掛載 script 的方式,但它們在「同步或異步」以及「會不會重寫頁面」這兩點上差異明顯,選錯就可能踩坑。

方法一:document.write

<script language="javascript">
  document.write("<script src='res/extwidget/echarts/xx.js'><\/script>");
</script>

最直白的寫法,但 document.write 會重寫整個文件內容,在頁面載入後呼叫更是直接把畫面清空,實務上幾乎不可用。

方法二:改寫既有 script 的 src

<script src="" id="xx"></script>
<script language="javascript">
  xx.src = "test.js";
</script>

不會重寫頁面元素,比方法一安全,但仍是異步載入,而且必須先在 HTML 裡預埋一個空的 script 標籤。

方法三:動態建立 script 元素

var body = document.getElementsByTagName('BODY')[0];
var script = document.createElement("script");
script.type = "text/javascript";
script.src = "xx.js";
body.appendChild(script);

相對於方法二,不必預先在頁面上寫標籤,彈性更高,但同樣是異步行為。

方法四:用 XMLHttpRequest 抓取後再注入(異步)

透過 XHR 取回腳本內容,再塞進動態建立的 script 標籤。這種做法的優點是可以掌握載入完成時機,也能拿到載入失敗的狀態碼:

/**
 * 異步載入 js 腳本
 * @param id  要設置的 script 標籤 id
 * @param url js 文件的相對或絕對路徑
 */
loadJs: function (id, url) {
  var xmlHttp = null;
  if (window.ActiveXObject) {          // IE
    try {
      xmlHttp = new ActiveXObject("Msxml2.XMLHTTP");   // IE6+
    } catch (e) {
      xmlHttp = new ActiveXObject("Microsoft.XMLHTTP"); // IE5.5+
    }
  } else if (window.XMLHttpRequest) {  // Firefox、Opera 8+、Safari、Chrome
    xmlHttp = new XMLHttpRequest();
  }

  xmlHttp.onreadystatechange = function () {
    if (xmlHttp.readyState == 4) {     // 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);
      }
    }
  };

  xmlHttp.open("GET", url, true);      // 第三個參數 true 為異步
  xmlHttp.send(null);
}

方法五:同步載入

把 open 的第三個參數改成 false 就是同步請求。同步模式下不必設定 onreadystatechange,直接在 send 之後判斷 readyState 即可,並以回傳值告知呼叫方成敗:

/**
 * 同步載入 js 腳本
 * @return {Boolean} true 代表成功,false 代表失敗
 */
loadJs: function (id, url) {
  var xmlHttp = null;
  if (window.ActiveXObject) {
    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);     // 同步
  xmlHttp.send(null);

  if (xmlHttp.readyState == 4) {
    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;
  }
}

該怎麼選

前面幾種方式在腳本載入的同時,主頁面的程式仍持續執行,也就是所謂的非同步。若後續程式碼必須依賴該腳本提供的 API,就要自行處理時序問題,例如用 onload 回呼或輪詢檢查。同步載入雖然能保證順序,但會阻塞整個執行緒,畫面凍結、使用者無法互動,除了極少數特殊情境外並不建議。

另外要注意,Chrome 與 Opera 在使用同步 XHR 時,直接開啟本地檔案執行會報錯,必須部署到伺服器上才能正常運作。若使用 ES 標準的動態 import() 或 script 的 async、defer 屬性,也能以更簡潔的方式達成同樣目的。

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