使用 HTML5 IndexedDB API-H5教程

IndexedDB API 取代了 Web Storage API，后者在 HTML5 规范中已不推荐使用。（但一些领先的浏览器仍然支持 Web Storage，其中包括苹果公司的 Safari 和 Opera Web 浏览器）与 Web Storage 相比，IndexedDB 具有多个优势，其中包括索引、事务处理和健壮的查询功能。本文将通过一系列的示例来展示如何管理 IndexedDB 数据库。（参见 下载 一节，获取示例的完整源代码。）

重要概念

一个网站可能有一个或多个 IndexedDB 数据库，每个数据库必须具有惟一的名称。

一个数据库可包含一个或多个对象存储。一个对象存储（由一个名称惟一标识）是一个记录集合。每个记录有一个键 和一个值。该值是一个对象，可拥有一个或多个属性。键可能基于某个键生成器，从一个键路径衍生出来，或者是显式设置。一个键生成器自动生成惟一的连续正整数。键路径定义了键值的路径。它可以是单个 JavaScript 标识符或多个由句点分隔的标识符。

规范中包含一个异步 API 和一个同步 API。同步 API 用于 Web 浏览器中。异步 API 使用请求和回调。

在以下示例中，输出附加到一个具有 ID result 的 p 标记上。要更新 result 元素，可在每个数据操作期间清除并设置 innerHTML 属性。每个示例 JavaScript 函数由 HTML 按钮的一个 onclick 事件调用。

处理错误或异常和调试

所有异步请求都有一个 onsuccess 回调和一个 onerror 回调，前者在数据库操作成功时调用，后者在一个操作未成功时调用。清单 1 是一个 onerror 回调的示例。

清单 1. 异步错误处理函数

request.onerror = function(e) {
// handle error
...
console.log("Database error: " + e.target.errorCode);
};

在使用 IndexedDB API 时，使用 JavaScript try/catch 块是一个不错的想法。此功能对处理可能在数据库操作之前发生的错误和异常很有用，比如在数据库未打开时尝试读取或操作数据，或者在另一个读/写事务已打开时尝试写入数据。

IndexedDB 很难调试和排除故障，因为在许多情况下，错误消息是泛泛的，缺乏信息价值。在开发应用程序时，可以使用 console.log 和 JavaScript 调试工具，比如用于 Mozilla Firefox 的 Firebug，或者 Chrome 内置的 Developer Tools。对于任何 JavaScript 密集型应用程序，这些工具的价值是无可估量的，它们尤其适用于使用 IndexedDB API 的 HTML5 应用程序。

使用数据库

一个数据库一次只能有一个版本。在首次创建数据库时，它的初始版本编号为 0。创建数据库之后，数据库（和它的对象存储）只能通过一种称为 versionchange 的特殊类型的事务来更改。要在创建数据库后更改它，必须打开具有更高版本的数据库。此操作会触发 upgradeneeded 事件。修改数据库或对象存储的代码必须位于 upgradeneeded 事件处理函数中。

清单 2 中的代码段展示了如何创建数据库：调用 open 方法并传递数据库名称。如果不存在具有指定名称的数据库，则会创建该数据库。

清单 2. 创建一个新的数据库

function createDatabase() {
var openRequest = localDatabase.indexedDB.open(dbName);

openRequest.onerror = function(e) {
console.log("Database error: " + e.target.errorCode);
};
openRequest.onsuccess = function(event) {
console.log("Database created");
localDatabase.db = openRequest.result;
};
openRequest.onupgradeneeded = function (evt) {
...
};
}

要删除现有数据库，可以调用 deleteDatabase 方法，并传递要删除的数据库名称，如 清单 3 中所示。

清单 3. 删除现有数据库

function deleteDatabase() {
var deleteDbRequest = localDatabase.indexedDB.deleteDatabase(dbName);
deleteDbRequest.onsuccess = function (event) {
// database deleted successfully
};
deleteDbRequest.onerror = function (e) {
console.log("Database error: " + e.target.errorCode);
};
}

清单 4 中的代码段展示了如何打开与现有数据库的连接。

清单 4. 打开数据库的最新版本

function openDatabase() {
var openRequest = localDatabase.indexedDB.open("dbName");
openRequest.onerror = function(e) {
console.log("Database error: " + e.target.errorCode);
};
openRequest.onsuccess = function(event) {

localDatabase.db = openRequest.result;
};
}

