redis-safety
当用户操作 Redis 相关代码(go-redis、Jedis、redis-py、ioredis)时触发。涵盖禁止 KEYS 命令、SCAN 替代、大 key 控制、Pipeline 批量、TTL 规范等安全与性能要点。
git clone --depth 1 https://github.com/doccker/cc-use-exp /tmp/redis-safety && cp -r /tmp/redis-safety/.claude/skills/redis-safety ~/.claude/skills/redis-safetySKILL.md
# Redis 安全规范
> 防止 Redis 常见性能和稳定性问题,适用于所有语言。
---
## 禁止操作
| 禁止 | 替代 | 原因 |
|------|------|------|
| `KEYS *` / `KEYS pattern` | `SCAN` 游标迭代 | KEYS 是 O(N) 阻塞操作,生产环境会导致 Redis 卡死 |
| `FLUSHDB` / `FLUSHALL` | 按 key 前缀 SCAN + DEL | 全量删除风险极高 |
| 无 TTL 的 SET | 所有 key 必须设置 TTL | 避免内存泄漏 |
## 必须遵守
### 1. 用 SCAN 替代 KEYS
```go
// 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
// 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
# 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 减少网络往返:
```go
// ❌ 循环单次调用
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
```go
// ❌
rdb.Set(ctx, "token:123", value, 0)
// ✅
rdb.Set(ctx, "token:123", value, 24*time.Hour)
```当设计或修改 REST API 响应结构、处理 API 返回值,或生成 Excel/CSV/PDF/对账文件等下游产物时触发。防止 API 设计缺陷导致的字段错位、类型歧义,以及生成产物时关键字段缺失但静默成功的问题。
网关/代理/WAF/CDN 中间件的安全关键词匹配实现规范,防止纯子串匹配误判正常响应内容中的技术术语(如 Cloudflare、502、error)
当 API/任务可能执行超过 10 秒(批量数据处理、远程 API 批量调用、全表扫描、跨租户聚合)时触发。防止同步接口被网关 30s 超时切断、用户重复点击触发并发、状态缓存内存泄漏等问题。提供异步任务状态机标准模板。
当用户操作 .sh、Dockerfile、Makefile、.yml、.yaml 文件,或在 Markdown 中编写 bash 代码块时触发。提供 Bash 编写规范。
当编写新模块、设计接口、重构代码或代码审查时触发。提供经典模块化六原则检查清单(大小适中/调用深度/扇入扇出/边界清晰/作用域内聚/可预测性),适用于 PR/Review/新模块设计场景。
涉及浏览器、编辑器、CDN/WAF、IM 平台、操作系统剪贴板、第三方 SaaS 等"外部黑盒系统"的代码编写或 bug 调试时触发。强制先抓真实环境数据再推理,避免连续 2 轮"凭代码推理"的修复 no-op。关键词:粘贴/复制异常、跨平台显示不一致、第三方 API 怪结果、CDN/WAF 拦截、本地复现失败、HTML→MD 转换丢属性。
当重构涉及字段映射(dataIndex、枚举映射、类型转换)时触发。防止字段名推测错误,确保字段映射的正确性。
前端开发规范,包含 Vue 3 编码规范、UI 风格约束、TypeScript 规范等