OpenParable
Skip to content
← Back to skills

Redis Safety

Development
redis-safety

Redis Safety is an Agent Skill for development published in the doccker/cc-use-exp repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

当用户操作 Redis 相关代码(go-redis、Jedis、redis-py、ioredis)时触发。涵盖禁止 KEYS 命令、SCAN 替代、大 key 控制、Pipeline 批量、TTL 规范等安全与性能要点。

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/doccker/cc-use-exp/blob/HEAD/.gemini/skills/redis-safety/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/redis-safety, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

防止 Redis 常见性能和稳定性问题,适用于所有语言。


禁止操作

禁止替代原因
KEYS * / KEYS patternSCAN 游标迭代KEYS 是 O(N) 阻塞操作,生产环境会导致 Redis 卡死
FLUSHDB / FLUSHALL按 key 前缀 SCAN + DEL全量删除风险极高
无 TTL 的 SET所有 key 必须设置 TTL避免内存泄漏

必须遵守

1. 用 SCAN 替代 KEYS

// Go (go-redis) ❌
keys, _ := rdb.Keys(ctx, "user:*").Result()

// Go (go-redis) ✅
var cursor uint64
for {
    keys, cursor, _ = rdb.Scan(ctx, cursor, "user:*", 100).Result()
    // 处理 keys
    if cursor == 0 { break }
}
// Java (Jedis) ❌
Set<String> keys = jedis.keys("user:*");

// Java (Jedis) ✅
ScanParams params = new ScanParams().match("user:*").count(100);
String cursor = "0";
do {
    ScanResult<String> result = jedis.scan(cursor, params);
    // 处理 result.getResult()
    cursor = result.getCursor();
} while (!cursor.equals("0"));
# Python (redis-py) ❌
keys = r.keys("user:*")

# Python (redis-py) ✅
for key in r.scan_iter(match="user:*", count=100):
    # 处理 key

2. 大 key 控制

  • 单个 key 的 value 不超过 10KB
  • 集合类型(List/Set/Hash/ZSet)元素不超过 5000 个
  • 超过时拆分为多个 key

3. Pipeline 批量操作

多次 Redis 调用应使用 Pipeline 减少网络往返:

// ❌ 循环单次调用
for _, id := range ids {
    rdb.Get(ctx, "user:"+id)
}

// ✅ Pipeline 批量
pipe := rdb.Pipeline()
for _, id := range ids {
    pipe.Get(ctx, "user:"+id)
}
pipe.Exec(ctx)

4. 所有 key 设置 TTL

// ❌
rdb.Set(ctx, "token:123", value, 0)

// ✅
rdb.Set(ctx, "token:123", value, 24*time.Hour)