HTML5 定義的 Web Storage 已經獲得廣泛支援。它其實分成兩大類:一類是類似 key-value 的簡單對應,另一類是用 SQL(SQLite)查詢的儲存方式。
key-value 這類又細分為 sessionStorage 與 localStorage 兩種;使用 SQL 的那一種,書中稱為 Web SQL Database。
瀏覽器支援情況(如上圖)
window.sessionStorage.setItem('myFirstKey', 'myFirstValue');
window.sessionStorage.myFirstKey = 'myFirstValue'; // 兩種寫法等價
var myFirstValue = window.sessionStorage.getItem('myFirstKey');
var myFirstValue = window.sessionStorage.myFirstKey; // 兩種寫法等價
用 sessionStorage 存入的資料,只在該視窗或分頁關閉之前有效;它的作用域被限制在單一視窗或分頁之內。
length:物件中已存儲的鍵值對數量。
key(index):回傳指定索引的 key,常用來遍歷已存入的內容,index 從 0 開始。
getItem(key):回傳指定 key 的 value,key 不存在時回傳 null。
setItem(key, value):存入一筆資料;若 key 已存在則取代原值。請注意,當使用者關閉離線儲存功能或儲存空間已滿時,這個操作會丟出例外。
removeItem(key):刪除指定的 key。
clear():清空所有資料。
標準建議的上限是每個 origin 5 MB,但達到限制時各瀏覽器的反應不同:有些會提示使用者配置更多空間,有些則直接丟出 QUOTA_EXCEEDED_ERR 例外。寫入大量資料前,記得把這個差異納入考量。
如果你想在多個頁面(或 web worker)之間同步儲存資料,或想在資料寫入成功時觸發某些操作,就可以使用 Storage API 提供的事件。這個事件會在同源的每一個 window 物件上觸發。
window.addEventListener("storage", displayStorageEvent, true);
事件物件具有下列屬性:
interface StorageEvent : Event {
readonly attribute DOMString key;
readonly attribute any oldValue;
readonly attribute any newValue;
readonly attribute DOMString url;
readonly attribute Storage storageArea;
};
key:發生變動的 key。
oldValue:變動前的值。若是新增資料,oldValue 為 null;若是刪除資料,newValue 為 null。
url:儲存物件的 origin。
storageArea:指向值發生變動的 sessionStorage 或 localStorage 物件。
localStorage 與 sessionStorage 幾乎完全相同,差別只有兩點:
就某種意義來說,localStorage 有點像 C++ 裡的靜態成員變數:宣告一次,之後整個程式(此處指整個 origin)都拿得到同一份值。
// 顯示一筆 storage 事件的內容
function displayStorageEvent(e) {
var logged = "key:" + e.key + ", newValue:" + e.newValue
+ ", oldValue:" + e.oldValue + ", url:" + e.url
+ ", storageArea:" + e.storageArea;
alert(logged);
}
// 為此 origin 註冊 storage 事件監聽器
window.addEventListener("storage", displayStorageEvent, true);
書中也有提到 Web SQL Database。由於它把語法綁死在 SQLite 上,Firefox 遲遲不願支援;加上後來已有新的標準 Indexed Database(WebSimpleDB)打算取而代之,原書也只做了簡單介紹,這裡就一併略過。
雖然標準允許 sessionStorage 與 localStorage 存入任意物件,但部分瀏覽器實際上只接受字串。比較保險的做法,是先用 JSON 把物件序列化再存,取出後再 parse 回來。