mcpField
R
redis-patterns

redis-patterns

github.com/rohitg00数据与数据库2.8k196 次安装25 周前更新
代码仓库

关于 redis-patterns

面向 Redis 开发者的参考技能,涵盖常见数据模式、实现示例和运维注意事项,帮助规划缓存、消息传递与事件处理。

主要功能

  1. 01缓存策略与 TTL
  2. 02滑动窗口限流
  3. 03Pub/Sub 与 Redis Streams
  4. 04使用 Lua 实现原子操作
  5. 05Redis 使用检查清单

适用场景

  1. 01设计缓存行为
  2. 02实现请求速率限制
  3. 03选择持久化事件处理模式

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/rohitg00/awesome-claude-code-toolkit --skill redis-patterns

安装后在 Claude Code 中输入/redis-patterns确认已加载。

详细介绍

Redis 模式

缓存策略

async function getUser(userId: string): Promise<User> {
  const cacheKey = `user:${userId}`;
  const cached = await redis.get(cacheKey);

  if (cached) {
    return JSON.parse(cached);
  }

  const user = await db.user.findUnique({ where: { id: userId } });
  if (user) {
    await redis.set(cacheKey, JSON.stringify(user), "EX", 3600);
  }

  return user;
}

async function invalidateUser(userId: string): Promise<void> {
  await redis.del(`user:${userId}`);
  await redis.del(`user:${userId}:orders`);
}

async function cacheAside<T>(
  key: string,
  ttlSeconds: number,
  fetcher: () => Promise<T>
): Promise<T> {
  const cached = await redis.get(key);
  if (cached) return JSON.parse(cached);

  const value = await fetcher();
  await redis.set(key, JSON.stringify(value), "EX", ttlSeconds);
  return value;
}

使用滑动窗口进行速率限制

async function isRateLimited(
  clientId: string,
  limit: number,
  windowSeconds: number
): Promise<boolean> {
  const key = `ratelimit:${clientId}`;
  const now = Date.now();
  const windowStart = now - windowSeconds * 1000;

  const pipe = redis.multi();
  pipe.zremrangebyscore(key, 0, windowStart);
  pipe.zadd(key, now, `${now}:${crypto.randomUUID()}`);
  pipe.zcard(key);
  pipe.expire(key, windowSeconds);

  const results = await pipe.exec();
  const count = results[2][1] as number;
  return count > limit;
}

发布/订阅

const subscriber = redis.duplicate();
await subscriber.subscribe("notifications", "orders");

subscriber.on("message", (channel, message) => {
  const event = JSON.parse(message);
  switch (channel) {
    case "notifications":
      handleNotification(event);
      break;
    case "orders":
      handleOrderEvent(event);
      break;
  }
});

async function publishEvent(channel: string, event: object): Promise<void> {
  await redis.publish(channel, JSON.stringify(event));
}

使用流处理事件

async function produceEvent(stream: string, event: Record<string, string>) {
  await redis.xadd(stream, "*", ...Object.entries(event).flat());
}

async function consumeEvents(
  stream: string,
  group: string,
  consumer: string
) {
  try {
    await redis.xgroup("CREATE", stream, group, "0", "MKSTREAM");
  } catch {
    // group already exists
  }

  while (true) {
    const results = await redis.xreadgroup(
      "GROUP", group, consumer,
      "COUNT", 10,
      "BLOCK", 5000,
      "STREAMS", stream, ">"
    );

    if (!results) continue;

    for (const [, messages] of results) {
      for (const [id, fields] of messages) {
        await processMessage(fields);
        await redis.xack(stream, group, id);
      }
    }
  }
}

流提供基于消费者组的持久化事件处理,并支持确认和重放。

用于原子操作的 Lua 脚本

const acquireLock = `
  local key = KEYS[1]
  local token = ARGV[1]
  local ttl = ARGV[2]
  if redis.call("SET", key, token, "NX", "EX", ttl) then
    return 1
  end
  return 0
`;

const releaseLock = `
  local key = KEYS[1]
  local token = ARGV[1]
  if redis.call("GET", key) == token then
    return redis.call("DEL", key)
  end
  return 0
`;

async function withLock<T>(
  resource: string,
  ttl: number,
  fn: () => Promise<T>
): Promise<T> {
  const token = crypto.randomUUID();
  const acquired = await redis.eval(acquireLock, 1, `lock:${resource}`, token, ttl);
  if (!acquired) throw new Error("Failed to acquire lock");
  try {
    return await fn();
  } finally {
    await redis.eval(releaseLock, 1, `lock:${resource}`, token);
  }
}

反模式

  • 在 Redis 中存储大型对象(>100KB)而不进行压缩
  • 在生产环境中使用 KEYS *(会阻塞服务端;请改用 SCAN)
  • 未为缓存条目设置 TTL(内存会无限增长)
  • 使用发布/订阅进行持久化消息传递(如果没有订阅者连接,消息会丢失)
  • 在没有持久化策略的情况下,将 Redis 作为唯一的数据存储
  • 多个顺序执行的命令未使用管道

检查清单

  • 缓存键遵循一致的命名约定(entity:id:field)
  • 所有缓存条目都设置了 TTL,以防止内存泄漏
  • 在生产环境中使用 SCAN 而非 KEYS 进行模式匹配
  • 对需要原子性的操作使用 Lua 脚本
  • 需要持久性时使用流而非发布/订阅
  • 为高吞吐量应用配置连接池
  • 使用有序集合通过滑动窗口进行速率限制
  • 分布式锁包含栅栏令牌和 TTL

评论

支持 Markdown