🚀 从零开始,用 Go 语言手写一个完整的 Redis 服务器
带有完整项目笔记,没有遗漏任何细节,适合用于学习 Redis 的实现原理。
📖 笔记
🌐 在线笔记
本地运行笔记:
cd guide
npm install
npm run dev
# 访问 http://localhost:3000
笔记目录
🏗️ 基础架构
🔧 数据结构篇
🚀 高级特性
✨ 核心特性
🎯 已实现功能
- ✅ 网络层:TCP 服务器
- ✅ 协议层:RESP 协议解析器
- ✅ 存储引擎:内存数据库
- ✅ 数据结构:String、List、Hash、Set、ZSet
- ✅ 持久化:AOF (Append Only File) 机制
- ✅ 集群:一致性哈希
🔧 支持的 Redis 命令
🔑 键操作命令
DEL key [key ...] # 删除一个或多个键
EXISTS key [key ...] # 检查键是否存在
FLUSHDB # 清空当前数据库
TYPE key # 获取键的数据类型
RENAME key newkey # 重命名键
RENAMENX key newkey # 仅当新键不存在时重命名
KEYS pattern # 查找匹配模式的键
📝 字符串操作
SET key value # 设置键值对
GET key # 获取键的值
SETNX key value # 仅当键不存在时设置
GETSET key value # 设置新值并返回旧值
STRLEN key # 获取字符串长度
📋 列表操作
LPUSH key value [value ...] # 从左侧插入元素
RPUSH key value [value ...] # 从右侧插入元素
LPOP key # 从左侧弹出元素
RPOP key # 从右侧弹出元素
LRANGE key start stop # 获取指定范围的元素
LLEN key # 获取列表长度
LINDEX key index # 获取指定位置的元素
LSET key index value # 设置指定位置的元素值
🏠 哈希操作
HSET key field value # 设置哈希字段
HGET key field # 获取哈希字段值
HEXISTS key field # 检查哈希字段是否存在
HDEL key field [field ...] # 删除哈希字段
HLEN key # 获取哈希字段数量
HGETALL key # 获取所有字段和值
HKEYS key # 获取所有字段名
HVALS key # 获取所有字段值
HMGET key field [field ...] # 获取多个字段值
HMSET key field value [field value ...] # 设置多个字段
HSETNX key field value # 仅当字段不存在时设置
🎯 集合操作
SADD key member [member ...] # 添加集合成员
SCARD key # 获取集合成员数量
SISMEMBER key member # 检查成员是否在集合中
SMEMBERS key # 获取所有集合成员
SREM key member [member ...] # 删除集合成员
SPOP key [count] # 随机弹出集合成员
SRANDMEMBER key [count] # 随机获取集合成员
SUNION key [key ...] # 计算集合并集
SUNIONSTORE dest key [key ...] # 存储集合并集
SINTER key [key ...] # 计算集合交集
SINTERSTORE dest key [key ...] # 存储集合交集
SDIFF key [key ...] # 计算集合差集
SDIFFSTORE dest key [key ...] # 存储集合差集
⚖️ 有序集合操作
ZADD key score member [score member ...] # 添加有序集合成员
ZSCORE key member # 获取成员分数
ZCARD key # 获取有序集合成员数量
ZRANGE key start stop [WITHSCORES] # 按索引范围获取成员
ZREM key member [member ...] # 删除有序集合成员
ZCOUNT key min max # 统计分数范围内的成员数量
ZRANK key member # 获取成员排名
🔧 系统命令
PING # 测试连接
SELECT index # 选择数据库
🚀 快速开始
环境要求
- Go 1.21+
- Git
- Node.js 18+ (可选,用于运行笔记)
查看笔记的方式
# 1. 克隆项目
git clone https://github.com/inannan423/redigo.git
cd redigo
# 2. 启动笔记(可选,可以访问 https://redigo.vercel.app)
cd guide
npm install
npm run dev
# 访问 http://localhost:3000 开始学习
# 3. 按笔记进度切换分支学习
git checkout tcp-server # 第一章:TCP 服务器
git checkout resp-parser # 第二章:RESP 协议
git checkout database # 第三章:数据库核心
# ... 更多分支见笔记
方式二:直接运行完整版 🏃♂️
# 1. 克隆项目
git clone https://github.com/inannan423/redigo.git
cd redigo
# 2. 启动单机模式
go run main.go
# 3. 启动集群模式(需要配置 redis.conf)
# 编辑 redis.conf 设置集群节点
go run main.go
客户端连接测试
# 使用 Redis 官方客户端
redis-cli -h localhost -p 6379
# 测试基本命令
127.0.0.1:6379> SET hello world
OK
127.0.0.1:6379> GET hello
"world"
127.0.0.1:6379> PING
PONG
📊 性能基准
TODO: 添加性能测试结果
🗓 TODO
- 完善集群模式
- 实现更多 Redis 命令
- 增加更多数据结构支持
- 提升测试覆盖率
🤝 贡献指南
欢迎贡献!
- 🐛 Bug 修复:发现问题请提交 Issue,或者直接提交 Commit
- 📚 文档改进:让笔记更清晰易懂
- ✨ 新功能:实现更多 Redis 命令
- 🎯 性能优化:优化 Redigo 的性能
- 🧪 测试用例:提高代码覆盖率
如何贡献
- Fork 本项目
- 创建特性分支 (
git checkout -b feature/AmazingFeature
) - 提交改动 (
git commit -m 'Add some AmazingFeature'
) - 推送到分支 (
git push origin feature/AmazingFeature
) - 创建 Pull Request
💬 学习交流
- 📖 笔记问题:查看在线文档
- 🐛 Bug 反馈:提交 Issue
- 💡 功能建议:在 Issues 中标记
enhancement
- 📧 邮件咨询:jetzihan@outlook.com
📜 开源协议
本项目采用 GPL-3.0 协议,详情请查看 LICENSE 文件。
🙏 致谢
- Godis 本项目学习了 Godis 的设计思路和部分实现,感谢大佬们的贡献!
⭐ 如果这个项目对你有帮助,请给我一个 Star!
📧 有问题? 欢迎提交 Issue 或发邮件讨论。