簡介
對以網路為基礎的應用來說,離線可用性愈來愈重要。所有瀏覽器雖然都有快取機制,但那些機制並不可靠,也未必能達到預期效果。HTML5 以 ApplicationCache 介面處理了離線帶來的若干難題。
導入快取介面能帶來三項好處:
應用程式快取(AppCache)讓開發者能明確指定哪些檔案需要被快取,以支援離線存取。也就是說,即便使用者在離線狀態按下重新整理,應用照樣能正常載入並運行。
清單檔(cache manifest)是一個簡單的文字檔,列出瀏覽器應快取以供離線使用的資源。
要啟用某個應用的 AppCache,需在文件根元素的標籤上加上 manifest 屬性:
<html manifest="example.appcache"> ... </html>
理論上,每個需要快取的頁面都該加上這個屬性。若某頁沒有 manifest 屬性,瀏覽器不會快取它(除非它在清單檔中被明確列出)。反過來說,使用者造訪過的每一個帶有 manifest 的頁面,都會被隱式加入應用快取,因此你其實不必把每個頁面都寫進清單。
manifest 屬性可以指向絕對網址或相對路徑,但絕對網址必須與該網路應用同源。清單檔可用任何副檔名,唯一要求是必須以正確的 MIME 類型提供:
<html manifest="https://www.example.com/example.mf"> ... </html>
清單檔必須以 text/cache-manifest 提供,這通常需要在伺服器或 .htaccess 中補上自訂類型。
Apache 的作法是在設定檔中加入:
AddType text/cache-manifest .appcache
若部署在 Google App Engine,則在 app.yaml 中補上:
- url: /mystaticdir/(.*\.appcache) static_files: mystaticdir/\1 mime_type: text/cache-manifest upload: mystaticdir/(.*\.appcache)
最簡單的形式如下:
CACHE MANIFEST index.html stylesheet.css images/logo.png scripts/main.js
這個例子會快取四個檔案。幾個重點:
CACHE MANIFEST 字串必須放在第一行,且不可省略。unlimitedStorage 解除此限制。CACHE MANIFEST # 2010-06-18:v2 # 明確快取的項目 CACHE: /favicon.ico index.html stylesheet.css images/logo.png scripts/main.js # 需要連線才能使用的資源 NETWORK: login.php /myapi https://api.twitter.com # 後備方案 # 若 main.py 無法存取,改用 static.html # images/large/ 下的圖片一律改用 offline.jpg # 其他所有 .html 檔一律改用 offline.html FALLBACK: /main.py /static.html images/large/ images/offline.jpg *.html /offline.html
以「#」開頭的是註解行,但它其實還有另一個重要用途。應用快取只有在清單檔本身發生變動時才會更新——也就是說,你改了圖片或 JavaScript 內容,瀏覽器不會因此重新快取;必須讓清單檔產生變化才行。實務上的做法是在註解行寫入版本號、檔案雜湊或時間戳,確保使用者拿到的是最新版本。
CACHE:這是預設區塊。首次下載後,列於此處(或緊接 CACHE MANIFEST 之後)的檔案會被明確快取。
NETWORK:此處列出的是需要連線伺服器的白名單資源。無論使用者是否在線,對這些資源的請求都會繞過快取。可使用萬用字元。
FALLBACK:此區塊為可選,用於指定資源無法存取時的替代頁面。第一個 URI 代表資源,第二個代表後備頁面,兩者必須同源于清單檔。可使用萬用字元。
這些區塊可依任意順序排列,且同一區塊可在同一份清單中重複出現。
下面這份清單定義了使用者離線造訪站點根路徑時顯示的綜合頁面(offline.html),同時表明其他所有資源(例如遠端站點的內容)都需要網路連線:
CACHE MANIFEST # 2010-06-18:v3 # 明確快取的項目 index.html css/style.css # 離線時顯示 offline.html FALLBACK: / /offline.html # 其他資源都需要使用者連上網路 NETWORK: * # 額外要快取的資源 CACHE: images/logo1.png images/logo2.png images/logo3.png
請注意:引用清單檔的 HTML 檔會被自動快取,因此不寫進清單也可以,但我們仍建議明確列出。
另一個容易忽略的細節是,HTTP 快取標頭以及透過 SSL 提供的頁面的快取限制,會被快取清單取代。因此以 https 提供的頁面也能離線運行。
應用一旦離線就會保持快取狀態,除非發生以下情況之一:
window.applicationCache 物件提供了對瀏覽器應用快取的程式化存取,其 status 屬性可檢視目前狀態:
var appCache = window.applicationCache;
switch (appCache.status) {
case appCache.UNCACHED: // UNCACHED == 0
return 'UNCACHED';
break;
case appCache.IDLE: // IDLE == 1
return 'IDLE';
break;
case appCache.CHECKING: // CHECKING == 2
return 'CHECKING';
break;
case appCache.DOWNLOADING: // DOWNLOADING == 3
return 'DOWNLOADING';
break;
case appCache.UPDATEREADY: // UPDATEREADY == 4
return 'UPDATEREADY';
break;
case appCache.OBSOLETE: // OBSOLETE == 5
return 'OBSOLETE';
break;
default:
return 'UNKNOWN CACHE STATUS';
break;
};
先呼叫 applicationCache.update() 嘗試更新使用者快取(前提是清單檔已有變動);待 status 進入 UPDATEREADY 狀態後,再呼叫 applicationCache.swapCache() 換上新快取。
var appCache = window.applicationCache;
appCache.update(); // 嘗試更新使用者快取
...
if (appCache.status == window.applicationCache.UPDATEREADY) {
appCache.swapCache(); // 下載成功,換入新快取
}
要注意,這樣使用 update() 與 swapCache() 並不會立刻把新資源送到使用者眼前。整個流程只是讓瀏覽器檢查是否有新清單、下載更新內容並重新填充快取。因此需要重新載入頁面兩次才能看到新內容:第一次取得新的應用快取,第二次才刷新頁面內容。
好消息是,這兩次重新載入的麻煩可以省掉。做法是監聽頁面載入時的 updateready 事件:
// 頁面載入時檢查是否有新快取可用
window.addEventListener('load', function(e) {
window.applicationCache.addEventListener('updateready', function(e) {
if (window.applicationCache.status == window.applicationCache.UPDATEREADY) {
// 瀏覽器已下載新的應用快取
// 換入並重新載入以套用新內容
window.applicationCache.swapCache();
if (confirm('A new version of this site is available. Load it?')) {
window.location.reload();
}
} else {
// 清單沒有變動,伺服器端也沒有新東西
}
}, false);
}, false);
顧名思義,一組事件被用來監聽快取狀態。瀏覽器會針對下載進度、快取更新與錯誤狀態觸發對應事件。以下為各事件型別掛上監聽器:
function handleCacheEvent(e) {
// ...
}
function handleCacheError(e) {
alert('Error: Cache failed to update!');
};
// 首次快取清單後觸發
appCache.addEventListener('cached', handleCacheEvent, false);
// 檢查更新,永遠是整個序列中第一個觸發的事件
appCache.addEventListener('checking', handleCacheEvent, false);
// 找到更新,瀏覽器開始抓取資源
appCache.addEventListener('downloading', handleCacheEvent, false);
// 清單回傳 404 或 410、下載失敗,
// 或下載過程中清單又發生了變動
appCache.addEventListener('error', handleCacheError, false);
// 首次下載清單後觸發
appCache.addEventListener('noupdate', handleCacheEvent, false);
// 清單檔回傳 404 或 410 時觸發,
// 此時應用快取會被刪除
appCache.addEventListener('obsolete', handleCacheEvent, false);
// 清單中每個資源被抓取時觸發
appCache.addEventListener('progress', handleCacheEvent, false);
// 清單資源重新下載完成後觸發
appCache.addEventListener('updateready', handleCacheEvent, false);
最後要再次記住那條容易吃虧的規則:只要清單檔或其中任何一個資源下載失敗,整次更新就會作廢,瀏覽器會繼續沿用舊的應用快取。因此清單裡列的資源最好都穩定可靠,並務必透過修改清單檔來觸發更新。