HTML5 進(jìn)階系列：indexedDB 數(shù)據(jù)庫

前言

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

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

連接數(shù)據(jù)庫

一個網(wǎng)站可以有多個 indexedDB 數(shù)據(jù)庫，但每個數(shù)據(jù)庫的名稱是唯一的。我們需要通過數(shù)據(jù)庫名來連接某個具體的數(shù)據(jù)庫。

var request = indexedDB.open('dbName', 1);  // 打開 dbName 數(shù)據(jù)庫request.onerror = function(e){              // 監(jiān)聽連接數(shù)據(jù)庫失敗時執(zhí)行
    console.log('連接數(shù)據(jù)庫失敗');}request.onsuccess = function(e){            // 監(jiān)聽連接數(shù)據(jù)庫成功時執(zhí)行
    console.log('連接數(shù)據(jù)庫成功');}

我們使用 indexedDB.open 方法來連接數(shù)據(jù)庫，該方法接收兩個參數(shù)，第一個是數(shù)據(jù)庫名，第二個是數(shù)據(jù)庫版本號。該方法會返回一個 IDBOpenDBRequest 對象，代表一個請求連接數(shù)據(jù)庫的請求對象。我們可以通過監(jiān)聽請求對象的 onsuccess 和 onerror 事件來定義連接成功或失敗需執(zhí)行的方法。

因為 indexedDB API 中不允許數(shù)據(jù)庫中的數(shù)據(jù)倉庫在同一版本中發(fā)生變化，所以需要在 indexedDB.open 方法中傳入新的版本號來更新版本，避免在同一版本中重復(fù)修改數(shù)據(jù)庫。版本號必須為整數(shù)！

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

我們通過監(jiān)聽請求對象的 onupgradeneeded 事件來定義數(shù)據(jù)庫版本更新時執(zhí)行的方法。

關(guān)閉數(shù)據(jù)庫

使用 indexedDB.open 連接數(shù)據(jù)庫成功后會返回一個 IDBOpenDBRequest 對象，我們可以調(diào)用該對象的 close 方法來關(guān)閉數(shù)據(jù)庫。

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

刪除數(shù)據(jù)庫

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

創(chuàng)建對象倉庫

object store（對象倉庫）是 indexedDB 數(shù)據(jù)庫的基礎(chǔ)，在indexedDB 中并沒有數(shù)據(jù)庫表，而對象倉庫，就是相當(dāng)于一個數(shù)據(jù)庫表。

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('創(chuàng)建對象倉庫成功');}

db.createObjectStore 方法接收兩個參數(shù)，第一個為對象倉庫名，第二個參數(shù)為可選參數(shù)，值為一個js對象。該對象中的 keyPath 屬性為主鍵，相當(dāng)于數(shù)據(jù)庫表中 id 為主鍵。autoIncrement 屬性為 false，則表示主鍵值不自增，添加數(shù)據(jù)時需指定主鍵值。

注意：在數(shù)據(jù)庫中，對象倉庫名不可重復(fù)，否則瀏覽器會報錯。

創(chuàng)建索引

indexedDB 數(shù)據(jù)庫中通過數(shù)據(jù)對象的某個屬性來創(chuàng)建索引，在數(shù)據(jù)庫中進(jìn)行檢索時，只能通過被設(shè)為索引的屬性進(jìn)行檢索。

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('創(chuàng)建索引成功');}

store.createIndex 方法接收三個參數(shù)，第一個為索引名，第二個為數(shù)據(jù)對象的屬性，上例中使用 userName 屬性來創(chuàng)建索引，第三個參數(shù)為可選參數(shù)，值為一個js對象。該對象中的 unique 屬性為 true，代表索引值不可以相同，即兩條數(shù)據(jù)的 userName 不可以相同，為 false 則可以相同。

基于事務(wù)

在 indexedDB 中，所有數(shù)據(jù)操作都只能在事務(wù)中執(zhí)行。連接數(shù)據(jù)庫成功后，可以使用 IDBOpenDBRequest 對象的 transaction 方法開啟只讀事務(wù)或讀寫事務(wù)。

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('事務(wù)結(jié)束了');
    }
    tx.onabort = function(e){
        console.log('事務(wù)被中止了');
    }}

