blue-fish-redis/demo.js

这是一个修复漏洞后的redis

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
/* eslint-disable @typescript-eslint/no-unused-vars */
/* eslint-disable @typescript-eslint/no-unused-expressions */
// @ts-nocheck
const _1 = require(".");
const redisConfig = {
    // 服务器地址
    host: '127.0.0.1',
    // 端口
    port: 6379,
    // 密码，若无填空字符串
    password: '123456',
    // 数据库，默认为0
    db: 0,
    // 键前缀，可区分不同的项目
    prefix: 'pre_',
    // 是否回显查询语句
    trace: false,
};
// 创建一个基础配置实例，后续所有的组件的使用均依赖此配置实例
// 一般一个数据库只需要使用一个实例，内部会管理连接池，无需创建多个
const redisBin = new _1.RedisBin(redisConfig);
// 创建一个缓存实例
const redisCache = new _1.RedisCache(redisBin);
// 注意：为了约束模块数据的隔离，缓存实例的所有操作均需要传递nsp参数且无法省略
// 一般可将模块名称当做nsp，每个nsp之间数据相互隔离
// 设置缓存数据
await redisCache.set('module1', 'id001', 'value001', 5 * 60 * 1000 /* 5分钟 */); // 1
await redisCache.set('module1', 'id002', { name: 'A', title: 'a' }, 5 * 60 * 1000 /* 5分钟 */); // 1
// 读取缓存数据
await redisCache.get('module1', 'id001'); // 'value001'
await redisCache.get('module1', 'id002'); // { name: 'A', title: 'a' }
// 删除缓存数据（支持删除同一个nsp下的多条数据）
await redisCache.delete('module1', ['id001', 'id002']); // 2
// 批量设置缓存数据
await redisCache.mSet('module1', { id101: 'value101' }, 5 * 60 * 1000 /* 5分钟 */); // 1
await redisCache.mSet('module2', { id201: 'value201', id202: { name: 'A2', title: 'a2' } }, 5 * 60 * 1000 /* 5分钟 */); // 2
// 批量读取缓存数据
await redisCache.mGet('module1', ['id101']); // 'value101'
await redisCache.mGet('module2', ['id201', 'id202']); // { id201: 'value201', id202: { name: 'A2', title: 'a2' }
// 批量删除缓存数据（支持删除不同nsp下的多条数据）
await redisCache.mDelete([
    ['module1', ['id101']],
    ['module2', ['id201', 'id202']],
]); // 3
// 获取缓存信息，如果不存在则按照方法读取并保存
const resultWarp1 = await redisCache.warp('module1', 'id301', () => {
    // 这里做一些事情
    return Math.random(); // 返回结果
}, 10 * 60 * 1000 /* 10分钟 */);
resultWarp1; // 0.3745813097015189，10分钟内都返回 0.3745813097015189
// 这个语法糖等同于如下操作
async function getAndSetCache(nsp, id) {
    let result = await redisCache.get(nsp, id);
    if (result === undefined) {
        // 这里做一些事情
        result = Math.random(); // 得到结果
        await redisCache.set(nsp, id, result, 10 * 60 * 1000 /* 10分钟 */);
    }
    return result;
}
// 批量获取缓存信息
const resultWarp2 = await redisCache.mWarp('module1', ['id301', 'id302'], ids => {
    const result = {};
    for (const id of ids) {
        // 这里做一些事情
        result[id] = Math.random();
    }
    return result; // 返回结果，务必保证键值对形式
}, 10 * 60 * 1000 /* 10分钟 */);
resultWarp2; // { id301: 0.32430600236596074, id302: 0.29829421673682566 }
// 定义一个队列名称和消息类型名称
const QUEUE_NAME_1 = 'CHANNEL-1';
const MESSAGE_NAME_1 = 'NORMAL-MESSAGE-1';
// 定义一个消息队列
const queue = new _1.RedisQueue(redisBin, QUEUE_NAME_1);
// 定义该队列的消费者
const worker = new _1.RedisQueueWorker(queue);
worker.on(MESSAGE_NAME_1, async (id, data) => {
    console.log(`消息的ID是${id} 消息附带的数据${JSON.stringify(data)}`);
});
// 生产一个消息
await queue.push(MESSAGE_NAME_1, 'message-id-001', { value: '001' }); // 1
// 定时任务依赖于消息队列的消费者，同时要指定版本号避免版本升级瞬间任务冲突
const cron = new RedisCron(quque.worker, env.version);
// 每天10、16点执行
cron.on('0 0 10,16 * * *', () => {
    /* 做一些事情 */
});
// 每天0:30执行
cron.on('0 30 0 * * *', () => {
    /* 做一些事情 */
});
// 每10分钟执行
cron.on('0 */10 * * * *', () => {
    /* 做一些事情 */
});
// 每周一周三周五0点执行
cron.on('0 0 0 * * 1,3,5', () => {
    /* 做一些事情 */
});
// 每月1日、16日的0点执行
cron.on('0 0 0 1,16 * *', () => {
    /* 做一些事情 */
});
// 创建锁方法实例
const redisLock = new _1.RedisLock(redisBin);
// 阻塞执行，如果重复调用，会一直等待上一次调用完成
await redisLock.start('lock-for-user-register', () => {
    // 做一些事情，这个事情不会并发执行
});
// 尝试执行，如果是重复调用，则会抛出 RedisLock.Running 错误
await redisLock.try('lock-for-user-register', () => {
    // 做一些事情，这个事情不会并发执行
});
// 节流执行，1秒内只允许调用1次，重复调用会排队等待下一个1秒再执行
await redisLock.throttle('lock-for-user-register', () => {
    // 做一些事情，这个事情不会并发执行
}, 1000 /* 1秒钟 */);