ts封装浏览器indexedDB

IndexedDB 的工具函数集合,主要包括以下功能:

  1. openStore: 打开指定名称的 IndexedDB 数据库,并创建或更新指定名称的对象存储空间。接受一个包含数据库名称、存储空间名称、键路径和可选索引数组的参数对象,并返回一个 Promise,该 Promise 在成功时解析为打开的 IDBDatabase 实例,或在失败时解析为 null。

  2. updateStore: 向指定的对象存储空间中添加或修改数据。接受一个已打开的 IDBDatabase 实例、存储空间名称和要添加或修改的数据对象作为参数,并返回一个 Promise,在成功时解析为 true,或在失败时解析为 false。

  3. deleteStore: 根据键值从指定的对象存储空间中删除数据。接受一个已打开的 IDBDatabase 实例、存储空间名称和要删除的键值作为参数,并返回一个 Promise,在成功时解析为 true,或在失败时解析为 false。

  4. find: 获取指定对象存储空间中的所有数据。接受一个已打开的 IDBDatabase 实例和存储空间名称作为参数,并返回一个 Promise,在成功时解析为包含所有数据的数组,或在失败时解析为空数组。

  5. findOne: 根据键值获取指定对象存储空间中的一条数据。接受一个已打开的 IDBDatabase 实例、存储空间名称和要获取的键值作为参数,并返回一个 Promise,在成功时解析为对应的数据对象,或在失败时解析为空数组。

  6. clearAll: 清空指定对象存储空间中的所有数据。接受一个已打开的 IDBDatabase 实例和存储空间名称作为参数,并返回一个 Promise,在成功时解析为 true,或在失败时解析为 false。

interface openStoreType {
  databaseName: string,
  storeName: string,
  keyPath: string,
  indexes?: Array<string>
}

export const openStore = ({ databaseName, storeName, keyPath, indexes = [] }: openStoreType): Promise<IDBDatabase | null> => {
  return new Promise((resolve, reject) => {
    // 打开indexedDB
    let request = window.indexedDB.open(databaseName, 1);

    request.onsuccess = (evt: Event) => {
      console.log('indexedDB open success!', evt);
      resolve((evt.target as IDBOpenDBRequest).result);
    }
    
    request.onerror = (evt: Event) => {
      console.log('indexedDb open fial!', evt);
      reject(null);
    }

    request.onupgradeneeded = (evt: IDBVersionChangeEvent) => {
      if ((evt?.target as IDBOpenDBRequest)?.result) {
        const { result } = evt.target as IDBOpenDBRequest;
        // 创建数据对象
        const store = result.createObjectStore(storeName, { autoIncrement: true, keyPath });
        // 创建索引
        for (let i in indexes) {
          store.createIndex(indexes[i], indexes[i], { unique: true });
        }
        // 创建数据对象成功
        store.transaction.oncomplete = (evt: any) => {
          console.log('object store create success!', evt);
        }
        console.log('indexedDb upgrade success!', evt);
      } else {
        console.log('indexedDb upgrade fail!', evt);
      }
    }
  });
}

// 新增(add),修改(put)
export const updateStore = async (db: IDBDatabase, storeName: string, data: any): Promise<boolean> => {
  return new Promise((resolve, reject) => {
    // 获取store对象
    let store = db.transaction([storeName], 'readwrite').objectStore(storeName);
    // 添加或修改数据
    const request = store.put({ ...data, updateAt: new Date() });

    request.onsuccess = (evt: Event) => {
      console.log('update success!', evt);
      resolve(true);
    }
    
    request.onerror = (evt: Event) => {
      console.log('update fail!', evt);
      reject(false);
    }
  });
}

// 根据key删除对应数据
export const deleteStore = async (db: IDBDatabase, storeName: string, key: string | number): Promise<boolean> => {
  return new Promise((resolve, reject) => {
    // 获取store对象
    let store = db.transaction([storeName], 'readwrite').objectStore(storeName);
    // 根据key删除数据
    const request = store.delete(key);

    request.onsuccess = (evt: Event) => {
      console.log('delete success!', evt);
      resolve(true);
    }

    request.onerror = (evt: Event) => {
      console.log('delete fail!', evt);
      reject(false);
    }
  });
}

// 获取所有数据
export const find = (db: IDBDatabase, storeName: string): Promise<any[]> => {
  return new Promise((resolve, reject) => {
    // 获取store对象
    let store = db.transaction([storeName], 'readwrite').objectStore(storeName);
    
    const request = store.getAll();
    
    request.onsuccess = (evt: Event) => {
      console.log('get all data success!', evt);
      resolve((evt.target as any).result);
    }
    
    request.onerror = (evt: Event) => {
      console.log('get all data fail!', evt);
      reject([]);
    }
  });
}

