IndexedDB 是 HTML5 的 Web 數據庫,允許 Web 應用在用戶瀏覽器端存儲數據。對於應用來說它非常強大有用,可以在 Chrome、IE、Firefox 等瀏覽器中存儲大量數據。下面把基本概念和實操一次講清楚。
IndexedDB 是 HTML5 新的數據存儲方案,可以在客戶端存儲、操作數據,讓應用加載更快、響應更好。它不同於關系型數據庫那樣擁有數據表和記錄的結構,而是創建帶數據類型、簡單 JavaScript 持久對象的 object store,每個 object 都可以有索引,從而能有效地查詢和遍歷整個集合。它影響著我們設計和創建應用程序的方式。
首先需要做能力檢測並處理各瀏覽器前綴:
var indexedDB = window.indexedDB || window.mozIndexedDB
|| window.webkitIndexedDB || window.msIndexedDB;
// window.IDB 對象的前綴
var IDBTransaction = window.IDBTransaction
|| window.webkitIDBTransaction || window.msIDBTransaction;
var IDBKeyRange = window.IDBKeyRange
|| window.webkitIDBKeyRange || window.msIDBKeyRange;
if (!indexedDB) {
alert("Your browser doesn't support a stable version of IndexedDB.");
}
在創建數據庫之前,我們先準備數據。假設有如下用戶信息:
var userData = [
{ id: "1", name: "Tapas", age: 33, email: "tapas@example.com" },
{ id: "2", name: "Bidulata", age: 55, email: "bidu@home.com" }
];
然後用 open() 方法打開數據庫:
var db;
var request = indexedDB.open("databaseName", 1);
request.onerror = function(e) {
console.log("error: ", e);
};
request.onsuccess = function(e) {
db = request.result;
console.log("success: " + db);
};
request.onupgradeneeded = function(e) {
// 唯一可以變更數據庫結構的地方
};
open() 方法有兩個參數:第一個是數據庫名稱,它會檢測名為「databaseName」的數據庫是否已經存在,存在則打開,否則新建;第二個是數據庫版本號,用於用戶更新數據庫結構。
onsuccess:成功事件觸發時執行,如果所有成功的請求都在此處理,可以通過賦值給 db 變量保存請求結果供以後使用。
onerror:打開數據庫失敗時觸發。
onupgradeneeded:如果你想更新數據庫(創建、刪除或修改),必須實現這個處理程序。這也是唯一可以改動數據庫結構的地方。
IndexedDB 使用對象存儲來存數據,而不是通過表。每當一個值存儲在對象存儲中,它都與一個鍵相關聯;它也允許我們為創建的對象存儲建立索引,索引讓我們能訪問存儲在其中的值。下面的代碼展示如何創建對象存儲並插入預先準備好的數據:
request.onupgradeneeded = function(event) {
var objectStore = event.target.result.createObjectStore("users", { keyPath: "id" });
for (var i in userData) {
objectStore.add(userData[i]);
}
};
createObjectStore() 接受兩個參數:存儲的名稱,以及一個參數對象。這裡我們有一個名為「users」的對象存儲,並定義了 keyPath,它是對象唯一性的屬性。這裡我們用「id」作為 keyPath,這個值在對象存儲中是唯一的,所以必須確保每個對象都存在「id」屬性。創建完成後,就可以用 for 循環把數據添加進去。
function Add() {
var request = db.transaction(["users"], "readwrite")
.objectStore("users")
.add({ id: "3", name: "Gautam", age: 30, email: "gautam@store.org" });
request.onsuccess = function(e) {
alert("Gautam has been added to the database.");
};
request.onerror = function(e) {
alert("Unable to add the information.");
};
}
在數據庫中做任何 CRUD 操作(讀、寫、修改)之前,必須使用事務。transaction() 方法用來指定我們想要進行事務處理的對象存儲,它接受三個參數(第二、三個可選):第一個是要處理的對象存儲列表,第二個指定只讀/讀寫,第三個是版本變化。
get() 方法用於從對象存儲中檢索數據。我們之前已經設置對象的 id 作為 keyPath,所以 get() 會查找具有相同 id 值的對象。下面的代碼將返回我們命名為「Bidulata」的對象:
function Read() {
var objectStore = db.transaction(["users"]).objectStore("users");
var request = objectStore.get("2");
request.onerror = function(event) {
alert("Unable to retrieve data from database!");
};
request.onsuccess = function(event) {
if (request.result) {
alert("Name: " + request.result.name
+ ", Age: " + request.result.age
+ ", Email: " + request.result.email);
} else {
alert("Bidulata couldn't be found in your database!");
}
};
}
下面的方法檢索表中的所有數據,這裡我們使用游標(cursor)來遍歷:
function ReadAll() {
var objectStore = db.transaction("users").objectStore("users");
var req = objectStore.openCursor();
req.onsuccess = function(event) {
db.close();
var res = event.target.result;
if (res) {
alert("Key " + res.key + " is " + res.value.name
+ ", Age: " + res.value.age
+ ", Email: " + res.value.email);
res.continue();
}
};
req.onerror = function (e) {
console.log("Error Getting: ", e);
};
}
openCursor() 用於遍歷數據庫中的多個記錄,在 continue() 函數中繼續讀取下一條記錄。
function Remove() {
var request = db.transaction(["users"], "readwrite")
.objectStore("users")
.delete("1");
request.onsuccess = function(event) {
alert("Tapas's entry has been removed from your database.");
};
}
把對象的 keyPath 作為參數傳遞給 delete() 方法即可。
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>IndexedDB</title>
<script type="text/javascript">
var indexedDB = window.indexedDB || window.mozIndexedDB
|| window.webkitIndexedDB || window.msIndexedDB;
// window.IDB 對象的前綴
var IDBTransaction = window.IDBTransaction
|| window.webkitIDBTransaction || window.msIDBTransaction;
var IDBKeyRange = window.IDBKeyRange
|| window.webkitIDBKeyRange || window.msIDBKeyRange;
if (!indexedDB) {
alert("Your browser doesn't support a stable version of IndexedDB.")
}
var customerData = [
{ id: "1", name: "Tapas", age: 33, email: "tapas@example.com" },
{ id: "2", name: "Bidulata", age: 55, email: "bidu@home.com" }
];
var db;
var request = indexedDB.open("newDatabase", 1);
request.onerror = function(e) {
console.log("error: ", e);
};
request.onsuccess = function(e) {
db = request.result;
console.log("success: "+ db);
};
request.onupgradeneeded = function(event) {
var objectStore = event.target.result.createObjectStore("users", {keyPath: "id"});
for (var i in userData) {
objectStore.add(userData[i]);
}
};
function Add() {
var request = db.transaction(["users"], "readwrite")
.objectStore("users")
.add({ id: "3", name: "Gautam", age: 30, email: "gautam@store.org" });
request.onsuccess = function(e) {
alert("Gautam has been added to the database.");
};
request.onerror = function(e) {
alert("Unable to add the information.");
};
}
function Read() {
var objectStore = db.transaction("users").objectStore("users");
var request = objectStore.get("2");
request.onerror = function(event) {
alert("Unable to retrieve data from database!");
};
request.onsuccess = function(event) {
if(request.result) {
alert("Name: " + request.result.name
+ ", Age: " + request.result.age
+ ", Email: " + request.result.email);
} else {
alert("Bidulata couldn't be found in your database!");
}
};
}
function ReadAll() {
var objectStore = db.transaction("users").objectStore("users");
var req = objectStore.openCursor();
req.onsuccess = function(event) {
db.close();
var res = event.target.result;
if (res) {
alert("Key " + res.key + " is " + res.value.name
+ ", Age: " + res.value.age
+ ", Email: " + res.value.email);
res.continue();
}
};
req.onerror = function (e) {
console.log("Error Getting: ", e);
};
}
function Remove() {
var request = db.transaction(["users"], "readwrite")
.objectStore("users").delete("1");
request.onsuccess = function(event) {
alert("Tapas's entry has been removed from your database.");
};
}
</script>
</head>
<body>
<button onclick="Add()">Add record</button>
<button onclick="Remove()">Delete record</button>
<button onclick="Read()">Retrieve single record</button>
<button onclick="ReadAll()">Retrieve all records</button>
</body>
</html>
localStorage 是不帶 lock 功能的。那麼要實現前端的數據共享並且需要 lock 功能,那就需要使用其它本地存儲方式,比如 IndexedDB。IndexedDB 使用的是事務處理機制,那實際上就是 lock 功能。
做這個測試需要先簡單封裝一下 IndexedDB 的操作,因為 IndexedDB 的連接比較麻煩,而且兩個測試頁面都要用到:
//db.js
// 封裝事務操作
IDBDatabase.prototype.doTransaction = function(f){
f(this.transaction(["Obj"], "readwrite").objectStore("Obj"));
};
// 連接數據庫,成功後調用 main 函數
(function(){
// 打開數據庫
var cn = indexedDB.open("TestDB", 1);
// 創建數據對象
cn.onupgradeneeded = function(e){
e.target.result.createObjectStore("Obj");
};
// 數據庫連接成功
cn.onsuccess = function(e){
main(e.target.result);
};
})();

接著是兩個測試頁面,把 localStorage 換成了 IndexedDB 事務處理,但結果就不同了。測試的時候 b.html 中可能不會立即有輸出,因為 IndexedDB 正忙著處理 a.html 的東西,b.html 的事務丟在了事務隊列中等待。但無論如何,輸出結果也不會是 1 這個值——因為 IndexedDB 的最小處理單位是事務,而不是 localStorage 那樣以表達式為單位。這樣只要把 lock 和 unlock 之間需要處理的東西放入一個事務中即可實現。
另外要注意,瀏覽器對 IndexedDB 的支持不如 localStorage,所以使用時還得考慮瀏覽器兼容。