前端localForage存储数据使用教程

前言

前端本地化存储算是一个老生常谈的话题了，我们对于 cookies、Web Storage（sessionStorage、localStorage）的使用已经非常熟悉，在面试与实际操作之中也会经常遇到相关的问题，但这些本地化存储的方式还存在一些缺陷，这就引入我们今天的主角 localForage，我会一步步带大家入门学习它，也可以算是简单快速上手教程。

localForage 是什么

localForage 是一个开源的 JavaScript 库，提供了跨浏览器、异步、简单易用的离线存储解决方案。它基于 IndexedDB、WebSQL、localStorage 等浏览器本地存储机制，通过统一的 API 接口和适配不同的存储引擎，使得访问本地存储数据变得更为简单和可靠。与传统的 localStorage 相比，localForage 具有更大的存储容量、更好的性能和更好的兼容性等优势。

localForage 的特点

localForage 具有以下一些主要特性和核心功能：

• 异步操作：localForage 的所有操作都是异步执行的，这样可以避免阻塞主线程，提高应用的性能和响应性。
• 多种存储后端支持：localForage 可以自动选择最适合的底层存储技术，包括 IndexedDB、WebSQL 和 localStorage 等。这样，无论用户使用的是新版本的浏览器还是老旧的浏览器，都可以实现跨浏览器兼容的本地存储。
• 支持各种数据类型：与 localStorage 只能存储字符串不同，localForage 可以存储各种 JavaScript 数据类型，包括对象、数组、二进制数据等。
• 简单易用的 API：localForage 提供了简单易用的 API，使得开发者可以方便地进行数据的读取、写入、更新和删除等操作。它的 API 设计与标准的 Web 存储 API 类似，因此上手和使用起来都比较容易。
• 丰富的可用性保证：localForage 支持 Promise 或回调函数等多种方式处理异步操作的结果，开发者可以根据自己的喜好和需求选择合适的方式。
• 存储容量优化：localForage 会自动检测浏览器对不同存储后端的容量限制，并根据实际情况智能地拆分数据，以便更有效地利用可用的存储空间。

localForage 的使用

1. 安装和导入

你可以通过 NPM 等安装 localForage：

npm install localforage

然后，你可以将其导入到你的代码中：

import localforage from 'localforage';

2. 初始化

在使用 localForage 之前，你需要进行初始化配置。通常在应用程序的入口处执行一次初始化即可：

localforage.config({
  driver: localforage.LOCALSTORAGE, // 指定使用的存储引擎，例如 localStorage
  name: 'myApp', // 存储数据库的名称
  version: 1.0, // 数据库版本号
  storeName: 'keyvaluepairs', // 存储对象的仓库名称
});

3. 存储数据

使用 localForage 存储数据非常简单。你可以使用 setItem 方法来存储键值对：

localforage.setItem('myKey', 'myValue')
  .then(() => console.log('Data stored successfully'))
  .catch(error => console.log('Error storing data:', error));

4. 检索数据

使用 localForage 检索存储的数据也很简单。你可以使用 getItem 方法来按照键名检索值：

localforage.getItem('myKey')
  .then(value => console.log('Retrieved value:', value))
  .catch(error => console.log('Error retrieving data:', error));

5. 删除数据

如果你想删除存储中的某个键值对，可以使用 removeItem 方法：

localforage.removeItem('myKey')
  .then(() => console.log('Data removed successfully'))
  .catch(error => console.log('Error removing data:', error));

6. 清空存储

如果你想删除存储中的所有数据，可以使用 clear 方法：

localforage.clear()
  .then(() => console.log('Storage cleared successfully'))
  .catch(error => console.log('Error clearing storage:', error));

localForage 额外功能

localForage不仅具有localStorage中的方法（getItem/setItem…）还提供了localStorage所不具有的方法。

1. 存储多种类型的数据

可以存储的数据类型有：

• Array
• ArrayBuffer
• Blob
• Float32Array
• Float64Array
• Int8Array
• Int16Array
• Int32Array
• Number
• Object
• Uint8Array
• Uint8ClampedArray
• Uint16Array
• Uint32Array
• String。

如下是其中一些数据存储方式：

// 存储对象
const data = {
  key1: 'value1',
  key2: 'value2',
  key3: 'value3'
};

localforage.setItems(data)
  .then(() => console.log('Data stored successfully'))
  .catch(error => console.log('Error storing data:', error));

// 存储数组
const numbers = [1, 2, 3, 4, 5];
localForage.setItem('numbers', numbers)
  .then(() => {
    console.log('数组已成功存储');
  })
  .catch(err => {
    console.error('存储数组时发生错误:', err);
  });

// 存储二进制数据
const buffer = new ArrayBuffer(8);  // 创建一个大小为 8 字节的二进制数据

localForage.setItem('binary', buffer)
  .then(() => {
    console.log('二进制数据已成功存储');
  })
  .catch(err => {
    console.error('存储二进制数据时发生错误:', err);
  });

2、 迭代数据（iterate）

iterate 方法允许你通过回调函数迭代存储中的所有键值对。

localforage.iterate((value, key, index) => {
  console.log(`Key: ${key}, Value: ${value}, Index: ${index}`);
})
.then(() => console.log('Iteration complete'))
.catch(error => console.log('Error iterating:', error));

3、 获取存储中的键名列表（keys）

keys 方法可以获取存储中所有键名的列表。

localforage.keys()
  .then(keys => console.log('Keys:', keys))
  .catch(error => console.log('Error retrieving keys:', error));

结语

localForage 是一个功能强大、简单易用且跨浏览器兼容的本地存储库，旨在帮助开发者克服 localStorage 的局限性，提供更灵活和可靠的本地数据存储解决方案。同时，localForage 还具备一些优化功能，如自动异步处理、缓存管理和优先级排序，以提高性能和用户体验。

想要了解更多关于localForage用法的小伙伴可以参考以下文档：localForage 中文文档