db.transaction 方法接收兩個參數(shù)，第一個參數(shù)可以是字符串或數(shù)組，字符串時則是一個對象倉庫名，數(shù)組時則是由對象倉庫名組成的數(shù)組，transaction 可以對參數(shù)中任何一個對象倉庫進(jìn)行操作。第二個參數(shù)為事務(wù)模式，傳入 readonly 時只能對對象倉庫進(jìn)行讀操作，無法寫操作?？梢詡魅?readwrite 進(jìn)行讀寫操作。

操作數(shù)據(jù)

• add() : 增加數(shù)據(jù)。接收一個參數(shù)，為需要保存到對象倉庫中的對象。

• put() : 增加或修改數(shù)據(jù)。接收一個參數(shù)，為需要保存到對象倉庫中的對象。

• get() : 獲取數(shù)據(jù)。接收一個參數(shù)，為需要獲取數(shù)據(jù)的主鍵值。

• delete() : 刪除數(shù)據(jù)。接收一個參數(shù)，為需要獲取數(shù)據(jù)的主鍵值。

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);        // 保存數(shù)據(jù)
    var req2 = store.get(1);            // 獲取索引userId為1的數(shù)據(jù)
    req2.onsuccess = function(){
        console.log(this.result.userName);  // linxin
    }
    var req3 = store.delete(1);             // 刪除索引為1的數(shù)據(jù)
    req3.onsuccess = function(){
        console.log('刪除數(shù)據(jù)成功');        // 刪除數(shù)據(jù)成功
    }}

add 和 put 的作用類似，區(qū)別在于 put 保存數(shù)據(jù)時，如果該數(shù)據(jù)的主鍵在數(shù)據(jù)庫中已經(jīng)有相同主鍵的時候，則會修改數(shù)據(jù)庫中對應(yīng)主鍵的對象，而使用 add 保存數(shù)據(jù)，如果該主鍵已經(jīng)存在，則保存失敗。

檢索數(shù)據(jù)

上面我們知道使用 get() 方法可以獲取數(shù)據(jù)，但是需要制定主鍵值。如果我們想要獲取一個區(qū)間的數(shù)據(jù)，可以使用游標(biāo)。游標(biāo)通過對象倉庫的 openCursor 方法創(chuàng)建并打開。

openCursor 方法接收兩個參數(shù)，第一個是 IDBKeyRange 對象，該對象創(chuàng)建方法主要有以下幾種：

// boundRange 表示主鍵值從1到10(包含1和10)的集合。// 如果第三個參數(shù)為true，則表示不包含最小鍵值1，如果第四參數(shù)為true，則表示不包含最大鍵值10，默認(rèn)都為falsevar boundRange = IDBKeyRange.bound(1, 10, false, false);// onlyRange 表示由一個主鍵值的集合。only() 參數(shù)則為主鍵值，整數(shù)類型。var onlyRange = IDBKeyRange.only(1);// lowerRaneg 表示大于等于1的主鍵值的集合。// 第二個參數(shù)可選，為true則表示不包含最小主鍵1，false則包含，默認(rèn)為falsevar lowerRange = IDBKeyRange.lowerBound(1, false);// upperRange 表示小于等于10的主鍵值的集合。// 第二個參數(shù)可選，為true則表示不包含最大主鍵10，false則包含，默認(rèn)為falsevar upperRange = IDBKeyRange.upperBound(10, false);

openCursor 方法的第二個參數(shù)表示游標(biāo)的讀取方向，主要有以下幾種：

• next : 游標(biāo)中的數(shù)據(jù)按主鍵值升序排列，主鍵值相等的數(shù)據(jù)都被讀取

• nextunique : 游標(biāo)中的數(shù)據(jù)按主鍵值升序排列，主鍵值相等只讀取第一條數(shù)據(jù)

• prev : 游標(biāo)中的數(shù)據(jù)按主鍵值降序排列，主鍵值相等的數(shù)據(jù)都被讀取

• prevunique : 游標(biāo)中的數(shù)據(jù)按主鍵值降序排列，主鍵值相等只讀取第一條數(shù)據(jù)

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('檢索結(jié)束');
        }
    }}

當(dāng)存在符合檢索條件的數(shù)據(jù)時，可以通過 update 方法更新該數(shù)據(jù)：

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

可以通過 delete 方法刪除該數(shù)據(jù)：

cursor.delete();

可以通過 continue 方法繼續(xù)讀取下一條數(shù)據(jù)，否則讀到第一條數(shù)據(jù)之后不再繼續(xù)讀?。?/p>

cursor.continue();