做 HTML5 遊戲或任何需要在離線狀態下運作的應用時,本地儲存幾乎是必備能力。本文以一個燃氣監控系統的場景為例——需要保存表計的位置、朝向、開關狀態與表值——實際操作 Cookie、Web Storage、IndexedDB、FileSystem 四種方案,並說明為何第五種 Web SQL Database 已不建議採用。

先談被放棄的那一個:Web SQL Database 雖然仍有瀏覽器支援,也是唯一採用關聯式資料庫結構的儲存方案,但 W3C 早已停止維護。官方文件寫得很明白:
Beware. This specification is no longer in active maintenance and the Web Applications Working Group does not intend to maintain it further.
基於這個理由,新專案不應再採用它。
本示例使用 HT for Web 建置,核心做法是把 DataModel 資料模型序列化後再存入各種媒介,讀取時反向操作:
// 序列化:模型 → JSON 字串 var json = dataModel.serialize(); // 反序列化:JSON 字串 → 模型 dataModel.deserialize(jsonString);
換句話說,不論底層用哪一種儲存方式,真正被存起來的都是同一份 JSON 字串,只是存取介面不同。
最簡單易用的方案,就是 Key-Value 的鍵值對結構。Web Storage 除了持久性的 localStorage,還有針對單次工作階段(session)的 sessionStorage;一般情況下 localStorage 最為常用。規格可參考 https://www.w3.org/TR/webstorage/。
function save(dataModel) {
var value = dataModel.serialize();
window.localStorage["DataModel"] = value;
window.localStorage["DataCount"] = dataModel.size();
console.log(dataModel.size() + " datas are saved");
return value;
}
function restore(dataModel) {
var value = window.localStorage["DataModel"];
if (value) {
dataModel.deserialize(value);
console.log(window.localStorage["DataCount"] + " datas are restored");
return value;
}
return "";
}
function clear() {
if (window.localStorage["DataModel"]) {
console.log(window.localStorage["DataCount"] + " datas are cleared");
delete window.localStorage["DataModel"];
delete window.localStorage["DataCount"];
}
}
最古老的儲存方式。它的容量非常有限(單一名稱約 4KB),存取介面也相當繁瑣——本例中只能勉強存下一個圖元的資訊。為了讓 HTML5 儲存方案的介紹更完整,仍把它列出來對照:
function getCookieValue(name) {
if (document.cookie.length > 0) {
var start = document.cookie.indexOf(name + "=");
if (start !== -1) {
start = start + name.length + 1;
var end = document.cookie.indexOf(";", start);
if (end === -1) {
end = document.cookie.length;
}
return unescape(document.cookie.substring(start, end));
}
}
return "";
}
function save(dataModel) {
var value = dataModel.serialize();
document.cookie = "DataModel=" + escape(value);
document.cookie = "DataCount=" + dataModel.size();
console.log(dataModel.size() + " datas are saved");
return value;
}
function restore(dataModel) {
var value = getCookieValue("DataModel");
if (value) {
dataModel.deserialize(value);
console.log(getCookieValue("DataCount") + " datas are restored");
return value;
}
return "";
}
function clear() {
if (getCookieValue("DataModel")) {
console.log(getCookieValue("DataCount") + " datas are cleared");
document.cookie = "DataModel=; expires=Thu, 01 Jan 1970 00:00:00 UTC";
document.cookie = "DataCount=; expires=Thu, 01 Jan 1970 00:00:00 UTC";
}
}
順帶一提,Cookie 有個 localStorage 沒有的特性:可以設定 expires 或 max-age 指定存活時間,也能設定 path、domain 控制作用範圍,並會自動隨請求送往伺服器。這些特性在某些情境(例如維持登入狀態)反而是必要的,但對純用戶端的資料保存來說就是額外負擔。
目前最實用強大的方案。IndexedDB 可以直接儲存結構化物件,並能以 key 與 index 建立索引來查詢,各大瀏覽器也已逐漸支援。
要注意的是,IndexedDB 的介面大量採用類似 Node.js 的非同步回呼風格——就連查詢時呼叫 cursor 的 continue(),也是透過再次回呼 onsuccess 來推進。這使得它寫起來不如同步程式碼直覺,需要多花一點心思安排流程。
var request = indexedDB.open("DataModel");
request.onupgradeneeded = function () {
db = request.result;
var store = db.createObjectStore("meters", { keyPath: "id" });
store.createIndex("by_tag", "tag", { unique: true });
store.createIndex("by_name", "name");
};
request.onsuccess = function () {
db = request.result;
};
function save(dataModel) {
var tx = db.transaction("meters", "readwrite");
var store = tx.objectStore("meters");
dataModel.each(function (data) {
store.put({
id: data.getId(),
tag: data.getTag(),
name: data.getName(),
meterValue: data.a("meter.value"),
meterAngle: data.a("meter.angle"),
p3: data.p3(),
r3: data.r3(),
s3: data.s3()
});
});
tx.oncomplete = function () {
console.log(dataModel.size() + " datas are saved");
};
return dataModel.serialize();
}
function restore(dataModel) {
var tx = db.transaction("meters", "readonly");
var store = tx.objectStore("meters");
var req = store.openCursor();
var nodes = [];
req.onsuccess = function () {
var res = req.result;
if (res) {
var value = res.value;
var node = createNode();
node.setId(value.id);
node.setTag(value.tag);
node.setName(value.name);
node.a({
"meter.value": value.meterValue,
"meter.angle": value.meterAngle
});
node.p3(value.p3);
node.r3(value.r3);
node.s3(value.s3);
nodes.push(node);
res.continue();
} else {
if (nodes.length) {
dataModel.clear();
nodes.forEach(function (node) { dataModel.add(node); });
console.log(dataModel.size() + " datas are restored");
}
}
};
return "";
}
function clear() {
var tx = db.transaction("meters", "readwrite");
var store = tx.objectStore("meters");
var req = store.openCursor();
var count = 0;
req.onsuccess = function (event) {
var res = event.target.result;
if (res) {
store.delete(res.value.id);
res.continue();
count++;
} else {
console.log(count + " datas are cleared");
}
};
}
這相當於直接操作本地檔案的儲存方式,但支援的瀏覽器不多,介面標準仍在演進中。例如本文撰寫時,多數文獻使用的 webkitStorageInfo 已被 navigator.webkitPersistentStorage 與 navigator.webkitTemporaryStorage 取代。
儲存的檔案可以透過 filesystem:https://www.example.com/persistent/meters.txt 這種 URL 在 Chrome 中找到,甚至能以類似目錄的方式瀏覽。這開啟了一個有趣的應用方向:動態產生圖片寫入本地檔案,再把 filesystem:https://... 的 URL 直接指定給 img 元素的 src。
navigator.webkitPersistentStorage.queryUsageAndQuota(function (usage, quota) {
console.log("PERSISTENT: " + usage + "/" + quota + " - " + usage / quota + "%");
});
navigator.webkitPersistentStorage.requestQuota(2 * 1024 * 1024, function (grantedBytes) {
window.webkitRequestFileSystem(window.PERSISTENT, grantedBytes, function (fs) {
window.fs = fs;
});
});
function save(dataModel) {
var value = dataModel.serialize();
fs.root.getFile("meters.txt", { create: true }, function (fileEntry) {
console.log(fileEntry.toURL());
fileEntry.createWriter(function (fileWriter) {
fileWriter.onwriteend = function () {
console.log(dataModel.size() + " datas are saved");
};
var blob = new Blob([value], { type: "text/plain" });
fileWriter.write(blob);
});
});
return value;
}
function restore(dataModel) {
fs.root.getFile("meters.txt", {}, function (fileEntry) {
fileEntry.file(function (file) {
var reader = new FileReader();
reader.onloadend = function (e) {
dataModel.clear();
dataModel.deserialize(reader.result);
console.log(dataModel.size() + " datas are restored");
};
reader.readAsText(file);
});
});
return "";
}
function clear() {
fs.root.getFile("meters.txt", { create: false }, function (fileEntry) {
fileEntry.remove(function () {
console.log(fileEntry.toURL() + " is removed");
});
});
}

把上面的實作放在一起看,結論其實相當清楚:
Browser-Side 的儲存技術仍在快速演進,除了上述幾種之外還有 Application Cache(同樣已被 Service Worker 取代)。可以預期未來仍會有新方案出現。
雖然「雲端化」是大趨勢,但用戶端並不必然要走向極端的「瘦」客戶端。這麼多年來各種本地儲存方案層出不窮,說明了「讓客戶端更強大」的市場需求是真實存在的。當然,目前這個過渡階段最辛苦的是前端工程師:除了要適配滑鼠與觸控、適配各種螢幕尺寸,現在還得考慮適配各種儲存 API。希望這份整理能在你選擇用戶端儲存方案時派上用場。