忘记 localStorage 吧，indexedDB 才是前端存储新宠！

短命女 2024-03-16 20:03 26阅读 0赞

## 前言 ##

在项目开发过程中，前端需要存储大量的数据。cookie, localstorage 都有存储长度限制。  
**表格一览**

<table> 
 <thead> 
  <tr> 
   <th>特性</th> 
   <th>cookie</th> 
   <th>localStorage</th> 
   <th>sessionStorage</th> 
   <th>indexedDB</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>数据生命周期</td> 
   <td>一般由服务器生成，可以设置过期时间；前端采用和js-cookie等组件也可以生成</td> 
   <td>除非被清理，否则一直存在；浏览器关闭还会保存在本地，但是不支持跨浏览器</td> 
   <td>页面关闭就清理刷新依然存在，不支持跨页面交互</td> 
   <td>除非被清理，否则一直存在</td> 
  </tr> 
  <tr> 
   <td>数据存储大小</td> 
   <td>4K</td> 
   <td>5M</td> 
   <td>5M</td> 
   <td>不限制大小</td> 
  </tr> 
  <tr> 
   <td>与服务端通信</td> 
   <td>每次都会携带在请求的header 中，对于请求性能有影响；同时由于请求中都带有，所以也容易出现安全问题</td> 
   <td>不参与</td> 
   <td>不参与</td> 
   <td>不参与</td> 
  </tr> 
  <tr> 
   <td>特点</td> 
   <td>字符串键值对在本地存储数据</td> 
   <td>字符串键值对在本地存储数据</td> 
   <td>字符串键值对在本地存储数据</td> 
   <td>IndexedDB 是一个非关系型数据库（不支持通过 SQL 语句操作）。可以存储大量数据，提供接口来查询，还可以建立索引，这些都是其他存储方案无法提供的能力。</td> 
  </tr> 
 </tbody> 
</table>

需要一个存储容量大，支持搜索和自定义索引的前端存储方案，就选用了 。  
caniuse上查看 indexedDB 支持情况，目前浏览器支持情况良好。  
[caniuse.com/?search=ind…][caniuse.com_search_ind]

## ![a1ad50e4d0554020a85bb191fd9ed613.png][]IndexedDB介绍 ##

IndexedDB 属于非关系型数据库。（不支持SQL查询）

### 特点： ###

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

### 核心概念 ###

*  数据库：IDBDatabase 对象，数据库有版本概念，同一时刻只能有一个版本，每个域名可以建多个数据库
 *  对象仓库：IDBObjectStore 对象，类似于关系型数据库的表格
 *  索引： IDBIndex 对象，可以在对象仓库中，为不同的属性建立索引，主键建立默认索引
 *  事务： IDBTransaction 对象，增删改查都需要通过事务来完成，事务对象提供了error,abord,complete三个回调方法，监听操作结果
 *  操作请求：IDBRequest 对象
 *  指针： IDBCursor 对象
 *  主键集合：IDBKeyRange 对象，主键是默认建立索引的属性，可以取当前层级的某个属性，也可以指定下一层对象的属性，还可以是一个递增的整数

## indexedDB使用 ##

### 基础操作 ###

#### 1. 创建数据库 & 新建表和索引 ####

/*
     *@databaseName 数据仓库的名字
     *@version 数据仓库的版本
     *@databaseName 数据仓库的名字
     */
    
    var request = window.indexedDB.open('group', 1);
    
    /*
     *数据仓库打开失败
     */
    request.onerror = function(error) {
      console.log('IndexedDB 打开失败', error);
    };
    
    /*
     *数据仓库打开成功
     */
    request.onsuccess = function(res) {
      console.log('IndexedDB 打开成功', res);
      db = res.target.result;
    };
    
    /*
     *数据仓库升级事件(第一次新建库是也会触发，因为数据仓库从无到有算是升级了一次)
     */
    request.onupgradeneeded = function(res) {
      console.log('IndexedDB 升级成功', res);
      db = res.target.result;
      db_table = db.createObjectStore('group', { keyPath: 'id' });
      db_table.createIndex('indexName', 'name', { unique: false });
    };

#### ![3d787606c03747ad8dc5ab74ecffc9e2.png][] ####

![ff160901d41b416fbb7420c9835de75b.png][]

#### 2. 新增数据 ####

/*
     *新建事务
     *@params 数据仓库的数组
     *@params 写入模式
     */
    var store = db.transaction(['group'], 'readwrite').objectStore('group');
    
    /*
     *add方法添加数据
     *@params 需要添加的数据信息
     */
    var request = store.add({
      id: new Date().getTime(),
      name: '王二',
      age: 12,
      email: 'XXXX@xxx.com',
    });
    
    /*
     *添加成功
     */
    request.onsuccess = function(event) {
      console.log('数据添加成功', event);
    };
    
    /*
     *添加失败
     */
    request.onerror = function(event) {
      console.log('数据添加失败', event);
    };

![format_png][]

![format_png 1][]

