浏览器数据库 IndexedDB

1,333 阅读4分钟

简介

考虑将大量数据存储在客户端,这样可以减少从服务器获取数据,直接从本地获取数据

  • Cookie 的大小不超过 4KB
  • LocalStorage 在 2.5MB到10MB之间,不提供搜索功能,不能建立自定义的索引
  • web SQL www.runoob.com/html/html5-…

优点

  1. 键值对储存:IndexedDB 内部采用对象仓库(object store)存放数据。所有类型的数据都可以直接存入,包括 JavaScript 对象。对象仓库中,数据以"键值对"的形式保存,每一个数据记录都有对应的主键,主键是独一无二的,不能有重复,否则会抛出一个错误。

  2. 异步:IndexedDB 操作时不会锁死浏览器,用户依然可以进行其他操作,这与 LocalStorage 形成对比,后者的操作是同步的。异步设计是为了防止大量数据的读写,拖慢网页的表现。

  3. 支持事务:IndexedDB 支持事务(transaction),这意味着一系列操作步骤之中,只要有一步失败,整个事务就都取消,数据库回滚到事务发生之前的状态,不存在只改写一部分数据的情况。

  4. 同源限制:IndexedDB 受到同源限制,每一个数据库对应创建它的域名。网页只能访问自身域名下的数据库,而不能访问跨域的数据库。

  5. 储存空间大:IndexedDB 的储存空间比 LocalStorage 大得多,一般来说不少于 250MB,甚至没有上限。

  6. 支持二进制储存:IndexedDB 不仅可以储存字符串,还可以储存二进制数据(ArrayBuffer 对象和 Blob 对象)。

缺点

  • 不支持模糊匹配
  • 不支持分页

基本概念

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

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

流程

1.打开数据库

  • 使用 IndexedDB 的第一步是打开数据库,使用indexedDB.open()方法。
 var request = window.indexedDB.open(databaseName, version);

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

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

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

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

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

var db;

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

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

ar db;

request.onupgradeneeded = function (event) {
  db = event.target.result; //拿到数据库实例
}

2.新建数据库

request.onupgradeneeded = function (event) {
  db = event.target.result;
  var objectStore;
  if (!db.objectStoreNames.contains('person')) { //先判断一下,这张表格是否存在,如果不存在再新建
    objectStore = db.createObjectStore('person', { keyPath: 'id' });
  }
}
  • 没有合适作为主键的属性,那么可以让 IndexedDB 自动生成主键
var objectStore = db.createObjectStore(
  'person',
  { autoIncrement: true }//指定主键为一个递增的整数
);

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

request.onupgradeneeded = function(event) {
  db = event.target.result;
  var objectStore = db.createObjectStore('person', { keyPath: 'id' });
  objectStore.createIndex('name', 'name', { unique: false });//索引名称、索引所在的属性、配置对象说明该属性是否包含重复的值)
  objectStore.createIndex('email', 'email', { unique: true });
}

3.新增数据

上面代码中,写入数据需要新建一个事务。新建时必须指定表格名称和操作模式("只读"或"读写")。新建事务以后,通过IDBTransaction.objectStore(name)方法,拿到 IDBObjectStore 对象,再通过表格对象的add()方法,向表格写入一条记录。 写入操作是一个异步操作,通过监听连接对象的success事件和error事件,了解是否写入成功。

	let request_add = db
		.transaction(['person'], 'readwrite')
		.objectStore('person')
		.add({ id: 2, name: '张上', email: '123417316@qq.com' });

	request_add.onsuccess = event => {
		console.log(event);
	};
	request_add.onerror = event => {
		console.log(event);
	};

4.读取数据

  • objectStore.get()方法用于读取数据,参数是主键的值
function read() {
   var transaction = db.transaction(['person']);
   var objectStore = transaction.objectStore('person');
   var request = 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();

5.遍历数据

function readAll() {
  var objectStore = db.transaction('person').objectStore('person');
   objectStore.openCursor().onsuccess = function (event) {
     var cursor = 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();

6.更新数据

function update() {
  var request = 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();

7.删除数据

function remove() {
  var request = db.transaction(['person'], 'readwrite')
    .objectStore('person')
    .delete(1);

  request.onsuccess = function (event) {
    console.log('数据删除成功');
  };
}
remove();

8.索引查找

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

  • 假定新建表格的时候,对name字段建立了索引
objectStore.createIndex('name', 'name', { unique: false });
var transaction = db.transaction(['person'], 'readonly');
var store = transaction.objectStore('person');
var index = store.index('name');
var request = index.get('李四');
request.onsuccess = function (e) {
  var result = e.target.result;
  if (result) {
    // ...
  } else {
    // ...
  }
}

9.关闭

db.close();

10.删除数据库

indexedDB.deleteDatabase(name);