操作流程

IndexedDB 数据库的各种操作,一般是按照下面的流程进行的。这个部分只给出简单的代码示例,用于快速上手,详细的各个对象的 API 放在后文介绍。

打开数据库

使用 IndexedDB 的第一步是打开数据库,使用indexedDB.open()方法。

  1. var request = window.indexedDB.open(databaseName, version);

这个方法接受两个参数,第一个参数是字符串,表示数据库的名字。如果指定的数据库不存在,就会新建数据库。第二个参数是整数,表示数据库的版本。如果省略,打开已有数据库时,默认为当前版本;新建数据库时,默认为1

indexedDB.open()方法返回一个 IDBRequest 对象。这个对象通过三种事件errorsuccessupgradeneeded,处理打开数据库的操作结果。

(1)error 事件

error事件表示打开数据库失败。

  1. request.onerror = function (event) {
  2. console.log('数据库打开报错');
  3. };

(2)success 事件

success事件表示成功打开数据库。

  1. var db;
  2. request.onsuccess = function (event) {
  3. db = request.result;
  4. console.log('数据库打开成功');
  5. };

这时,通过request对象的result属性拿到数据库对象。

(3)upgradeneeded 事件

如果指定的版本号,大于数据库的实际版本号,就会发生数据库升级事件upgradeneeded

  1. var db;
  2. request.onupgradeneeded = function (event) {
  3. db = event.target.result;
  4. }

这时通过事件对象的target.result属性,拿到数据库实例。

新建数据库

新建数据库与打开数据库是同一个操作。如果指定的数据库不存在,就会新建。不同之处在于,后续的操作主要在upgradeneeded事件的监听函数里面完成,因为这时版本从无到有,所以会触发这个事件。

通常,新建数据库以后,第一件事是新建对象仓库(即新建表)。

  1. request.onupgradeneeded = function(event) {
  2. db = event.target.result;
  3. var objectStore = db.createObjectStore('person', { keyPath: 'id' });
  4. }

上面代码中,数据库新建成功以后,新增一张叫做person的表格,主键是id

更好的写法是先判断一下,这张表格是否存在,如果不存在再新建。

  1. request.onupgradeneeded = function (event) {
  2. db = event.target.result;
  3. var objectStore;
  4. if (!db.objectStoreNames.contains('person')) {
  5. objectStore = db.createObjectStore('person', { keyPath: 'id' });
  6. }
  7. }

主键(key)是默认建立索引的属性。比如,数据记录是{ id: 1, name: '张三' },那么id属性可以作为主键。主键也可以指定为下一层对象的属性,比如{ foo: { bar: 'baz' } }foo.bar也可以指定为主键。

如果数据记录里面没有合适作为主键的属性,那么可以让 IndexedDB 自动生成主键。

  1. var objectStore = db.createObjectStore(
  2. 'person',
  3. { autoIncrement: true }
  4. );

上面代码中,指定主键为一个递增的整数。

新建对象仓库以后,下一步可以新建索引。

  1. request.onupgradeneeded = function(event) {
  2. db = event.target.result;
  3. var objectStore = db.createObjectStore('person', { keyPath: 'id' });
  4. objectStore.createIndex('name', 'name', { unique: false });
  5. objectStore.createIndex('email', 'email', { unique: true });
  6. }

上面代码中,IDBObject.createIndex()的三个参数分别为索引名称、索引所在的属性、配置对象(说明该属性是否包含重复的值)。

新增数据

新增数据指的是向对象仓库写入数据记录。这需要通过事务完成。

  1. function add() {
  2. var request = db.transaction(['person'], 'readwrite')
  3. .objectStore('person')
  4. .add({ id: 1, name: '张三', age: 24, email: 'zhangsan@example.com' });
  5. request.onsuccess = function (event) {
  6. console.log('数据写入成功');
  7. };
  8. request.onerror = function (event) {
  9. console.log('数据写入失败');
  10. }
  11. }
  12. add();

上面代码中,写入数据需要新建一个事务。新建时必须指定表格名称和操作模式(“只读”或“读写”)。新建事务以后,通过IDBTransaction.objectStore(name)方法,拿到 IDBObjectStore 对象,再通过表格对象的add()方法,向表格写入一条记录。

写入操作是一个异步操作,通过监听连接对象的success事件和error事件,了解是否写入成功。

读取数据

读取数据也是通过事务完成。

  1. function read() {
  2. var transaction = db.transaction(['person']);
  3. var objectStore = transaction.objectStore('person');
  4. var request = objectStore.get(1);
  5. request.onerror = function(event) {
  6. console.log('事务失败');
  7. };
  8. request.onsuccess = function( event) {
  9. if (request.result) {
  10. console.log('Name: ' + request.result.name);
  11. console.log('Age: ' + request.result.age);
  12. console.log('Email: ' + request.result.email);
  13. } else {
  14. console.log('未获得数据记录');
  15. }
  16. };
  17. }
  18. read();

上面代码中,objectStore.get()方法用于读取数据,参数是主键的值。

遍历数据

遍历数据表格的所有记录,要使用指针对象 IDBCursor。

  1. function readAll() {
  2. var objectStore = db.transaction('person').objectStore('person');
  3. objectStore.openCursor().onsuccess = function (event) {
  4. var cursor = event.target.result;
  5. if (cursor) {
  6. console.log('Id: ' + cursor.key);
  7. console.log('Name: ' + cursor.value.name);
  8. console.log('Age: ' + cursor.value.age);
  9. console.log('Email: ' + cursor.value.email);
  10. cursor.continue();
  11. } else {
  12. console.log('没有更多数据了!');
  13. }
  14. };
  15. }
  16. readAll();

上面代码中,新建指针对象的openCursor()方法是一个异步操作,所以要监听success事件。

更新数据

更新数据要使用IDBObject.put()方法。

  1. function update() {
  2. var request = db.transaction(['person'], 'readwrite')
  3. .objectStore('person')
  4. .put({ id: 1, name: '李四', age: 35, email: 'lisi@example.com' });
  5. request.onsuccess = function (event) {
  6. console.log('数据更新成功');
  7. };
  8. request.onerror = function (event) {
  9. console.log('数据更新失败');
  10. }
  11. }
  12. update();

上面代码中,put()方法自动更新了主键为1的记录。

删除数据

IDBObjectStore.delete()方法用于删除记录。

  1. function remove() {
  2. var request = db.transaction(['person'], 'readwrite')
  3. .objectStore('person')
  4. .delete(1);
  5. request.onsuccess = function (event) {
  6. console.log('数据删除成功');
  7. };
  8. }
  9. remove();

使用索引

索引的意义在于,可以让你搜索任意字段,也就是说从任意字段拿到数据记录。如果不建立索引,默认只能搜索主键(即从主键取值)。

假定新建表格的时候,对name字段建立了索引。

  1. objectStore.createIndex('name', 'name', { unique: false });

现在,就可以从name找到对应的数据记录了。

  1. var transaction = db.transaction(['person'], 'readonly');
  2. var store = transaction.objectStore('person');
  3. var index = store.index('name');
  4. var request = index.get('李四');
  5. request.onsuccess = function (e) {
  6. var result = e.target.result;
  7. if (result) {
  8. // ...
  9. } else {
  10. // ...
  11. }
  12. }