#### 3. 读取数据 ####

/*
     *新建事务
     *@params 数据仓库的数组
     */
    var store = db.transaction(['group']).objectStore('group');
    
    /*
     *get方法获取数据
     *@params 数据的主键
     */
    var request = store.get(1678664831491);
    
    /*
     *获取成功
     */
    request.onsuccess = function(event) {
      if (event.target.result) {
        console.log('数据获取成功', event.target.result);
      } else {
        console.log('未获取到数据');
      }
    };
    
    /*
     *获取失败
     */
    request.onerror = function(event) {
      console.log('数据获取失败', event);
    };

![format_png 2][]

#### 4. 更新数据 ####

/*
     *新建事务
     *@params 数据仓库的数组
     *@params 写入模式
     */
    var store = db.transaction(['group'], 'readwrite').objectStore('group');
    
    /*
     *put方法根据主键更新数据
     *@params 数据的主键
     */
    var request = store.put({
      id: 1678664831491,
      name: '张一' + Math.random(),
      age: 24,
      email: 'zhangsan@example.com',
    });
    
    /*
     *更新成功
     */
    request.onsuccess = function(event) {
      console.log('数据更新成功', event);
    };
    
    /*
     *更新失败
     */
    request.onerror = function(event) {
      console.log('数据更新失败', event);
    };

未加 readwrite, 会抛错，修改数据失败

![format_png 3][]

####  ####

![format_png 4][]

#### 5. 删除数据 ####

/*
    *新建事务
    *@params 数据仓库的数组
    */
    var store = db.transaction(['group'], 'readwrite').objectStore('group');
    
    /*
    *delete方法删除数据
    *@params 数据的主键
    */
    var request = store.delete(1678664831491); 
    
    /*
    *删除成功
    */
    request.onsuccess = function (event) {
        console.log('数据删除成功',event);
    };
    
    /*
    *删除失败
    */
    request.onerror = function (event) {
        console.log('数据删除失败',event);
    };

![format_png 5][]

#### 6. 使用索引 ####

/*
    *新建事务
    *@params 数据仓库的数组
    */
    var store = db.transaction(['group']).objectStore('group');
    
    /*
    *index方法获取索引对象
    *get方法获取数据
    *@params 数据的索引
    */
    var request = store.index('indexName').get('张四'); 
    
    /*
    *获取成功
    */
    request.onsuccess = function (event) {
         console.log('通过索引获取数据成功',event.target.result);
    };
    
    /*
    *获取失败
    */
    request.onerror = function (event) {
        console.log('通过索引获取数据失败',event);
    };

![format_png 6][]

![format_png 7][]

#### 7. 获取整张表所有的data ####

var store = db.transaction(['group']).objectStore('group');
    var request = store.getAll();
    
    /*
     *更新成功
     */
    request.onsuccess = function(event) {
      console.log('indexedDB getAll:', event.target.result);
    };
    
    /*
     *更新失败
     */
    request.onerror = function(event) {
      console.log('indexedDB getAll:', event);
    };

![format_png 8][]

#### 8. 根据指定条件获取data ####

首先让我们 来了解 `IDBKeyRange` 的API  
[www.w3cschool.cn/javascript\_…][www.w3cschool.cn_javascript]

![format_png 9][]

var store = db.transaction(['group']).objectStore('group');
    // 获取id名称小于当前时间的所有data
    var request = store.getAll(IDBKeyRange.upperBound(+new Date()));
    
    /*
     *更新成功
     */
    request.onsuccess = function(event) {
      console.log('indexedDB getAll:', event.target.result);
    };
    
    /*
     *更新失败
     */
    request.onerror = function(event) {
      console.log('indexedDB getAll:', event);
    };

![format_png 10][]

### 业务中优雅使用 ###

> indexedDB 并非无底洞，可以无限存储。要考虑做定期删除等功能

#### 1. 定期删除失效数据 ####

1. 首先我们创建数据的时候就以时间戳+失效时间来约定id规则

![format_png 11][]

2. 再通过上面基础操作的`getAll`方法，获取指定条件的`data`，再遍历`data`，调用删除数据API

![format_png 12][]

3. 我们把上述方法包装下每次打开页面，清空下失效数据。就可以实现一个定期删除失效数据的方法啦

#### 2. 批量添加数据 ####

