Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gavinning/rmdb
缓存与持久化策略
https://github.com/gavinning/rmdb
cache mysql redis rmdb
Last synced: about 1 month ago
JSON representation
缓存与持久化策略
- Host: GitHub
- URL: https://github.com/gavinning/rmdb
- Owner: gavinning
- License: mit
- Created: 2018-11-09T11:11:11.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-10-21T12:00:18.000Z (about 3 years ago)
- Last Synced: 2023-03-26T17:31:56.685Z (almost 2 years ago)
- Topics: cache, mysql, redis, rmdb
- Language: TypeScript
- Homepage:
- Size: 256 KB
- Stars: 6
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rmdb
缓存与持久化策略
优先从Redis缓存读取数据，当缓存过期或为空时，从数据源读取返回并更新到缓存
### Install
```sh
npm i rmdb
yarn add rmdb
```
### Usage
```js
// 推荐使用 ioredis
// 依赖支持Promise的Redis实例
const { Factory } = reuqire('rmdb')
const RMDB = Factory(redis)
```
```js
// 使用ES6
import Factory from 'rmdb'
const RMDB = Factory(redis)
```
创建rmdb实例
```js
// 默认更新时间 5分钟 缓存不会过期
const rmdb = RMDB.src(key).from(dataSource)
/**
* @param {string} key 必须，Redis Key
* @param {number} autoUpdateTime 数据自动更新时间，默认5分钟
* @param {number?} expireTime 数据过期时间，可选，默认不过期
* @param {DataSource} dataSource 必须，数据来源
* @returns {RMDB}
*/
const rmdb = RMDB.src(key).keep(autoUpdateTime, expireTime).from(dataSource)
// 对于配置类型的存储，推荐不设置expireTime时间
// 缓存本身不会过期，autoUpdateTime设置更新时间间隔
// 如果更新失败将会使用缓存输出
const rmdb = RMDB.src(key).keep(autoUpdateTime).from(dataSource)
```
#### Types
```ts
export type DataSource = (...args: any[]) => any | Promise
```
#### Example 1
```js
// 每5分钟自动从数据源更新数据到缓存
const rmdb = RMDB.src('test:f1').from(() => [1,2,3])
```
#### Example 2
```js
// 每小时自动从数据源更新数据到缓存
const rmdb = RMDB.src('test:f1').keep(3600).from(() => [1,2,3])
```
#### Example 3
```js
// 每小时自动从数据源更新数据到缓存
// 数据24小时过期，数据过期后再次请求将触发数据更新
const rmdb = RMDB.src('test:f1').keep(3600, 3600*24).from(() => [1,2,3])
```
### rmdb
rmdb实例提供3个方法
```js
// 查询数据
const data = await rmdb.get()
// 使用过滤条件
// 所有参数会被当做过滤条件透传给dataSource
// 过滤条件属于高级用法，多数时候不需要，谨慎使用
const data = await rmdb.get({ id: 1 })
```
```js
// 更新数据，立即从数据源更新
// 注意！大多数时候应该使用get方法，程序会根据时间配置自动更新缓存，除非你知道自己在做什么
const result = await rmdb.update()
// 使用过滤条件
// 所有参数会被当做过滤条件透传给dataSource
// 过滤条件属于高级用法，多数时候不需要，谨慎使用
const result = await rmdb.update({ id: 1 })
```
```js
// 清理缓存
const result = await rmdb.clear()
```
### 环境变量下使用rmdb
比如根据请求参数进行缓存
* 这种情况下不推荐使用rmdb实例get以外的方法
* 应使用keep方法设置``autoUpdateTime``和``expireTime``
#### Example 1
```js
router.get('/posts', async (ctx) => {
const user = ctx.state.user
const posts = await db.post.find({ user: user.id })
return RMDB.src('app:user:posts', user.id).keep(5, 10).from(() => posts).get()
})
```
#### Example 2
> DataSource闭包捕获环境变量，无需传递过滤条件 ``推荐``
```js
function getPosts(user) {
return db.post.find({ user: user.id })
}
router.get('/posts', async (ctx) => {
const user = ctx.state.user
// DataSource闭包捕获环境变量，无需传递过滤条件
return RMDB.src('app:user:posts', user.id).keep(5, 10).from(() => getPosts(user)).get()
})
```
#### Example 2
> 直接传入DataSource函数，可能需要向get方法传递过滤条件
> get获得的所有参数会被当做过滤条件透传给DataSource
```js
function getPosts(user) {
return db.post.find({ user: user.id })
}
router.get('/posts', async (ctx) => {
const user = ctx.state.user
// 直接传入DataSource函数，可能需要向get方法传递过滤条件
// get获得的所有参数会被当做过滤条件透传给DataSource
return RMDB.src('app:user:posts', user.id).keep(5, 10).from(getPosts).get(user)
})
```
