HTML5 進階系列：indexedDB 數據庫

前言

在 HTML5 的本地存儲中，有一種叫 indexedDB 的數據庫，該數據庫是一種存儲在客戶端本地的 NoSQL 數據庫，它能夠存儲大量的數據。從上篇：HTML5 進階系列：web Storage ，咱們知道 web Storage 能夠方便靈活的在本地存取簡單數據，可是對於大量結構化存儲，indexedDB 的優點就更加明顯。接下來咱們來看看 indexedDB 如何存儲數據。

鏈接數據庫

一個網站能夠有多個 indexedDB 數據庫，但每一個數據庫的名稱是惟一的。咱們須要經過數據庫名來鏈接某個具體的數據庫。

var request = indexedDB.open('dbName', 1);  // 打開 dbName 數據庫
request.onerror = function(e){              // 監聽鏈接數據庫失敗時執行
    console.log('鏈接數據庫失敗');
}
request.onsuccess = function(e){            // 監聽鏈接數據庫成功時執行
    console.log('鏈接數據庫成功');
}

咱們使用 indexedDB.open 方法來鏈接數據庫，該方法接收兩個參數，第一個是數據庫名，第二個是數據庫版本號。該方法會返回一個 IDBOpenDBRequest 對象，表明一個請求鏈接數據庫的請求對象。咱們能夠經過監聽請求對象的 onsuccess 和 onerror 事件來定義鏈接成功或失敗需執行的方法。

由於 indexedDB API 中不容許數據庫中的數據倉庫在同一版本中發生變化，因此須要在 indexedDB.open 方法中傳入新的版本號來更新版本，避免在同一版本中重複修改數據庫。版本號必須爲整數！

var request = indexedDB.open('dbName', 2);  // 更新版本，打開版本爲2的數據庫
// ...
request.onupgradeneeded = function(e){
    console.log('新數據庫版本號爲=' + e.newVersion);
}

咱們經過監聽請求對象的 onupgradeneeded 事件來定義數據庫版本更新時執行的方法。

關閉數據庫

使用 indexedDB.open 鏈接數據庫成功後會返回一個 IDBOpenDBRequest 對象，咱們能夠調用該對象的 close 方法來關閉數據庫。

var request = indexedDB.open('dbName', 2);
// ...
request.onsuccess = function(e){
    console.log('鏈接數據庫成功');
    var db = e.target.result;
    db.close();
    console.log('數據庫已關閉');
}

刪除數據庫

indexedDB.deleteDatabase('dbName');
console.log('數據庫已刪除');

建立對象倉庫

object store（對象倉庫）是 indexedDB 數據庫的基礎，在indexedDB 中並無數據庫表，而對象倉庫，就是至關於一個數據庫表。

var request = indexedDB.open('dbName', 3);
// ...
request.onupgradeneeded = function(e){
    var db = e.target.result;
    var store = db.createObjectStore('Users', {keyPath: 'userId', autoIncrement: false});
    console.log('建立對象倉庫成功');
}

db.createObjectStore 方法接收兩個參數，第一個爲對象倉庫名，第二個參數爲可選參數，值爲一個js對象。該對象中的 keyPath 屬性爲主鍵，至關於數據庫表中 id 爲主鍵。autoIncrement 屬性爲 false，則表示主鍵值不自增，添加數據時需指定主鍵值。

注意：在數據庫中，對象倉庫名不可重複，不然瀏覽器會報錯。

建立索引

indexedDB 數據庫中經過數據對象的某個屬性來建立索引，在數據庫中進行檢索時，只能經過被設爲索引的屬性進行檢索。

var request = indexedDB.open('dbName', 4);
// ...
request.onupgradeneeded = function(e){
    var db = e.target.result;
    var store = db.createObjectStore('newUsers', {keyPath: 'userId', autoIncrement: false});
    var idx = store.createIndex('usernameIndex','userName',{unique: false})
    console.log('建立索引成功');
}

store.createIndex 方法接收三個參數，第一個爲索引名，第二個爲數據對象的屬性，上例中使用 userName 屬性來建立索引，第三個參數爲可選參數，值爲一個js對象。該對象中的 unique 屬性爲 true，表明索引值不能夠相同，即兩條數據的 userName 不能夠相同，爲 false 則能夠相同。

基於事務

在 indexedDB 中，全部數據操做都只能在事務中執行。鏈接數據庫成功後，可使用 IDBOpenDBRequest 對象的 transaction 方法開啓只讀事務或讀寫事務。

var request = indexedDB.open('dbName', 5);
// ...
request.onupgradeneeded = function(e){
    var db = e.target.result;
    var tx = db.transaction('Users','readonly');
    tx.oncomplete = function(e){
        console.log('事務結束了');
    }
    tx.onabort = function(e){
        console.log('事務被停止了');
    }
}