const TestData = [
        {
          event: 'NE-TEST1',
          level: 'warning',
          errorCode: 200,
          url: 'http://www.example.com',
          time: '2017/11/8 下午4:53:039',
          isUploaded: false
        },
        {
          event: 'NE-TEST2',
          msg: '测试2',
          level: 'error',
          errorCode: 1000,
          url: 'http://www.example.com',
          time: '2017/11/8 下午4:53:042',
          isUploaded: false
        },
        {
          event: 'NE-TEST3',
          msg: '测试3',
          level: 'info',
          errorCode: 3000,
          url: 'http://www.example.com',
          time: '2017/11/8 下午4:53:043',
          isUploaded: false
        },
        {
          event: 'NE-TEST4',
          mgs: '测试4',
          level: 'info',
          url: 'http://www.example.com',
          time: '2017/11/8 下午4:53:0423',
          isUploaded: false
        }
      ]
    
    /**
    * 添加数据
    * @param {array} docs 要添加数据
    * @param {string} objName 仓库名称
    */
    function addData (docs, objName) {
        if (!(docs && docs.length)) {
          throw new Error('docs must be a array!')
        }
        return openIndexedDB().then(db => {
          const tx = db.transaction([objName], 'readwrite')
          tx.oncomplete = e => {
            console.log('tx:addData onsuccess', e)
            return Promise.resolve(docs)
          }
          tx.onerror = e => {
            e.stopPropagation()
            console.error('tx:addData onerror', e.target.error)
            return Promise.reject(e.target.error)
          }
          tx.onabort = e => {
            console.warn('tx:addData abort', e.target)
            return Promise.reject(e.target.error)
          }
          const obj = tx.objectStore(objName)
          docs.forEach(doc => {
            const req = obj.add(doc)
            /**
             * NOTE:
             * request
             * 两个事件：
             * 1. success
             * 2. error
             */
            // req.onsuccess = e => console.log('obj:addData onsuccess', e.target)
            req.onerror = e => {
              console.error('obj:addData onerror', e.target.error)
            }
          })
        })
      }
    
      addData(TestData, OB_NAMES.UseKeyGenerator)
    .then(() => addData(TestData, OB_NAMES.UseKeyPath))

## **结尾** ##

### 一些封装好的库 ###

#### `localforage` 推荐 ⭐️⭐️⭐️⭐️⭐️ （我们当前业务就用的这个~） ####

和`localsotrage`使用保持一致，更适合前端使用  
[还在用localStorage?快来试试localForage吧！ - 掘金][localStorage_localForage_ -]

#### `IndexedDBWrapper` 推荐 ⭐️⭐️⭐️ ####

### 思考我们还可以用indexedDB做什么 ###

#### 1. 用户使用日志收集 ####

在做一些前端`electron`应用，`webApp`,我们可以定义一个`log`日志库，来收集用户日志，遇到问题时，可以让用户，打包上传到日志库，排查跟进解决用户反馈问题。

定义日志上报结构

// 定义log基本结构
    const LogItem = {
    	level: 'log' | 'info' | 'error' ...,
      tag: 'request' | 'system' | ‘video’ | 'audio' | 'domClick' ... ,
    	msg: ...,  // any
      date: +new Date(),
    	...
    }

导出所有数据，并上传

此处就可以用上面的 `getAll`方法，获取该表所有数据，生成`json`打包上传到自己公司的日志库。

#### 2. `request`层封装，对不长更新接口缓存 ####

封装request方法，缓存请求接口，物理缓存数据~让页面接口数据加载飞起来

#### 3. 大文件上传，分片，避免网络失败，刷新页面等导致中断问题 ####

文件切片后先存储到`indexedDB`库，动态更新上传状态，异常状况可取出再继续定位到未上传的切片继续上传。

[caniuse.com_search_ind]: https://link.juejin.cn?target=https%3A%2F%2Fcaniuse.com%2F%3Fsearch%3DindexedDB
[a1ad50e4d0554020a85bb191fd9ed613.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/712e77149f8e47318c48d443968f6d46.png
[3d787606c03747ad8dc5ab74ecffc9e2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/29aa6bbade144b2ba555fab51f6a6978.png
[ff160901d41b416fbb7420c9835de75b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/67422692adba4592a51d1b56acfaa91a.png
[format_png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/2306608dde484dd5accda61ddd875234.png
[format_png 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/f4eb87fab95c439ab389d1af516cb23e.png
[format_png 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/863e58dab3394bd98fb42083d38a57b1.png
[format_png 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/7f3cec960ad94092b33e9f98ae071bdb.png
[format_png 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/5ce6be9fe7ae40cdbf2d634be72e2fa7.png
[format_png 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/a6fa8cae689a4bde9df17a05ab143c59.png
[format_png 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/934c09d8c9fd45c08c88406de23bb99c.png
[format_png 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/d3cb7555897c4be2ac78a55421fb4fae.png
[format_png 8]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/32a6420f19c34f58a12b128b103a2a74.png
[www.w3cschool.cn_javascript]: https://link.juejin.cn?target=https%3A%2F%2Fwww.w3cschool.cn%2Fjavascript_guide%2Fjavascript_guide-rcfy26a4.html%23toc9
[format_png 9]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/370a177f369b44c3a5c0f515562e7237.png
[format_png 10]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/5f8392caf15842b09872285f55413e6e.png
[format_png 11]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/d7555174629f48e4a626e73c6cbf75eb.png
[format_png 12]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/c5eae17e6aee4c8686ceb9130d3bf68b.png
[localStorage_localForage_ -]: https://juejin.cn/post/6907615220517208078