indexDb 使用
浏览器存储限制
Cookie 的大小不超过4KB,且每次请求都会发送回服务器;LocalStorage 在 2.5MB 到 10MB 之间(各家浏览器不同)
IndexedDB 就是浏览器提供的本地数据库,它可以被网页脚本创建和操作。IndexedDB 允许储存大量数据,提供查找接口,还能建立索引
特点
键值对储存
IndexedDB 内部采用对象仓库(object store)存放数据。所有类型的数据都可以直接存入,包括 JavaScript 对象。对象仓库中,数据以"键值对"的形式保存,每一个数据记录都有对应的主键,主键是独一无二的,不能有重复,否则会抛出一个错误。
异步
IndexedDB 操作时不会锁死浏览器,用户依然可以进行其他操作,这与 LocalStorage 形成对比,后者的操作是同步的。异步设计是为了防止大量数据的读写,拖慢网页的表现
支持事务
IndexedDB 支持事务(transaction),这意味着一系列操作步骤之中,只要有一步失败,整个事务就都取消,数据库回滚到事务发生之前的状态,不存在只改写一部分数据的情况
同源限制
IndexedDB 受到同源限制,每一个数据库对应创建它的域名。网页只能访问自身域名下的数据库,而不能访问跨域的数据库。
存储空间大
IndexedDB 的储存空间比 LocalStorage 大得多,一般来说不少于 250MB,甚至没有上限。
支持二进制存储
IndexedDB 不仅可以储存字符串,还可以储存二进制数据(ArrayBuffer 对象和 Blob 对象)。
Api
- 数据库:IDBDatabase 对象
- 对象仓库:IDBObjectStore 对象
- 索引: IDBIndex 对象
- 事务: IDBTransaction 对象
- 操作请求:IDBRequest 对象
- 指针: IDBCursor 对象
- 主键集合:IDBKeyRange 对象
window.indexedDB.open(databaseName, version)
这个方法接受两个参数,第一个参数是字符串,表示数据库的名字。如果指定的数据库不存在,就会新建数据库。第二个参数是整数,表示数据库的版本。如果省略,打开已有数据库时,默认为当前版本;新建数据库时,默认为1
。
indexedDB.open()
方法返回一个 IDBRequest 对象。这个对象通过三种事件error
、success
、upgradeneeded
,处理打开数据库的操作结果。
const request = window.indexedDB.open(databaseName, version);
request.onsuccess
成功回调
let db = null;
request.onsuccess = function (event) {
db = event.target.result;
console.log('数据库打开报错');
};
request.onerror
失败回调
request.onerror = function (event) {
console.log('数据库打开报错');
};
request.onupgradeneeded
如果指定的版本号,大于数据库的实际版本号,就会发生数据库升级事件upgradeneeded
。
或者版本从无到有,也会触发这个事件
IDBObject.createIndex()
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 });
}
IDBObjectStore .add()
向对象仓库写入数据记录。这需要通过事务完成
function add() {
var request = 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('数据写入失败');
}
}
上面代码中,写入数据需要新建一个事务。新建时必须指定表格名称和操作模式(“只读"或"读写”)。新建事务以后,通过IDBTransaction.objectStore(name)
方法,拿到 IDBObjectStore 对象,再通过表格对象的add()
方法,向表格写入一条记录。
写入操作是一个异步操作,通过监听连接对象的success
事件和error
事件,了解是否写入成功。
IDBObjectStore.get(主键)
获取对应主键的值
function read(id) {
var transaction = db.transaction(['person']);
var objectStore = transaction.objectStore('person');
var request = objectStore.get(id);
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('未获得数据记录');
}
};
}
IDBObjectStore.getAll()
function read() {
var transaction = db.transaction(['person']);
var objectStore = transaction.objectStore('person');
var request = objectStore.getAll();
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('未获得数据记录');
}
};
}
IDBObject.put()
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('数据更新失败');
}
}
IDBObjectStore.delete()
function remove(id) {
var request = db.transaction(['person'], 'readwrite')
.objectStore('person')
.delete(id);
request.onsuccess = function (event) {
console.log('数据删除成功');
};
}
IDBObjectStore.index()
索引的意义在于,可以让你搜索任意字段,也就是说从任意字段拿到数据记录。如果不建立索引,默认只能搜索主键(即从主键取值)。
假定新建表格的时候,对name
字段建立了索引。
objectStore.createIndex('name', 'name', { unique: false });
现在,就可以从name
找到对应的数据记录了。
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 { // ... } }
基于Promise的indexDb例子
const DB_NAME = "130_finder";
let dbObject = null;
const initDb = () =>
new Promise((resolve, reject) => {
const request = window.indexedDB.open(DB_NAME);
request.onupgradeneeded = (e) => {
dbObject = e.target.result;
//建表
if (!dbObject.objectStoreNames.contains('person')) {
dbObject.createObjectStore('person', { keyPath: 'id' });
}
//创建索引
// personObjectStore.createIndex('name','name',{unique:false});
// personObjectStore.createIndex('eamil','eamil',{unique:true});
if (!dbObject.objectStoreNames.contains('student')) {
dbObject.createObjectStore('student', { autoIncrement: true });
}
};
request.onsuccess = (e) => {
dbObject = e.target.result;
console.log("success->数据库初始化成功");
resolve("success->数据库初始化成功");
};
request.onerror = (e) => {
reject(`error->数据库初始化失败: ${e}`);
console.log(e);
};
});
const addData = (tableName, saveData) =>
new Promise((resolve, reject) => {
if (dbObject == null) {
reject("error->dbObject 为 null");
return;
}
let request = dbObject.transaction([tableName], 'readwrite').objectStore(tableName).add(saveData);
request.onsuccess = () => {
resolve("success: 数据添加成功");
};
request.onerror = (e) => {
reject(`error: 数据添加失败: ${e}`);
};
});
const deleteDb = () =>
new Promise((resolve, reject) => {
if (dbObject == null) {
reject("dbObject 为 null");
return;
}
const request = window.indexedDB.deleteDatabase(DB_NAME);
request.onerror = (e) => {
reject(`数据库删除失败: ${e}`);
};
request.onsuccess = () => {
resolve("数据库删除成功");
};
});
const getPerson = (id = -1) =>
new Promise((resolve, reject) => {
//不传参数, 表示全部获取
const objectStore = dbObject.transaction(['person']).objectStore('person');
let request = null;
if (id === -1) {
request = objectStore.getAll();
} else {
request = objectStore.get(id);
}
request.onerror = (e) => {
reject(e);
};
request.onsuccess = (e) => {
resolve(e.target.result);
};
})
const clearObjectStore = (tableName) =>
new Promise((resolve,reject)=>{
let mTransaction = null;
try{
mTransaction = dbObject.transaction([tableName],'readwrite')
}catch(e){
console.log(`clearObjectStore ${tableName} fail!`);
reject(`clearObjectStore ${tableName} fail!`);
}
if(mTransaction != null){
let store = mTransaction.objectStore(tableName);
store.clear();
console.log(`clearObjectStore ${tableName} success!`);
resolve(`clearObjectStore ${tableName} success!`);
}
});
export { initDb, addData, deleteDb, getPerson,clearObjectStore };