msn-cache v1.0.1

msn-cache

msn 是什么？

msn分别是memory, storage, network的首字母。

从v1.0.0开始，storage改成indexedDB，而仓库的名称还是保持原有

这是一个用于处理缓存的工具，针对memory => indexedDB => network 逐级递减来获取缓存，优先从memory提取数据，若不存在则通过indexedDB获取，若还是存在，则发出请求获取数据；其中对memory的处理算法规则，使用LRU、FIFO算法来处理（后续会添加LFU算法），避免过度占用内存。

PS: 若当前环境不支持indexedDB，则该工具自动跳过indexedDB层面，保留memory => network寻找链条。memory找不到则通过network获取数据。

Background

在应用运行的时候，可能会存在部分数据在切换路由的时候重复请求；如果把所有请求数据都缓存下来，使用时间越久，内存缓存的数据就一直递增。这一个工具利用比较常见的算法处理内存中的缓存，把溢出当前处理的数据，写入到indexedDB中，能够减少内存使用。

Install

yarn add msn-cache
# or
npm install msn-cache

Usage

import MCache from 'msn-cache'

const mc = new MCache({
  name: 'LRU',
  capacity: 2
})

// get value from cache
mc.get('key', () => { /* request function */ })
// put new key-value in cache
mc.put('key', value)

• LRU算法
• LFU算法
• FIFO算法

API

Global method

MCache

• 描述 cache的class，用于生成缓存实例
• 参数
  • {IAlgorithm} algorithmOption
    • {String} name 缓存的算法类型，目前可以指定"LRU"、"FIFO"两种算法
    • {Number} capacity 设置内存缓存的数量
  • {Date | Number} expired （可选）设置 indexedDB 中存放数据的过期时间，可以设置相对时间，单位：毫秒数；也可以设置绝对时间Date，默认值为：30分钟；
• 返回值：缓存实例
• 用法

import { MCache } from 'msn-cache'
const mc = new MCache(
  {
    name: 'LRU',
    capacity: 2 // 内存中最多存两条数据
  },
  expired: 60 * 60 * 1000 // 设置 indexedDB过期时间为一个小时
)

Instance Method

init

• 描述 初始化 indexedDB 的连接
• 参数：空

const mc = new MCache({/* ... */})

(async function wrap() {
  await mc.init()
  // other instance method
})()

get

• 描述 获取缓存中的数据
• 参数
  • {String} key 设置到cache的key值
  • {Function} fn （可选）当从内存与storage获取不到数据，则调用该方法返回数据，支持Promise使用，没有该值默认为：null
  • {Number | Date} expired （可选）对该key值设定特定的过期时间，覆盖全局的过期时间
• 返回值：Promise，resolve数据为获取到的数据
• 用法

const mc = new MCache({/* ... */})

(async function wrap() {
  await mc.init()
  let value = await mc.get('key', () => {
    // 获取不到数据的回调方法
    return fetch('/api/example')
  })
})()

put

• 描述 往缓存中写入数据
• 参数
  • {String} key 设置到cache的key值
  • {Any} value 设置到cache的value值，undefined除外
  • {Number | Date} expired （可选）对该key值设定特定的过期时间，覆盖全局的过期时间
• 返回值：void
• 用法

const mc = new MCache({/* ... */})

(async function wrap() {
  await mc.init()
  mc.put('key', { value: 'this is cache value' }, 10 * 60 * 1000) // 过期时间为10分钟
})

License

MIT