一、概述

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

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

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

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 对象

下面是一些主要的概念。

（1）数据库

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

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

（2）对象仓库

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

（3）数据记录

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

{id:1,text:'foo'}

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

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

（4）索引

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

（5）事务

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

三、操作流程

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

3.1 打开数据库

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

varrequest=window.indexedDB.open(databaseName,version);

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

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

（1）error 事件

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

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

（2）success 事件

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

vardb;request.onsuccess=function(event){db=request.result;console.log('数据库打开成功');};

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

（3）upgradeneeded 事件

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

vardb;request.onupgradeneeded=function(event){db=event.target.result;}

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

3.2 新建数据库

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

通常，新建数据库以后，第一件事是新建对象仓库（即新建表）。

request.onupgradeneeded=function(event){db=event.target.result;varobjectStore=db.createObjectStore('person',{keyPath:'id'});}

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

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

request.onupgradeneeded=function(event){db=event.target.result;varobjectStore;if(!db.objectStoreNames.contains('person')){objectStore=db.createObjectStore('person',{keyPath:'id'});}}

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

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

varobjectStore=db.createObjectStore('person',{autoIncrement:true});

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

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

request.onupgradeneeded=function(event){db=event.target.result;varobjectStore=db.createObjectStore('person',{keyPath:'id'});objectStore.createIndex('name','name',{unique:false});objectStore.createIndex('email','email',{unique:true});}

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

3.3 新增数据

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

functionadd(){varrequest=db.transaction(['person'],'readwrite').objectStore('person').add({id:1,name:'张三',age:24,email:'zhangsan@example.com'});request.onsuccess=function(event){console.log('数据写入成功');};request.onerror=function(event){console.log('数据写入失败');}}add();

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

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

3.4 读取数据

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

functionread(){vartransaction=db.transaction(['person']);varobjectStore=transaction.objectStore('person');varrequest=objectStore.get(1);request.onerror=function(event){console.log('事务失败');};request.onsuccess=function(event){if(request.result){console.log('Name: '+request.result.name);console.log('Age: '+request.result.age);console.log('Email: '+request.result.email);}else{console.log('未获得数据记录');}};}read();

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

3.5 遍历数据

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

functionreadAll(){varobjectStore=db.transaction('person').objectStore('person');objectStore.openCursor().onsuccess=function(event){varcursor=event.target.result;if(cursor){console.log('Id: '+cursor.key);console.log('Name: '+cursor.value.name);console.log('Age: '+cursor.value.age);console.log('Email: '+cursor.value.email);cursor.continue();}else{console.log('没有更多数据了！');}};}readAll();

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

3.6 更新数据

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

functionupdate(){varrequest=db.transaction(['person'],'readwrite').objectStore('person').put({id:1,name:'李四',age:35,email:'lisi@example.com'});request.onsuccess=function(event){console.log('数据更新成功');};request.onerror=function(event){console.log('数据更新失败');}}update();

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

3.7 删除数据

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

functionremove(){varrequest=db.transaction(['person'],'readwrite').objectStore('person').delete(1);request.onsuccess=function(event){console.log('数据删除成功');};}remove();

3.8 使用索引

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

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

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

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

