HTML5 進階系列：indexedDB 數據庫

前言

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

原文作者：林鑫，作者博客：https://github.com/lin-xin/blog

連接數據庫

一個網站可以有多個 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，默認都為falsevar boundRange = IDBKeyRange.bound(1, 10, false, false);// onlyRange 表示由一個主鍵值的集合。only() 參數則為主鍵值，整數類型。var onlyRange = IDBKeyRange.only(1);// lowerRaneg 表示大于等于1的主鍵值的集合。// 第二個參數可選，為true則表示不包含最小主鍵1，false則包含，默認為falsevar lowerRange = IDBKeyRange.lowerBound(1, false);// upperRange 表示小于等于10的主鍵值的集合。// 第二個參數可選，為true則表示不包含最大主鍵10，false則包含，默認為falsevar 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();