使用

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

现有的浏览器数据储存方案，都不适合储存大量数据：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 对象）。

创建一个数据库

开始

    /**
     * @description 创建数据库，open方法接收两个参数 一个是数据库名字 第二个是版本号，整数，默认为1或当前版本
     */
    createDb () {
      // const request = indexedDB.open('myDatabase', 1)
      // request.addEventListener('success', () => {
      //    console.log('连接数据库成功')
      // })
      // request.addEventListener('error', () => {
      //      console.log('连接数据库失败')
      //  })
      //  request.addEventListener('upgradeneeded', () => {
      //      console.log('数据库更新')
      //  })
      // 个人更喜欢用下面的写法
     let request = window.indexedDB.open(databaseName, version)
     let db

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

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

     request.onupgradeneeded = ({ target: { result } }) => {
       // changing objectStore data is done here, as opposed to a transaction enum:
       db = result
       console.log('数据库升级', db)
     }
    }

结果

打开数据库.png

创建对象仓库

在有了数据库之后，想要去存储数据，但是单只有数据库还不够，还需要有对象仓库（object store），对象仓库（object store）是IndexedDB数据库的基础，类似于MySQL中表的概念

要创建一个对象仓库必须在upgradeneeded事件中，而upgradeneeded事件只会在版本号更新的时候触发，这是因为IndexedDB API中不允许数据库中的数据仓库在同一版本中发送变化

// changing objectStore data is done here, as opposed to a transaction enum:
request.onupgradeneeded = function ({ target: { result } }) {
  console.log('数据库升级', result)
  db = result
  let objStore
  // Node.contains()返回的是一个boolean，来表示传入的节点是否为该节点的后代节点。
  // 判断是否有person对象仓库 若没有则新建一个对象仓库(即新建表)
  if (!db.objectStoreNames.contains('person')) {
    /**
     * 新建person表 主键(key)是默认建立的索引，比如下面我们使用id做为主键
     * @param name: string
     * @param optionalParameters?: IDBIndexParameters
     * keyPath
     * autoIncrement
    */
     objStore = db.createObjectStore('person', { keyPath: 'id' })
    /**
     * 创建索引 用于快速检索
     * @param name: string
     * @param keyPath: string | string[]
     * @param optionalParameters?: IDBIndexParameters
    */
    objStore.createIndex('nameIndex', 'name', { unique: false })
  }
}

到目前为止，我们就已经有了数据库和对象仓库（数据表），然后就是数据库最基本的增、删、改、查操作。这一过程我们使用事物来操作。

一个数据库事务通常包含了一个序列的对数据库的读/写操作。它的存在包含了两个以上目的
1、为数据库操作序列提供了一个从失败中恢复到正常状态的方法，同时提供了数据库即使在异常状态下仍然保持一致性的方法
2、当多个应用程序在并发访问数据库时，可以在这些应用程序之间提供一个隔离方法，以防止彼此的操作相互干扰

以下所有操作，都可以在控制台-application-indexDB中刷新查看

1.增

    add () {
      let content = db.transaction(['person'], 'readwrite')
        .objectStore('person')
        .add({ id: 1, name: '张三', age: 24, email: 'zhangsan@example.com' });

      content.onsuccess = () => {
        console.log('数据写入成功')
      }

      content.onerror = () => {
        console.log('数据写入失败')
      }
    }

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

2. 删

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

      request.onsuccess = (event) => {
        console.log('数据删除成功', event)
      }

      request.onerror = (event) => {
        console.log('数据删除失败', event)
      }
    }

3. 改

    update () {
      const request = db.transaction(['person'], 'readwrite')
        .objectStore('person')
        .put({ id: 1, name: '李四', age: 35, email: 'lisi@example.com' })

      request.onsuccess = (event) => {
        console.log('数据删除成功', event)
      }

      request.onerror = (event) => {
        console.log('数据删除失败', event)
      }
    }

4. 查

    find () {
      // 新建查询事务
      const request = db.transaction(['person'])
        .objectStore('person')
        // 查询主键是1的  
        .get(1)
        // 通过索引查
        // .index('name')
        // .get('李四')
      request.onsuccess = (event) => {
        if (request.result) {
          console.log('data===', request.result)
        } else {
          console.log('未获得数据记录', event)
        }
      }
      
      request.onerror = (event) => {
        console.log('事务失败',event)
      }
    }

封装使用

在学会简易的写法后，为了更好的更便捷的使用，我们可以简单的封装一下

class IndexDBDemo {
  db = null

  constructor(name, storeOpt = {}, key = null, indexOpt = {}) {
    if (!this.db) {
      this.init(name, storeOpt, key, indexOpt)
    }
    return this.db
  }

    // 初始化
  init (name, storeOpt = {}, key = null, indexOpt = {}) {
    console.log('init')
    const request = indexedDB.open(name)

    return new Promise((res, reject) => {
      request.onsuccess = () => {
        this.db = request.result
      }
  
      request.onupgradeneeded = function ({ target: { result } }) {
        this.db = result
        if (!this.db.objectStoreNames.contains(name)) {
          const req = this.db.createObjectStore(name, storeOpt)
          if (key) {
            req.createIndex(key, key, indexOpt)
          }
        }
        res()
      }

      request.onerror = (error) => {
        reject(error)
      }
    })
  }

  add (name, data) {
    return new Promise((result, reject) => {
      const request = this.db.transaction([name], 'readwrite')
        .objectStore(name)
        .add(data)

      request.onsuccess = (event) => {
        result(event)
      }

      request.onerror = (error) => {
        reject(error)
      }
    })
  }

  remove(name, key) {
    return new Promise((result, reject) => {
      const request = this.db.transaction([name], 'readwrite')
        .objectStore(name)
        .delete(key)

      request.onsuccess = (event) => {
        result(event)
      }

      request.onerror = (error) => {
        reject(error)
      }
    })
  }

  update (name, data) {
    return new Promise((result, reject) => {
      const request = this.db.transaction([name], 'readwrite')
        .objectStore(name)
        .put(data)

      request.onsuccess = (event) => {
        result(event)
      }

      request.onerror = (error) => {
        reject(error)
      }
    })
  }

  search (name, index) {
    return new Promise((result, reject) => {
      const request = this.db.transaction([name])
        .objectStore(name)
        .get(index)

      request.onsuccess = (event) => {
        if (request.result) {
          result(request.result)
        } else {
          console.log('no data')
          reject()
        }
      }

      request.onerror = (error) => {
        console.log('事务失败')
        reject(error)
      }
    })
  }

  searchIndex(name, key, index) {
    return new Promise((result, reject) => {
      const request = this.db.transaction([name])
        .objectStore(name)
        .index(key)
        .get(index)

      request.onsuccess = (event) => {
        if (request.result) {
          result(request.result)
        } else {
          console.log('no data')
          reject()
        }
      }

      request.onerror = (error) => {
        reject(error)
      }
    })
  }
}
export default {
  IndexDBDemo
}

// 使用
// this.db = new IndexDBDemo(name, { keyPath: 'id', autoIncrement: true }, 'name', { unique: false })
// this.db.add(name, obj).then().catch()
// this.db.remove(name, key).then().catch()
// this.db.update(name, obj).then().catch()
// this.db.search(name, key).then().catch()
// this.db.searchIndex(name, '索引', '索引值').then().catch()

image.png

以上代码github仓库地址，后续会完善功能，会上传一个简易的存储查询系统。