创建、删除和打开数据库就是这么简单。现在是时候使用对象存储了。

使用对象存储

对象存储是一个数据记录集合。要在现有数据库中创建一个新对象存储，则需要对现有数据库进行版本控制。为此，请打开要进行版本控制的数据库。除了数据库名称之外，open 方法还接受版本号作为第二个参数。如果希望创建数据库的一个新版本（也就是说，要创建或修改一个对象存储），只需打开具有现有数据库版本更高的数据库。这会调用 onupgradeneeded 事件处理函数。

要创建一个对象存储，可以在数据库对象上调用 createObjectStore 方法，如 清单 5 中所示。

清单 5. 创建对象存储

function createObjectStore() {
var openRequest = localDatabase.indexedDB.open(dbName, 2);
openRequest.onerror = function(e) {
console.log("Database error: " + e.target.errorCode);
};
openRequest.onsuccess = function(event) {
localDatabase.db = openRequest.result;
};
openRequest.onupgradeneeded = function (evt) {
var employeeStore = evt.currentTarget.result.createObjectStore
("employees", {keyPath: "id"});
};
}

我们已经了解了对象存储的工作原理。接下来，让我们看看索引 如何引用包含数据的对象存储。

使用索引

除了使用键来检索对象存储中的记录，还可使用代索引的字段来检索记录。对象存储可具有一个或多个索引。索引是一种特殊的对象存储，它引用包含数据的对象存储，在更改所引用的对象存储时（也就是添加、修改或删除记录时）自动更新。

要创建一个索引，必须使用 清单 5 中所示的方法对数据库进行版本控制。索引可以是惟一的，也可以是不惟一的。惟一索引要求索引中的所有值都是惟一的，比如使用一个电子邮件地址字段。当某个值可以重复出现时，需要使用非惟一索引，比如城市、州或国家。清单 6 中的代码段展示了如何在 employee 对象的 state 字段上创建一个非惟一索引，在 ZIP code 字段上创建一个非惟一索引，并在 email address 字段上创建一个惟一索引：

清单 6. 创建索引

function createIndex() {
var openRequest = localDatabase.indexedDB.open(dbName, 2);
openRequest.onerror = function(e) {
console.log("Database error: " + e.target.errorCode);
};
openRequest.onsuccess = function(event) {
db = openRequest.result;
};
openRequest.onupgradeneeded = function (evt) {
var employeeStore = evt.currentTarget.result.objectStore("employees");
employeeStore.createIndex("stateIndex", "state", { unique: false });
employeeStore.createIndex("emailIndex", "email", { unique: true });
employeeStore.createIndex("zipCodeIndex", "zip_code", { unique: false })
};
}

接下来，您将使用事务对对象存储执行一些操作。

使用事务

您需要使用事务在对象存储上执行所有读取和写入操作。类似于关系数据库中的事务的工作原理，IndexedDB 事务提供了数据库写入操作的一个原子集合，这个集合要么完全提交，要么完全不提交。IndexedDB 事务还拥有数据库操作的一个中止和提交工具。

表 1 列出并描述了 IndexedDB 提供的事务模式。

表 1. IndexedDB 事务模式

默认的事务模式为 readonly。您可在任何给定时刻打开多个并发的 readonly 事务，但只能打开一个 readwrite 事务。出于此原因，只有在数据更新时才考虑使用 readwrite 事务。单独的（表示不能打开任何其他并发事务）versionchange 事务操作一个数据库或对象存储。可以在 onupgradeneeded 事件处理函数中使用 versionchange 事务创建、修改或删除一个对象存储，或者将一个索引添加到对象存储。

要在 readwrite 模式下为 employees 对象存储创建一个事务，可以使用语句：var transaction = db.transaction("employees", "readwrite");。

清单 7 中的 JavaScript 函数展示了如何使用一个事务，使用键来检索 employees 对象存储中的一条特定的员工记录。

清单 7. 使用键获取一个特定的记录

function fetchEmployee() {
try {
var result = document.getElementById("result");
result.innerHTML = "";
if (localDatabase != null && localDatabase.db != null) {
var store = localDatabase.db.transaction("employees").objectStore("employees");
store.get("E3").onsuccess = function(event) {
var employee = event.target.result;
if (employee == null) {
result.value = "employee not found";
}
else {
var jsonStr = JSON.stringify(employee);
result.innerHTML = jsonStr;
}
};
}
}
catch(e){
console.log(e);
}
}

12 / 2 页下一页