// 获取一条数据
export const findOne = (db: IDBDatabase, storeName: string, key: number | string): Promise<any> => {
  return new Promise((resolve, reject) => {
    
    let store = db.transaction([storeName], 'readwrite').objectStore(storeName);
    
    const request = store.get(key);
    
    request.onsuccess = (evt: Event) => {
      console.log('get data success!', evt);
      resolve((evt.target as any).result);
    }
    
    request.onerror = (evt: Event) => {
      console.log('get data fail!', evt);
      reject([]);
    }
  });
}

// 清空所有数据
export const clearAll = (db: IDBDatabase, storeName: string): Promise<boolean> => {
  return new Promise((resolve, reject) => {
    
    let store = db.transaction([storeName], 'readwrite').objectStore(storeName);
    
    const request = store.clear();
    
    request.onsuccess = (evt: Event) => {
      console.log('clear data success!', evt);
      resolve(true);
    }
    
    request.onerror = (evt: Event) => {
      console.log('clear data fail!', evt);
      reject(false);
    }
  });
}

方法调用 

// 创建
let indexedDB= await openStore({
    databaseName: "test",
    storeName: "room",
    keyPath: "id",
    indexes: ["width", "height", "length"],
});

// 添加
await updateStore(indexed, "room", { width: 50, height: 20, length: 60 });

// 修改
await updateStore(indexed, "room", {
      id: 1,
      width: Math.floor(Math.random() * 100),
      height: Math.floor(Math.random() * 100),
      length: Math.floor(Math.random() * 100),
});

// 删除
await deleteStore(indexed, "room", 1);

// 获取所有数据
let res = await find(indexed, "room");

// 根据key查询数据
let res = await findOne(indexed, "room", 2);

 

 

 

  • 2
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
IndexedDB浏览器提供的本地数据库,可以在浏览器中存储结构化数据。下面是 IndexedDB 的基本使用方法: 1. 打开数据库 使用 `indexedDB` 对象的 `open()` 方法打开数据库,如下所示: ``` let request = indexedDB.open('myDB', 1); ``` 其中,第一个参数是数据库名称,第二个参数是数据库版本号。如果数据库不存在,则会创建一个新的数据库。 2. 创建对象仓库 在成功打开数据库的回调方法 `request.onsuccess` 中,可以获取到数据库对象 `event.target.result`,然后使用它的 `createObjectStore()` 方法创建一个对象仓库(即数据表),如下所示: ``` let db = event.target.result; let objectStore = db.createObjectStore('people', { keyPath: 'id' }); ``` 其中,第一个参数是对象仓库的名称,第二个参数是一个对象,包含一个 keyPath 属性和其他可选属性。keyPath 用来指定数据表中的主键。 3. 添加数据 使用事务 `db.transaction()` 开启一个事务,然后使用 `add()` 方法向数据表中添加数据,如下所示: ``` let transaction = db.transaction(['people'], 'readwrite'); let objectStore = transaction.objectStore('people'); let request = objectStore.add({ id: 1, name: 'John Doe' }); ``` 其中,第一个参数是一个数组,包含要访问的对象仓库的名称,第二个参数是事务类型,可以是 'readonly' 或 'readwrite'。`add()` 方法的参数是要添加的数据。 4. 查询数据 使用事务 `db.transaction()` 开启一个事务,然后使用 `get()` 方法查询数据,如下所示: ``` let transaction = db.transaction(['people']); let objectStore = transaction.objectStore('people'); let request = objectStore.get(1); request.onsuccess = function(event) { console.log('Name: ' + event.target.result.name); }; ``` `get()` 方法的参数是要查询的数据的主键值。查询结果保存在 `request.onsuccess` 回调方法中的 `event.target.result` 中。 5. 更新数据 使用事务 `db.transaction()` 开启一个事务,然后使用 `put()` 方法更新数据,如下所示: ``` let transaction = db.transaction(['people'], 'readwrite'); let objectStore = transaction.objectStore('people'); let request = objectStore.put({ id: 1, name: 'Jane Doe' }); ``` `put()` 方法的参数是要更新的数据。 6. 删除数据 使用事务 `db.transaction()` 开启一个事务,然后使用 `delete()` 方法删除数据,如下所示: ``` let transaction = db.transaction(['people'], 'readwrite'); let objectStore = transaction.objectStore('people'); let request = objectStore.delete(1); ``` `delete()` 方法的参数是要删除的数据的主键值。 以上就是 IndexedDB 的基本使用方法。需要注意的是,IndexedDB 的 API 非常庞大,不仅仅包含上面提到的这些方法,还包括索引、游标、版本升级等功能。如果需要更详细的介绍和示例代码,可以参考 MDN 的文档:https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值