db.transaction 方法接收兩個參數，第一個參數能夠是字符串或數組，字符串時則是一個對象倉庫名，數組時則是由對象倉庫名組成的數組，transaction 能夠對參數中任何一個對象倉庫進行操做。第二個參數爲事務模式，傳入 readonly 時只能對對象倉庫進行讀操做，沒法寫操做。能夠傳入 readwrite 進行讀寫操做。

操做數據

• add() : 增長數據。接收一個參數，爲須要保存到對象倉庫中的對象。

• put() : 增長或修改數據。接收一個參數，爲須要保存到對象倉庫中的對象。

• get() : 獲取數據。接收一個參數，爲須要獲取數據的主鍵值。

• delete() : 刪除數據。接收一個參數，爲須要獲取數據的主鍵值。

var request = indexedDB.open('dbName', 5);
// ...
request.onsuccess = function(e){
    var db = e.target.result;
    var tx = db.transaction('Users','readwrite');
    var store = tx.objectStore('Users');
    var value = {
        'userId': 1,
        'userName': 'linxin',
        'age': 24
    }
    var req1 = store.put(value);        // 保存數據
    var req2 = store.get(1);            // 獲取索引userId爲1的數據
    req2.onsuccess = function(){
        console.log(this.result.userName);    // linxin
    }
    var req3 = store.delete(1);             // 刪除索引爲1的數據
    req3.onsuccess = function(){
        console.log('刪除數據成功');        // 刪除數據成功
    }
}

add 和 put 的做用相似，區別在於 put 保存數據時，若是該數據的主鍵在數據庫中已經有相同主鍵的時候，則會修改數據庫中對應主鍵的對象，而使用 add 保存數據，若是該主鍵已經存在，則保存失敗。

檢索數據

上面咱們知道使用 get() 方法能夠獲取數據，可是須要制定主鍵值。若是咱們想要獲取一個區間的數據，可使用遊標。遊標經過對象倉庫的 openCursor 方法建立並打開。

openCursor 方法接收兩個參數，第一個是 IDBKeyRange 對象，該對象建立方法主要有如下幾種：

// boundRange 表示主鍵值從1到10(包含1和10)的集合。
// 若是第三個參數爲true，則表示不包含最小鍵值1，若是第四參數爲true，則表示不包含最大鍵值10，默認都爲false
var boundRange = IDBKeyRange.bound(1, 10, false, false);

// onlyRange 表示由一個主鍵值的集合。only() 參數則爲主鍵值，整數類型。
var onlyRange = IDBKeyRange.only(1);

// lowerRaneg 表示大於等於1的主鍵值的集合。
// 第二個參數可選，爲true則表示不包含最小主鍵1，false則包含，默認爲false
var lowerRange = IDBKeyRange.lowerBound(1, false);

// upperRange 表示小於等於10的主鍵值的集合。
// 第二個參數可選，爲true則表示不包含最大主鍵10，false則包含，默認爲false
var upperRange = IDBKeyRange.upperBound(10, false);

openCursor 方法的第二個參數表示遊標的讀取方向，主要有如下幾種：

• next : 遊標中的數據按主鍵值升序排列，主鍵值相等的數據都被讀取

• nextunique : 遊標中的數據按主鍵值升序排列，主鍵值相等只讀取第一條數據

• prev : 遊標中的數據按主鍵值降序排列，主鍵值相等的數據都被讀取

• prevunique : 遊標中的數據按主鍵值降序排列，主鍵值相等只讀取第一條數據

var request = indexedDB.open('dbName', 6);
// ...
request.onsuccess = function(e){
    var db = e.target.result;
    var tx = db.transaction('Users','readwrite');
    var store = tx.objectStore('Users');
    var range = IDBKeyRange.bound(1,10);
    var req = store.openCursor(range, 'next');
    req.onsuccess = function(){
        var cursor = this.result;
        if(cursor){
            console.log(cursor.value.userName);
            cursor.continue();
        }else{
            console.log('檢索結束');
        }
    }
}

當存在符合檢索條件的數據時，能夠經過 update 方法更新該數據：

cursor.updata({
    userId : cursor.key,
    userName : 'Hello',
    age : 18
});

能夠經過 delete 方法刪除該數據：

cursor.delete();

能夠經過 continue 方法繼續讀取下一條數據，不然讀到第一條數據以後再也不繼續讀取：

cursor.continue();

總結

從鏈接數據庫，建立對象倉庫、索引，到操做、檢索數據，完成了 indexedDB 存取數據的完整流程。下面經過一個完整的例子來更好地掌握 indexedDB 數據庫。代碼地址：indexedDB-demo

更多文章：lin-xin/blog