DIV CSS 佈局教程網

動態載入外部 JavaScript 檔案的函式分享
編輯:關於JavaScript     

這是一個把「動態載入腳本」包裝成命名空間方法的簡潔實作,同時處理了 onload 與 IE 的 onreadystatechange 兩套機制。

程式碼

(function (clover) {
  clover.loadScript = function loadScript(url, callback) {
    var heads = document.getElementsByTagName('head');
    if (heads.length == 0) {
      alert("page must have one head element");
      return;
    }
    var head = heads[0];
    var script = document.createElement('script');
    script.type = 'text/javascript';
    script.src = url;

    script.onload = callback;                       // 多數瀏覽器

    script.onreadystatechange = function () {       // IE 6 & 7
      if (this.readyState == 'complete') {
        callback();
      }
    };

    head.appendChild(script);
  };
})(window.clover = window.clover || {});

// 使用範例
// clover.loadScript("https://ajax.googleapis.com/ajax/libs/jquery/1.6.2/jquery.min.js");

值得學的三個設計

1. 用 IIFE 建立命名空間

(function (clover) { ... })(window.clover = window.clover || {});

這行是經典寫法:window.clover = window.clover || {} 確保命名空間物件存在(不存在就建立),然後傳入 IIFE 作為參數。好處是函式內部可以直接用簡短的 clover 而非冗長的 window.clover,同時不污染全域。

2. 檢查 head 是否存在

雖然 HTML 文件中 head 幾乎必然存在,但在文件片段、XHTML 或特殊嵌入情境下可能沒有。與其讓 appendChild 拋出 obscure 的錯誤,不如及早明確提示。

3. 具名函式表達式

clover.loadScript = function loadScript(url, callback) { ... }

外層與內層名稱相同,這不是重複:外層的 clover.loadScript 是屬性指派,內層的 loadScript 是函式自己的名字,讓它在函式體內可以遞迴呼叫自己,同時在 stack trace 中顯示有意義的名稱而非 anonymous。

這份程式碼的兩個問題

問題一:IE 的 readyState 判斷不完整

只檢查 complete 是不夠的。IE 的 readyState 會經歷 uninitialized → loading → loaded → interactive → complete,而在快取命中時可能跳過 loaded 直接到 complete,也可能停在 loaded 就不再前進。穩健寫法應該同時檢查兩者並搭配去重旗標:

script.onreadystatechange = function () {
  if (this.readyState == 'loaded' || this.readyState == 'complete') {
    this.onreadystatechange = null;
    done();
  }
};

問題二:callback 可能被呼叫兩次

在某些 IE 版本上,onload 與 onreadystatechange 都可能觸發,於是 callback 會執行兩次。若回呼裡有非冪等的操作(例如插入節點、累加計數),就會出問題。解法是用一次性旗標:

var called = false;
function done() {
  if (called) return;
  called = true;
  callback();
}

改良的完整版本

(function (ns) {
  ns.loadScript = function (url, callback) {
    var s = document.createElement('script');
    var done = false;

    function finish(err) {
      if (done) return;
      done = true;
      s.onload = s.onreadystatechange = s.onerror = null;
      callback(err);
    }

    s.type = 'text/javascript';
    s.src = url;
    s.onload = function () { finish(null); };
    s.onerror = function () { finish(new Error('load failed: ' + url)); };
    s.onreadystatechange = function () {
      if (this.readyState == 'loaded' || this.readyState == 'complete') finish(null);
    };

    (document.head || document.getElementsByTagName('head')[0]).appendChild(s);
  };
})(window.ns = window.ns || {});

改良點:加了一致性旗標、補上 onerror、完成後清空所有 handler(避免 IE 記憶體洩漏)、head 取得方式更簡潔。

今天的做法

如果只需要載入並等待,Promise 版本介面更友善:

function loadScript(url) {
  return new Promise(function (resolve, reject) {
    var s = document.createElement('script');
    s.src = url;
    s.async = true;
    s.onload = function () { resolve(url); };
    s.onerror = function () { reject(new Error('load failed: ' + url)); };
    document.head.appendChild(s);
  });
}

// 使用
loadScript('/lib/chart.js')
  .then(function () { drawChart(); })
  .catch(console.error);

而若腳本支援 ES Module,直接 import(url) 即可,相依性與快取都交給瀏覽器處理。

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