|
|
51CTO旗下网站
|
|
移动端

浏览器数据库IndexedDB入门教程

IndexedDB 就是浏览器提供的本地数据库,它可以被网页脚本创建和操作。IndexedDB 允许储存大量数据,提供查找接口,还能建立索引。这些都是 LocalStorage 所不具备的。就数据库类型而言,IndexedDB 不属于关系型数据库(不支持 SQL 查询语句),更接近 NoSQL 数据库。

作者:阮一峰来源:数据库开发|2018-07-05 11:30

一、概述

随着浏览器的功能不断增强,越来越多的网站开始考虑,将大量数据储存在客户端,这样可以减少从服务器获取数据,直接从本地获取数据。

现有的浏览器数据储存方案,都不适合储存大量数据:Cookie 的大小不超过4KB,且每次请求都会发送回服务器;LocalStorage 在 2.5MB 到 10MB 之间(各家浏览器不同),而且不提供搜索功能,不能建立自定义的索引。所以,需要一种新的解决方案,这就是 IndexedDB 诞生的背景。

通俗地说,IndexedDB 就是浏览器提供的本地数据库,它可以被网页脚本创建和操作。IndexedDB 允许储存大量数据,提供查找接口,还能建立索引。这些都是 LocalStorage 所不具备的。就数据库类型而言,IndexedDB 不属于关系型数据库(不支持 SQL 查询语句),更接近 NoSQL 数据库。

浏览器数据库IndexedDB入门教程

IndexedDB 具有以下特点。

  1. 键值对储存。 IndexedDB 内部采用对象仓库(object store)存放数据。所有类型的数据都可以直接存入,包括 JavaScript 对象。对象仓库中,数据以"键值对"的形式保存,每一个数据记录都有对应的主键,主键是独一无二的,不能有重复,否则会抛出一个错误。
  2. 异步。 IndexedDB 操作时不会锁死浏览器,用户依然可以进行其他操作,这与 LocalStorage 形成对比,后者的操作是同步的。异步设计是为了防止大量数据的读写,拖慢网页的表现。
  3. 支持事务。 IndexedDB 支持事务(transaction),这意味着一系列操作步骤之中,只要有一步失败,整个事务就都取消,数据库回滚到事务发生之前的状态,不存在只改写一部分数据的情况。
  4. 同源限制 IndexedDB 受到同源限制,每一个数据库对应创建它的域名。网页只能访问自身域名下的数据库,而不能访问跨域的数据库。
  5. 储存空间大 IndexedDB 的储存空间比 LocalStorage 大得多,一般来说不少于 250MB,甚至没有上限。
  6. 支持二进制储存。 IndexedDB 不仅可以储存字符串,还可以储存二进制数据(ArrayBuffer 对象和 Blob 对象)。

二、基本概念

IndexedDB 是一个比较复杂的 API,涉及不少概念。它把不同的实体,抽象成一个个对象接口。学习这个 API,就是学习它的各种对象接口。

  • 数据库:IDBDatabase 对象
  • 对象仓库:IDBObjectStore 对象
  • 索引: IDBIndex 对象
  • 事务: IDBTransaction 对象
  • 操作请求:IDBRequest 对象
  • 指针: IDBCursor 对象
  • 主键集合:IDBKeyRange 对象

下面是一些主要的概念。

数据库

数据库是一系列相关数据的容器。每个域名(严格的说,是协议 + 域名 + 端口)都可以新建任意多个数据库。

IndexedDB 数据库有版本的概念。同一个时刻,只能有一个版本的数据库存在。如果要修改数据库结构(新增或删除表、索引或者主键),只能通过升级数据库版本完成。

对象仓库

每个数据库包含若干个对象仓库(object store)。它类似于关系型数据库的表格。

数据记录

对象仓库保存的是数据记录。每条记录类似于关系型数据库的行,但是只有主键和数据体两部分。主键用来建立默认的索引,必须是不同的,否则会报错。主键可以是数据记录里面的一个属性,也可以指定为一个递增的整数编号。

{ id: 1, text: 'foo' }

上面的对象中,id属性可以当作主键。

数据体可以是任意数据类型,不限于对象。

索引

为了加速数据的检索,可以在对象仓库里面,为不同的属性建立索引。

事务

数据记录的读写和删改,都要通过事务完成。事务对象提供error、abort和complete三个事件,用来监听操作结果。

三、操作流程

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

打开数据库

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

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

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

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

error 事件

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

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

success 事件

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

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

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

upgradeneeded 事件

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

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

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

新建数据库

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

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

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

上面代码中,数据库新建成功以后,新增一张叫做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.   }  

主键(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', { uniquefalse });  
  5.   objectStore.createIndex('email''email', { uniquetrue });  

上面代码中,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.  
  6.   request.onsuccess = function (event) {  
  7.     console.log('数据写入成功');  
  8.   };  
  9.  
  10.   request.onerror = function (event) {  
  11.     console.log('数据写入失败');  
  12.   }  
  13.   
  14.  
  15. 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.  
  6.    request.onerror = function(event) {  
  7.      console.log('事务失败');  
  8.    };  
  9.  
  10.    request.onsuccess = function( event) {  
  11.       if (request.result) {  
  12.         console.log('Name: ' + request.result.name);  
  13.         console.log('Age: ' + request.result.age);  
  14.         console.log('Email: ' + request.result.email);  
  15.       } else {  
  16.         console.log('未获得数据记录');  
  17.       }  
  18.    };  
  19.   
  20.  
  21. read(); 

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

遍历数据

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

  1. function readAll() {  
  2.   var objectStore = db.transaction('person').objectStore('person');  
  3.  
  4.    objectStore.openCursor().onsuccess = function (event) {  
  5.      var cursor = event.target.result;   
  6.  
  7.      if (cursor) {  
  8.        console.log('Id: ' + cursor.key);  
  9.        console.log('Name: ' + cursor.value.name);  
  10.        console.log('Age: ' + cursor.value.age);  
  11.        console.log('Email: ' + cursor.value.email);  
  12.        cursor.continue();  
  13.     } else {  
  14.       console.log('没有更多数据了!');  
  15.     }  
  16.   }; 
  17.  
  18.  
  19. 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.  
  6.   request.onsuccess = function (event) {  
  7.     console.log('数据更新成功');  
  8.   };  
  9.  
  10.   request.onerror = function (event) {  
  11.     console.log('数据更新失败');  
  12.   }  
  13.  
  14.  
  15. update(); 

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

删除数据

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

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

使用索引

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

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

  1. objectStore.createIndex('name''name', { uniquefalse }); 

现在,就可以从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.  
  6. request.onsuccess = function (e) {  
  7.   var result = e.target.result;  
  8.   if (result) {  
  9.     // ...  
  10.   } else {  
  11.     // ...  
  12.   }  
  13. }  

【编辑推荐】

  1. 数据库管理系统:中国还在寻找“正确打开方式”
  2. 数据库恢复不了? 不存在的!
  3. 数据库流行度7月排行榜:Oracle和MySQL暴跌创历史新低
  4. 【技术实战】Oracle数据库数据提取的方法
  5. 数据库实践如何解决互联网架构转型中的痛点?
【责任编辑:庞桂玉 TEL:(010)68476606】

点赞 0
分享:
大家都在看
猜你喜欢

读 书 +更多

计算机网络原理与实践标准教程

本书深入浅出地阐述了计算机网络技术的基本原理,介绍了当前常用的先进网络技术以及网络的实际应用知识。全书主要内容包括计算机网络概述、...

订阅51CTO邮刊

点击这里查看样刊

订阅51CTO邮刊