HTML5 進階系列：indexedDB 資料庫

linshuai發表於2017-04-27
HTMLIndex資料庫

前言

在 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

微信讚賞

謝謝支援

相關文章