DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> HTML基礎知識 >> HTML5教程
HTML5 localStorage 完整指南:用法、圖片儲存與自訂過期策略
編輯:HTML5教程     

HTML5 的本地儲存機制讓前端也能存資料,本文從 API 談到實作,包含把圖片存進 localStorage,以及手動加上過期時間的技巧。

一、HTML5 的幾種儲存形式

  • 本地儲存:localStorage 與 sessionStorage
  • 離線快取:Application Cache(已於近年被 Service Worker 取代)
  • 結構化資料庫:IndexedDB 與 WebSQL

二、localStorage 與 sessionStorage 的差別

保存期限:localStorage 是永久儲存,除非手動刪除否則不會失效;sessionStorage 在瀏覽器分頁關閉後即消失。

容量:每個網域約 5MB(實際上限依瀏覽器而異)。這遠高於 cookie 的 4KB,但仍是有限資源,存圖片前請先算一下。

作用範圍:localStorage 同一網域下的分頁共用;sessionStorage 只在單一分頁內有效。

三、API 完全一致

兩者的方法相同:

localStorage.getItem(key);      // 取值
localStorage.setItem(key, val); // 設值
localStorage.removeItem(key);   // 移除單筆
localStorage.key(index);        // 依索引取得 key
localStorage.clear();           // 清空全部
localStorage.length;            // 項目數量

四、能存什麼

陣列、圖片、JSON、樣式、腳本……只要能被序列化成字串就能存。這也是關鍵限制:Web Storage 只認字串,存物件時必須自己 JSON.stringify(),取出時再 JSON.parse() 還原。

五、實作:把圖片存進 localStorage

做法是先把圖片畫進 canvas,再用 toDataURL() 轉成 Base64 字串存起來:

<!DOCTYPE>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Access-Control-Allow-Origin" content="anonymous">
<title>locstorage 圖片存儲</title>
</head>
<body>
</body>
</html>
<script>
var src = 'images/1.png';  // 必須在伺服器環境運行,且圖片需與頁面同源

function set(key) {
    var img = document.createElement('img');   // 建立圖片元素
    img.addEventListener('load', function () { // 綁定載入事件
        var imgcavens = document.createElement('canvas');
        imgcontent = imgcavens.getContext('2d');
        imgcavens.width  = this.width;         // 畫布尺寸等同圖片本身
        imgcavens.height = this.height;
        imgcontent.drawImage(this, 0, 0, this.width, this.height);

        // 轉成 PNG data URI;此方法同樣需在伺服器環境運行
        var imgAsDataUrl = imgcavens.toDataURL('image/png');
        try {
            localStorage.setItem(key, imgAsDataUrl);  // 保存圖片字串
        } catch (e) {
            console.log("storageFaild: " + e);        // 錯誤訊息(通常為容量不足)
        }
    }, false);
    img.src = src;   // 指定要儲存的圖片
}

function get(key) {
    var srcStr = localStorage.getItem(key);   // 取出字串
    var imgobj = document.createElement('img');
    imgobj.src = srcStr;                      // 直接指定為圖片來源
    document.body.appendChild(imgobj);
}
</script>

上述方法在 Firefox 與 Chrome 上都能運行,執行結果如下:

從開發者工具的 Resources 面板可以看到確實存進去了:

此時無論重新整理頁面或關掉瀏覽器再開,剛才存的圖片都還在——除非手動刪除。

要留意的是:這段程式碼必須在伺服器環境(http/https)執行,直接双击檔案用 file:// 開啟會因為 canvas 被汙染而無法呼叫 toDataURL()。另外 try/catch 不是裝飾,5MB 容量很容易在存幾張圖後就爆掉,未捕捉會直接拋出 QuotaExceededError。

六、自訂過期策略

HTML5 沒有為本地儲存提供 TTL 機制,所以過期要自己做。常見做法是存入時一併寫入時間戳,取出時比對:

function set(key, value) {
    var curtime = new Date().getTime();   // 取得當前時間
    localStorage.setItem(key, JSON.stringify({ val: value, time: curtime }));
    /* 說明:
       JSON.parse 用於把字串解析成物件,例如
       var str = '{"name":"huangxiaojian","age":"23"}';
       JSON.parse(str) → Object { name: "huangxiaojian", age: "23" }
       注意:單引號寫在 {} 外,每個屬性名都必須用雙引號,否則會拋出異常。

       JSON.stringify 則是把物件序列化成字串,例如
       var a = { a: 1, b: 2 };
       JSON.stringify(a) → '{"a":1,"b":2}'
    */
}

function get(key, exp) {   // exp 是設定好的過期時間(毫秒)
    var val = localStorage.getItem(key);      // 取得儲存的字串
    var dataobj = JSON.parse(val);            // 解析成物件
    if (new Date().getTime() - dataobj.time > exp) {
        console.log("expires");               // 已過期
        // 實務上通常在此處呼叫 localStorage.removeItem(key)
    } else {
        console.log("val=" + dataobj.val);
    }
}

操作結果如下:

再對照本地儲存的內容,可以看到值已經是包了 val 與 time 的 JSON:

這個範例還有改進空間:過期後並未真正刪除資料,只是回傳提示;若要做到自動清理,可以在 get 判斷過期時順手 removeItem,或在頁面載入時掃一遍全部 key。

結語

整體用下來,HTML5 在本地儲存這塊相當便利,API 直覺、跨平台一致。要注意的三件事是:只能存字串、容量約 5MB、沒有內建過期機制。若資料量大或需要索引查詢,就該改用 IndexedDB 了。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved