DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> HTML基礎知識 >> HTML5教程
HTML5 IndexedDB 入門實作:一個待辦清單的完整範例
編輯:HTML5教程     

IndexedDB 是瀏覽器端儲存大量結構化資料的 API,容量遠大於 localStorage,還支援索引查詢。它的介面是全非同步的,每一個操作都會產生一個「請求」物件,需要掛上 onsuccess/onerror 處理結果。熟悉這個模式之後,用起来其實很直覺。

整體流程

  1. 開啟(或建立)資料庫,必要時升級版本並建立物件倉庫。
  2. 建立 transaction 與 objectStore。
  3. 執行 put/get/delete/openCursor 等操作,並在回呼中處理結果。

步驟一:開啟資料庫

var indexedDB = window.indexedDB || window.webkitIndexedDB || window.mozIndexedDB;

if ('webkitIndexedDB' in window) {
    window.IDBTransaction = window.webkitIDBTransaction;
    window.IDBKeyRange = window.webkitIDBKeyRange;
}

var request = indexedDB.open("adsageIDB");   // open 是 indexedDB 唯一的連線方法

request.onsuccess = function (e) {
    var v = "1.00";
    var db = e.target.result;

    if (v != db.version) {
        var setVrequest = db.setVersion(v);
        setVrequest.onsuccess = function (e) {
            if (db.objectStoreNames.contains("todo")) {
                db.deleteObjectStore("todo");
            }
            // 建立物件倉庫,keyPath 指定主鍵欄位
            var store = db.createObjectStore("todo", { keyPath: "adsid" });
        };
    }
};

關於版本管理的補充:範例用的是舊版 setVersion() 寫法,目前標準做法是在 open() 的第二個參數指定版本號,並在 onupgradeneeded 事件中建立或修改物件倉庫:

var request = indexedDB.open("adsageIDB", 1);

request.onupgradeneeded = function (e) {
    var db = e.target.result;
    if (!db.objectStoreNames.contains("todo")) {
        db.createObjectStore("todo", { keyPath: "adsid" });
    }
};
request.onsuccess = function (e) { db = e.target.result; };
request.onerror   = function (e) { console.log(e); };

步驟二:新增資料

// 插入數據
var trans = db.transaction(["todo"], IDBTransaction.READ_WRITE);
var store = trans.objectStore("todo");
// 操作資料前必須先建立 transaction 與 store

var data = {
    "text": todoText,
    "adsid": new Date().getTime()   // adsid 是主鍵
};

var request = store.put(data);      // put 為「有則更新、無則新增」

request.onsuccess = function (e) {
    // 成功後的一些操作
};
request.onerror = function (e) {
    console.log("Error Adding: ", e);
};

若要嚴格「只新增、遇到主鍵衝突就失敗」,改用 store.add(data) 即可。

步驟三:讀取資料

// 讀取數據
var trans = db.transaction(["todo"], IDBTransaction.READ_WRITE);
var store = trans.objectStore("todo");

var keyRange = IDBKeyRange.lowerBound(0);
var cursorRequest = store.openCursor(keyRange);
// openCursor 的參數是遍歷範圍,另外還可傳入方向參數(next / prev / nextunique / prevunique)

cursorRequest.onsuccess = function (e) {
    var result = e.target.result;
    if (!!result == false)
        return;
    console.log(result.value);
    result.continue();   // 呼叫 continue 才會進入下一筆,直到游標到底
};

若只要按主鍵取單筆,用 store.get('鍵值') 更簡單。游標的價值在於可以遍歷、可以搭配 IDBKeyRange.bound() 做範圍查詢,也可以在遍歷過程中修改或刪除紀錄。

步驟四:刪除資料

// 刪除數據
store.delete('鍵值');

完整 DEMO

<!DOCTYPE html>
<html>
<head>
<script>
var indexedDB = window.indexedDB || window.webkitIndexedDB || window.mozIndexedDB;

if ('webkitIndexedDB' in window) {
    window.IDBTransaction = window.webkitIDBTransaction;
    window.IDBKeyRange = window.webkitIDBKeyRange;
}

adsageIDB = {};
adsageIDB.db = null;

adsageIDB.onerror = function (e) {
    console.log(e);
};

adsageIDB.open = function () {
    var request = indexedDB.open("adsageIDB");

    request.onsuccess = function (e) {
        var v = "1.00";
        adsageIDB.db = e.target.result;
        var db = adsageIDB.db;

        if (v != db.version) {
            var setVrequest = db.setVersion(v);

            setVrequest.onerror = adsageIDB.onerror;
            setVrequest.onsuccess = function (e) {
                if (db.objectStoreNames.contains("todo")) {
                    db.deleteObjectStore("todo");
                }
                var store = db.createObjectStore("todo", { keyPath: "adsid" });
                adsageIDB.getAllTodoItems();
            };
        } else {
            adsageIDB.getAllTodoItems();
        }
    };

    request.onerror = adsageIDB.onerror;
};

adsageIDB.addTodo = function (todoText) {
    var db = adsageIDB.db;
    var trans = db.transaction(["todo"], IDBTransaction.READ_WRITE);
    var store = trans.objectStore("todo");

    var data = {
        "text": todoText,
        "adsid": new Date().getTime()
    };

    var request = store.put(data);

    request.onsuccess = function (e) {
        adsageIDB.getAllTodoItems();
    };
    request.onerror = function (e) {
        console.log("Error Adding: ", e);
    };
};

adsageIDB.deleteTodo = function (id) {
    var db = adsageIDB.db;
    var trans = db.transaction(["todo"], IDBTransaction.READ_WRITE);
    var store = trans.objectStore("todo");

    var request = store.delete(id);

    request.onsuccess = function (e) {
        adsageIDB.getAllTodoItems();
    };
    request.onerror = function (e) {
        console.log("Error Deleting: ", e);
    };
};

adsageIDB.getAllTodoItems = function () {
    var todos = document.getElementById("todoItems");
    todos.innerHTML = "";

    var db = adsageIDB.db;
    var trans = db.transaction(["todo"], IDBTransaction.READ_WRITE);
    var store = trans.objectStore("todo");

    var keyRange = IDBKeyRange.lowerBound(0);
    var cursorRequest = store.openCursor(keyRange);

    cursorRequest.onsuccess = function (e) {
        var result = e.target.result;
        if (!!result == false)
            return;

        renderTodo(result.value);
        result.continue();
    };

    cursorRequest.onerror = adsageIDB.onerror;
};

function renderTodo(row) {
    var todos = document.getElementById("todoItems");
    var li = document.createElement("li");
    var a = document.createElement("a");
    var t = document.createTextNode(row.text);

    a.addEventListener("click", function () {
        adsageIDB.deleteTodo(row.adsid);
    }, false);

    a.textContent = " [刪除]";
    li.appendChild(t);
    li.appendChild(a);
    todos.appendChild(li);
}

function addTodo() {
    var todo = document.getElementById("todo");
    adsageIDB.addTodo(todo.value);
    todo.value = "";
}

function init() {
    adsageIDB.open();
}

window.addEventListener("DOMContentLoaded", init, false);
</script>
</head>
<body>
  <ul id="todoItems"></ul>
  <input type="text" id="todo" name="todo" placeholder="adsageIDB text?" />
  <input type="submit" value="增加一個 IDB" onclick="addTodo(); return false;" />
</body>
</html>

幾個實務提醒

transaction 會自動結束。在一個 transaction 的 onsuccess 之後再去用它下新的請求,會丟出 TransactionInactiveError。若需要連續操作,請在新的 task 中重建 transaction,或善用 transaction 自身的 oncomplete。

用 Promise 包一層會清爽很多。原生 API 全是回呼,巢狀一深就很難讀。實務上通常會寫成 openDB().then(db => db.add(...)) 這樣的鏈式呼叫,或直接採用 idb 這類輕量函式庫。

資料會被使用者清掉。清除瀏覽器資料、無痕模式關閉、儲存空間不足配額時,IndexedDB 內容都可能消失。重要資料仍應與伺服器同步,不要當成唯一來源。

整體來說,IndexedDB 雖然入門門檻比 localStorage 高,但在需要儲存大量結構化資料、需要索引查詢的場景下,它是瀏覽器端唯一的正解。原文作者:androidshouce。

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