Redis Key 命名规范详解

Redis Key 命名规范详解

在Redis中，合理的key命名是非常重要的，它不仅影响代码的可读性，还关系到数据的组织结构和维护效率。以下是Redis key命名的详细规范和建议：

1. 基本命名原则

1.1 使用统一的命名空间

• 使用冒号(:)作为分隔符创建层次结构
• 格式：业务模块:子模块:具体含义[:ID]
• 示例：user:profile:123 表示ID为123的用户资料

1.2 保持简洁但具有描述性

• 避免过长（Redis key最大512MB，但实际应保持简短）
• 避免过短而无意义（如a:b:c）

2. 推荐命名模式

2.1 对象类型标识

• user:{id} - 用户对象
• order:{id} - 订单对象
• product:{id} - 产品对象

2.2 关系型数据

• user:{uid}:orders - 用户的所有订单
• product:{pid}:likes - 产品的点赞数

2.3 系统级key

• config:redis:maxmemory - Redis配置
• stats:users:active - 活跃用户统计

3. 命名最佳实践

3.1 避免特殊字符

• 只使用字母、数字、冒号和下划线
• 避免空格、引号、换行符等特殊字符

3.2 大小写规范

• 推荐全小写（Redis是大小写敏感的）
• 或使用驼峰式，但要保持一致性

3.3 固定前缀

• 对于多租户系统：tenant1:user:123
• 对于多环境：dev:config:redis / prod:config:redis

3.4 版本控制

• 对于可能变更的数据结构：v1:user:profile:123

4. 反模式与避免方法

4.1 避免的实践

• 不使用随机生成的key而不加前缀
• 不使用易冲突的简单名称（如data、info）
• 不过度嵌套（如a:b:c:d:e:f）

4.2 大key问题

• 避免将大量数据存放在单个key中
• 考虑分片：bigdata:shard1, bigdata:shard2

5. 实际应用示例

5.1 用户系统

• user:123:profile - 用户基本信息
• user:123:settings - 用户设置
• user:email:user@example.com - 通过邮箱查找用户ID

5.2 电商系统

• product:456:info - 产品详情
• product:456:inventory - 产品库存
• order:789:items - 订单中的商品
• category:2:products - 分类下的产品列表

5.3 社交网络

• post:1001:likes - 帖子的点赞数
• user:123:followers - 用户的粉丝
• user:123:following - 用户的关注列表

6. 工具类key命名

6.1 锁机制

• lock:order:update:456 - 订单更新的分布式锁

6.2 计数器

• counter:page:views:home - 首页访问计数

6.3 临时数据

• temp:session:abc123 - 临时会话数据

7. 性能考虑

1. key长度：较短的key节省内存但要有意义
2. hash tag：对于集群模式，使用{...}确保相关key在同一slot
   • 示例：user:{123}:profile和user:{123}:orders会被分配到同一节点

遵循这些规范可以创建出易于理解、维护和扩展的Redis key结构，同时保证系统的性能和可伸缩性。