DIV CSS 佈局教程網

為 $.getScript() 加上緩存開關,並移除自動附加的時間戳記
編輯:JavaScript綜合知識     

jQuery 的 $.getScript() 有兩個令人困擾的行為:預設不會使用快取,以及會自動在網址後方加上 timestamp 參數。前者讓同一支腳本被反覆下載,後者則可能弄壞你既有的網址解析邏輯。以下整理三種處理方式。

一、為 getScript 加上緩存參數

最簡潔的做法是重新定義這個方法,把 cache 的控制權交給呼叫者:

// 為 getScript 加上緩存控制
(function($){
  $.getScript = function(url, callback, cache) {
    $.ajax({ type: 'GET', url: url, success: callback, dataType: 'script', ifModified: true, cache: cache });
  };
})(jQuery);

這裡用 IIFE 包住並傳入 jQuery,是為了避免全域變數污染,同時讓區塊內的 $ 必定指向 jQuery。加入 ifModified: true 後,jQuery 會依伺服器回應的最後修改時間判斷資料是否變動,未變動時沿用快取,兼顧了效能與正確性。

二、移除自動附加的 timestamp

$.getScript 主要用於實作 JSONP,也就是跨來源取得資料,基本用法如下:

$.getScript(url, function(){ ... });

但它暗藏一個坑:jQuery 會自動在你的網址後面加上 timestamp。你請求的是 https://example.com/data,實際發出的卻是 https://example.com/data?_=1379920176108。

這個設計原意是為了避免快取,但若你的後端對網址有嚴格比對(例如驗簽、路由規則),就會莫名其妙地失敗,而且 debug 起來極其耗時——因為錯誤訊息裡看不到那個被加上的參數。

要拒絕這種行為,改用 $.ajax 並明確把 cache 設為 true 即可:

$.ajax({
    url: 'https://m.example.com',
    dataType: "script",
    cache: true,
    success: function(){}
});

關鍵就在 cache: true。jQuery 只有在 cache 為 false 時才會附加 timestamp,設為 true 就能完全拿掉這個參數。

三、自行實作帶快取的 cachedScript

若想更明確地控制「同一支腳本只載入一次」,可以自己維護一個已載入清單:

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>自製 cachedScript</title>
<script src="jquery-1.7.2.min.js" type="text/javascript"></script>
<script type="text/javascript">
// 記錄哪些 script 已下載到本地
var scriptsArray = new Array();

$.cachedScript = function (url, options) {
  for (var s in scriptsArray) {
    if (scriptsArray[s] == url) {
      // 已載入過,直接回傳一個具 done 方法的物件
      return {
        done: function (method) {
          if (typeof method == 'function') method();
        }
      };
    }
  }
  // 與官方 getScript 相同的 ajax 設定
  options = $.extend(options || {}, {
    dataType: "script",
    url: url,
    cache: true
  });
  scriptsArray.push(url);
  return $.ajax(options);
};

$(function () {
  $('#btn').bind('click', function () {
    $.cachedScript('t1.js').done(function () { alertMe(); });
  });
  $('#btn2').bind('click', function () {
    $.getScript('t1.js').done(function () { alertMe(); });
  });
});
</script>
</head>
<body>
<button id="btn">自定義的緩存方法</button>
<br />
<button id="btn2">getScript</button>
</body>
</html>

設計重點在於回傳值的一致性。首次載入時回傳 $.ajax() 的結果(一個具 done 方法的 jqXHR 物件);若已載入過,則手動組一個只含 done 方法的物件字面值。兩條路徑都有 done,呼叫端因此不必判斷分支,寫起來跟原生 getScript 一樣自然。之所以取名 done 而非其他,正是為了與 $.ajax 的 API 對齊。

實務上要留意:這個自製版本只用陣列記錄網址,無法偵測腳本「載入失敗」的情況——失敗的網址不在清單上,下次點擊會再試一次,這通常是好事;但若失敗是因為檔案不存在,就會每次都白跑一趟。若需要更嚴謹的行為,改用 ES Module 的動態 import() 會更合適,因為瀏覽器本身就會快取模組並保證只執行一次。

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