HTML5 代表了 Web 平台的一次大躍進,除了新的語意標籤、表單驗證、影音標籤、拖放與工作線程之外,還首度把「離線應用」列為正式支援的能力。本文依序說明離線開發的三根支柱:離線資源快取、線上狀態偵測、本地資料儲存,最後用一個便籤小程式把它們串起來。
先給一個重要提醒:本文示範的 cache manifest 與 applicationCache 已被淘汰,多數瀏覽器已移除或停用,今日的正確做法是 Service Worker。以下內容仍值得讀——它說明的問題(離線資源、狀態偵測、本地資料)完全沒有變,只是解法換了工具。
以 W3C 的經典 Clock 範例來看,這個應用由三個檔案組成:
<!-- clock.html -->
<!DOCTYPE HTML>
<html>
<head>
<title>Clock</title>
<script src="clock.js"></script>
<link rel="stylesheet" href="clock.css" />
</head>
<body>
<p>The time is: <output id="clock"></output></p>
</body>
</html>
/* clock.css */
output { font: 2em sans-serif; }
/* clock.js */
setTimeout(function () {
document.getElementById('clock').value = new Date();
}, 1000);
離線時開這個頁面只會是一片空白。要讓它能用,得補上一份 manifest 檔案:
CACHE MANIFEST
clock.html
clock.css
clock.js
接著把 <html> 的 manifest 屬性指向它:
<html manifest="clock.manifest">
改完之後,使用者第一次在線上開啟時瀏覽器會快取這三個檔案,之後即使離線也能正常運作。
CACHE MANIFEST。NETWORK: 標示白名單,清單內的資源不快取,永遠走線上請求。CACHE: 標示。FALLBACK: 指定替代 URI:每行兩個 URI,第一個無法取得時改用第二個。# 開頭。CACHE MANIFEST
# 上一行是必須的
images/sound-icon.png
images/background.png
NETWORK:
comm.cgi
CACHE:
style/default.css
FALLBACK:
/files/projects /projects
更新有兩種路徑。自動更新:瀏覽器除了首次造訪會快取之外,只有在 manifest 檔案本身變動時才會更新快取;也就是說,單純改動清單裡的 CSS 或 JS 並不會觸發更新——這是許多人踩過的坑,實務上的解法是改 manifest 的版本註解。手動更新:透過 window.applicationCache 介面自行觸發。
if (window.applicationCache.status === window.applicationCache.UPDATEREADY) {
window.applicationCache.update();
}
現代的對應做法是註冊 Service Worker,由 install/activate 生命週期管理快取,並用 fetch 事件攔截請求,控制粒度與除錯能力都遠優於 manifest。
靜態頁面快取完就能離線用了。但 Web 2.0 之後,使用者產生的資料才是主體,所以真正的難題是:離線時如何讓使用者繼續操作資料,上線後再同步。而這一切都得先知道「現在在不在線」。
navigator.onLine:回傳布林值,true 為在線、false 為離線,網路狀態改變時數值隨之更新。
online/offline 事件:光靠輪詢 navigator.onLine 通常不夠,你需要在狀態切換的瞬間收到通知。這兩個事件會觸發在 body 上,並沿著 document.body → document → window 的順序冒泡,因此掛在最上層監聽即可。
window.addEventListener('online', handleOnline, false);
window.addEventListener('offline', handleOffline, false);
Cookie 也能存資料,但容量通常只有幾 KB,能力也有限。HTML5 因此引入 DOM Storage,專門存放 key/value 對,目標是提供大量、安全又易用的儲存機制。
兩種類型:功能完全一致,差別只在生命週期與作用範圍。
sessionStorage:與當前瀏覽視窗綁定,視窗關閉後資料即消失。localStorage:長期保存,視窗關閉後仍可讀取,且同一來源的各視窗共享同一份資料。介面:
interface Storage {
readonly attribute unsigned long length;
getter DOMString key(in unsigned long index);
getter any getItem(in DOMString key);
setter void setItem(in DOMString key, in any data);
deleter void removeItem(in DOMString key);
void clear();
};
最常用的是 getItem 與 setItem:
<!DOCTYPE HTML>
<html>
<body>
<script>
// 寫入
sessionStorage.setItem('userName', 'developerworks');
// 讀取
alert('你的帳號是:' + sessionStorage.getItem('userName'));
// 刪除
sessionStorage.removeItem('userName');
</script>
</body>
</html>
要留意兩點:DOM Storage 只存字串,物件需自行 JSON.stringify/parse;而且它是同步 API,大量讀寫會阻塞主執行緒。
HTML5 原本還規劃了 Web SQL Database,提供基本的關聯式資料庫能力,適合存放複雜、需要查詢的結構化資料,例如信件、行事曆,或作為伺服器資料的本機快取。它支援交易(transaction),因此多個視窗同時操作同一份資料也不會衝突。
建立與開啟:使用 openDatabase,若資料庫不存在則建立。
Database openDatabase(
in DOMString name, // 資料庫名稱
in DOMString version, // 版本
in DOMString displayName, // 顯示名稱
in unsigned long estimatedSize, // 預估大小(位元組)
in optional DatabaseCallback creationCallback
);
執行交易:每個交易是一個不可中斷的原子操作。
void transaction(
in SQLTransactionCallback callback, // 交易回呼,可執行 SQL
in optional SQLTransactionErrorCallback errorCallback,
in optional SQLVoidCallback successCallback
);
執行 SQL:
void executeSql(
in DOMString sqlStatement, // SQL 敘述
in optional ObjectArray arguments, // 參數
in optional SQLStatementCallback callback,
in optional SQLStatementErrorCallback errorCallback
);
完整範例:
var db = openDatabase('fooDB', '1.0', 'fooDB', 2 * 1024);
db.transaction(function (tx) {
tx.executeSql('CREATE TABLE IF NOT EXISTS foo (id unique, text)');
tx.executeSql('INSERT INTO foo (id, text) VALUES (1, "foobar")');
});
需要注意的是,W3C 早已停止維護這份規格,瀏覽器實作也陸續退場。今天若需要在瀏覽器端做關聯式查詢,答案是 IndexedDB(原生、非同步)或直接在它之上運作的封裝庫。
最後把上述功能串起來。這個便籤程式允許新增與刪除便籤,離線時操作也沒問題,恢復連線後自動同步到伺服器。
<html manifest="notes.manifest">
<head>
<script type="text/javascript" src="server.js"></script>
<script type="text/javascript" src="data.js"></script>
<script type="text/javascript" src="ui.js"></script>
<title>Note List</title>
</head>
<body onload="SyncWithServer()">
<input type="button" value="New Note" onclick="newNote()" />
<ul id="list"></ul>
</body>
</html>
CACHE MANIFEST
index.html
server.js
data.js
ui.js
function newNote() {
var title = window.prompt('New Note:');
if (title) add(title);
}
function add(title) {
addUIItem(title); // 更新畫面
addDataItem(title); // 更新資料
}
function remove(title) {
removeUIItem(title);
removeDataItem(title);
}
function addUIItem(title) {
var item = document.createElement('li');
item.setAttribute('ondblclick', "remove('" + title + "')");
item.innerHTML = title;
document.getElementById('list').appendChild(item);
}
function removeUIItem(title) {
var list = document.getElementById('list');
for (var i = 0; i < list.children.length; i++) {
if (list.children[i].innerHTML == title) {
list.removeChild(list.children[i]);
break;
}
}
}
新增便籤時,newNote() 彈出輸入框,接著呼叫 add() 同時更新畫面與資料;刪除則是雙擊便籤觸發 remove()。
var storage = window['localStorage'];
function addDataItem(title) {
if (navigator.onLine) {
addServerItem(title); // 在線:直接寫入伺服器
} else {
var str = storage.getItem('toAdd'); // 離線:先記在本機
storage.setItem('toAdd', str ? str + ',' + title : title);
}
}
function removeDataItem(title) {
if (navigator.onLine) {
removeServerItem(title);
} else {
var str = storage.getItem('toRemove');
storage.setItem('toRemove', str ? str + ',' + title : title);
}
}
// 恢復連線時,把離線期間的操作補送上去
function SyncWithServer() {
if (navigator.onLine === false) return;
var i, str, items;
str = storage.getItem('toAdd');
if (str != null) {
items = str.split(',');
for (i = 0; i < items.length; i++) addDataItem(items[i]);
storage.removeItem('toAdd');
}
str = storage.getItem('toRemove');
if (str != null) {
items = str.split(',');
for (i = 0; i < items.length; i++) removeDataItem(items[i]);
storage.removeItem('toRemove');
}
// 重繪:清空清單後從伺服器抓回最新狀態
var list = document.getElementById('list');
while (list.lastChild) list.removeChild(list.lastChild);
var allItems = getServerItems();
if (allItems !== '') {
items = allItems.split(',');
for (i = 0; i < items.length; i++) addUIItem(items[i]);
}
}
window.addEventListener('online', SyncWithServer, false);
這個檔案用到了 navigator.onLine、online 事件與 DOM Storage:離線時把待新增/待刪除的項目以逗號串接存進 localStorage,上線後再由 SyncWithServer() 依序補送並重新拉取伺服器上的完整清單。
function addServerItem(title) { /* 在伺服器新增一筆 */ }
function removeServerItem(title) { /* 在伺服器刪除一筆 */ }
function getServerItems() { /* 回傳伺服器上的便籤清單 */ }
這部分依後端實作而異,這裡只定義介面。
離線應用的核心思維是「把不確定的網路當成常態」:資源要能快取、狀態要能偵測、資料要能落地並在機會出現時補同步。cache manifest、DOM Storage 這些具體 API 已有部分被 Service Worker、IndexedDB 取代,但設計思路完全適用。掌握這套思路,你就能做出地鐵裡、飛機上都不至於當機的 Web 應用。