HTML5 的 Web Storage 提供兩個 storage 物件:sessionStorage 與 localStorage。兩者的 API 完全一樣,差別只在「資料活多久」。
sessionStorage 不是持久化存儲,它屬於會話層級:只要那個分頁還開著,資料就在;分頁關掉,資料隨之消失。同一個 origin 開啟的分頁之間彼此不共享各自的 sessionStorage。
localStorage 則是持久化存儲,除非你主動刪除,否則資料不會過期,瀏覽器重開、電腦重開都還在。
Web Storage 的概念和 Cookie 相似,但它是為「更大容量的存儲」而設計的。Cookie 有明顯的限制:容量很小,而且每次請求新頁面時都會被動地附在 HTTP 標頭裡送出去,無形中浪費頻寬;Cookie 還需要指定作用域,無法跨域調用。
此外,Web Storage 內建 setItem、getItem、removeItem、clear 等方法,不必像 Cookie 那樣自己封裝 setCookie、getCookie 與字串解析。
但 Cookie 依然有其不可取代的位置:Cookie 的作用是「與伺服器互動」,是 HTTP 規範的一部分;而 Web Storage 純粹是為了在瀏覽器本地存資料而生。需要讓伺服器知道的身份識別資訊(例如 session id)仍應走 Cookie。
除了 IE7 及以下版本,其他標準瀏覽器都完整支援(IE 與 Firefox 需在 web 伺服器環境下執行,直接以 file:// 開啟可能受限)。有趣的是,IE6/IE7 中的 userData 行?为其实就是微軟自己的一套本地存儲方案,透過簡單的程式碼封裝,可以把它們統一歸納到 Web Storage 的介面下。
要判斷瀏覽器是否支援 localStorage,可以這樣寫:
if (window.localStorage) {
alert("瀏覽器支援 localStorage");
} else {
alert("瀏覽器暫不支援 localStorage");
}
// 或者
if (typeof window.localStorage == 'undefined') {
alert("瀏覽器暫不支援 localStorage");
}
localStorage 與 sessionStorage 的方法完全相同。
用途:把 value 存到指定的 key 底下。寫法:.setItem(key, value)
sessionStorage.setItem("key", "value");
localStorage.setItem("site", "example.com");
用途:取得指定 key 的值。寫法:.getItem(key)
var value = sessionStorage.getItem("key");
var site = localStorage.getItem("site");
用途:刪除指定的 key。寫法:.removeItem(key)
sessionStorage.removeItem("key");
localStorage.removeItem("site");
用途:清除該 storage 底下的所有 key/value。寫法:.clear()
sessionStorage.clear();
localStorage.clear();
除了自身的方法,Web Storage 也支援點(.)運算子與中括號寫法:
var storage = window.localStorage;
storage.key1 = "hello";
storage["key2"] = "world";
console.log(storage.key1);
console.log(storage["key2"]);
不過實務上仍建議用 setItem/getItem,因為物件寫法容易與 storage 內建的屬性或方法名(例如 length、key、setItem)撞名,造成難以察覺的 bug。
var storage = window.localStorage;
for (var i = 0, len = storage.length; i < len; i++) {
var key = storage.key(i);
var value = storage.getItem(key);
console.log(key + "=" + value);
}
storage 還提供了 storage 事件。當某個 key 被新增、修改、移除,或呼叫 clear() 時就會觸發。這是實作「多個分頁即時同步」最省事的做法:
if (window.addEventListener) {
window.addEventListener("storage", handle_storage, false);
} else if (window.attachEvent) {
window.attachEvent("onstorage", handle_storage);
}
function handle_storage(e) {
if (!e) { e = window.event; }
// 在這裡處理同步邏輯
}
事件物件上可以取用的屬性如下:
有幾個細節值得注意。第一,storage 事件不會在同一個頁面內觸發,只會在其他同源分頁中觸發,所以要更新當前頁面的畫面,仍得自己呼叫一次更新函式。第二,Web Storage 只能存字串,存物件、陣列時要用 JSON.stringify 轉字串,取出後再 JSON.parse 還原,否則你會拿到 "[object Object]"。第三,容量雖比 Cookie 大得多(一般為 5MB 上下,各家瀏覽器略有差異),但依然是有限的,寫入接近上限時會拋出 QuotaExceededError,記得包上 try/catch。最後,localStorage 是同步 API,寫入频繁會阻塞主執行緒,大量資料或高頻情境請改用 IndexedDB。