vartransaction=db.transaction(['person'],'readonly');varstore=transaction.objectStore('person');varindex=store.index('name');varrequest=index.get('李四');request.onsuccess=function(e){varresult=e.target.result;if(result){ // ...}else{ // ...}}

（完）

文档信息

版权声明：自由转载-非商用-非衍生-保持署名（创意共享3.0许可证）

发表日期： 2018年7月 4日

相关文章

2020.01.26: Deno 运行时入门教程：Node.js 的替代品

这几天假期，我学习了一下 Deno。它是 Node.js 的替代品。有了它，将来可能就不需要 Node.js 了。

2019.09.01: React Hooks 入门教程

React 是主流的前端框架，v16.8 版本引入了全新的 API，叫做 React Hooks，颠覆了以前的用法。

2019.08.06: Web Components 入门实例教程

组件是前端的发展方向，现在流行的 React 和 Vue 都是组件框架。

2019.04.15: 如何用网页脚本追踪用户

本文介绍如何编写 JavaScript 脚本，将用户数据发回服务器。

留言（40条）

zx 说：

兼容性怎么样

2018年7月 4日 09:14 | # | 引用

JS 说：

https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API

2018年7月 4日 10:05 | # | 引用

yqzhang 说：

我想请教一下本地数据库的应用场景有哪些？

2018年7月 4日 10:10 | # | 引用

lovemegowin 说：

同求应用场景

2018年7月 4日 10:35 | # | 引用

ixx 说：

浏览器兼容：https://developer.mozilla.org/zh-CN/docs/Web/API/IndexedDB_API#Browser_compatibility

2018年7月 4日 10:39 | # | 引用

路过 说：

各种清理软件用户分钟就清理了

2018年7月 4日 11:18 | # | 引用

鱼鱼青年lc 说：

在开发的时候用于取代mock服务？还有在tob场景下缓存大批量数据减少服务器压力么

2018年7月 4日 12:05 | # | 引用

我要说 说：

应该还是做一些缓存而已 只不过提供一些结构化的方式 优于localStorage 罢了

2018年7月 4日 13:21 | # | 引用

铁锚 说：

感谢！ 浅显易懂。

2018年7月 4日 15:06 | # | 引用

优惠券 说：

引用路过的发言：

各种清理软件用户分钟就清理了

说的真是废话，你怎么不说用户分分钟就把系统重装了呢

2018年7月 5日 00:53 | # | 引用

天地仁一 说：

如何防止IndexDB被用户修改呢?

2018年7月 5日 00:58 | # | 引用

123 说：

一峰 ，你的es6 入门网站挂掉了，速度续费啊，大佬

2018年7月 5日 15:58 | # | 引用

mall 说：

用户换个电脑访问，DB的数据怎么办

2018年7月 5日 17:27 | # | 引用

6 说：

简单易懂！

2018年7月 5日 18:21 | # | 引用

xianxiaobo 说：

催更

2018年7月 6日 10:33 | # | 引用

Magic 说：

坐等每周分享12

2018年7月 6日 12:49 | # | 引用

shawn 说：

IndexedDB 早在去年就引起重视，一直使用“localforage”，这个库来操作本地存储，大家也可以试一试，兼容不错

2018年7月 8日 11:23 | # | 引用

Youthink 说：

浏览器兼容性，可以在这里看 https://caniuse.com/#search=IndexedDB

2018年7月 9日 14:46 | # | 引用

wfwf 说：

这样的话，是不是用来开发移动app更好了，有了本地存储

2018年7月10日 15:08 | # | 引用

nick 说：

引用mall的发言：

用户换个电脑访问，DB的数据怎么办

这个问题还用问吗，要是没有保存到服务器数据肯定没了。呀，这只是做一些数据缓存而已。文章开头都已经说明了它的用途了。

2018年7月12日 17:51 | # | 引用

Mikcal 说：

本地存储的的话，它的安全性怎么样啊？或者说它的应用场景有哪些呢？存储一些无关紧要的数据？

2018年7月16日 16:35 | # | 引用

zzp 说：

对于页游开发者,应该很有用

2018年7月20日 16:41 | # | 引用

xl 说：

请教大神 那是不是只要统一管理 这个indexedDB 可以替代 redux

2018年7月26日 11:12 | # | 引用

oldfu 说：

我也想了解下应用场景

2018年8月 1日 09:18 | # | 引用

张老汉 说：

区块链项目，服务端只存储加密字符串：客户端(electron)需要下载大量的加密数据，然后批量解密，并且提供排序和数据流转。所以前端没数据库是不行的。

2018年8月10日 11:12 | # | 引用

arh 说：

老师 能详细讲下 版本 吗 ？ 它如何影响数据增删改查的？

2018年10月12日 09:55 | # | 引用

杨龙飞 说：

引用mall的发言：

用户换个电脑访问，DB的数据怎么办

原始数据是从库里面请求的，然后放到本地indexdb里，之后的

操作都可以走本地了，本地的indexDB只是服务器db的一个缓存

2018年11月15日 10:29 | # | 引用

ilvseyinfu 说：

阮老师写的好呐，通俗易懂，这是我根据教程写的一个通讯录的项目https://github.com/ilvseyinfu/AddressBook

2018年11月16日 11:13 | # | 引用

STAR 说：

很好的入门。正要做一个基于本地的东西

2018年11月23日 12:54 | # | 引用

桐花 说：

一个web应用，不需要服务器的那种。比如单机游戏，比如个体店的出纳。

最多的我觉得还是移动端做数据缓存

2019年1月23日 23:43 | # | 引用

聪聪 说：

关系型数据库中表的每一行本来就叫记录

2019年2月26日 18:12 | # | 引用

vito 说：

想给某个对象存储新增一个字段怎么做？升级数据库后不能创建这个表，报已经存在

2019年3月20日 17:09 | # | 引用

橙续缘 说：

请问可以转载阮老师的这篇文章吗，自当声明出处。

2019年5月29日 18:57 | # | 引用

微wx笑 说：

好奇怪的用法，先调用了indexedDB.open触发事件，然后再绑定回调函数。

2019年7月11日 15:36 | # | 引用

silas 说：

最后一个用索引查的例子，有关键部分漏了，我这里补充下

getByIndex: async function (table, keyValue, indexCursor) {

try {

let db = await this.openDB();

let store = db

.transaction(table.name, 'readonly')

.objectStore(table.name);

let keyRng = IDBKeyRange.only(keyValue);

let request = store.index(indexCursor).openCursor(keyRng);

let data = [];

return new Promise(resolve => {

request.onerror = function (event) {

reject(false);

};

request.onsuccess = function (event) {

var cursor = event.target.result;

if (cursor) {

console.log(cursor.value);

data.push(cursor.value);

cursor.continue();

}

};

resolve(data);

});

} catch (error) {

return Promise.reject(false);

}

}