项目介绍

  1.      /\_____/\
  2.     /  o   o  \          redis-for-rust 0.0.1
  3.    ( ==  ^  == )
  4.     )         (          Bind: 127.0.0.1:6379
  5.    (           )
  6.   ( (  )   (  ) )        
  7.  (__(__)___(__)__)
  9. [2024-04-17T03:41:58Z INFO  redis_for_rust] Server initialized
  10. [2024-04-17T03:41:58Z INFO  redis_for_rust] Ready to accept connections

Redis for rust 服务端重写是一个基于 Rust 编程语言重新实现的 Redis 服务端，旨在提供高性能、可靠性和安全性的键值存储服务。通过利用 Rust 的优势，我们重新设计和实现了 Redis 的核心功能，使其更适合现代应用的需求。

特性：

  • 兼容 Redis 协议和常见的 Redis 命令
  • 提供高效的内存管理和并发处理能力

快速启动

  • 本地调试
  1. // 普通启动
  2. cargo run
  4. // 带参启动
  5. cargo run -- --port 8848
  7. // 构建程序
  8. cargo build
  • Windows 
  1. // 普通启动
  2. start redis-for-rust.exe
  4. // 带参启动
  5. start redis-for-rust.exe --port 8848

启动参数

  • databases 数据库数量, 默认：16
  • port 端口, 默认: 6379
  • password 密码, 默认：None
  • appendfilename 持久化日志路径，默认：None
  • appendonly 开启持久化，默认：false

项目结构

command

command 包是一个用Rust编写的模拟Redis服务器的组件，主要负责实现Redis协议的解析、数据库操作的执行以及相关结果的响应。该包内部包含了针对不同Redis命令的实现，如SELECT、GET、SET等。其核心功能是根据Redis协议规范，解析来自客户端的命令请求，并在模拟的Redis数据库上执行相应的操作，再将结果返回给客户端。通过实现各个Redis命令处理器，实现了对Redis协议的完整支持，并提供了一个简单而有效的策略来处理不同类型的命令。

db

db 包是一个基于内存的数据库管理系统。该模块提供了基础的数据结构约定，以及数据库操作功能，包括对数据的增、删、改、查等操作。

session

session 模块的设计目的是提供一个简单的会话管理功能，用于跟踪用户的操作状态，例如用户所选的数据库索引以及用户是否已认证等信息。这对于需要进行用户认证或者跟踪用户操作状态的系统是非常有用的。

tools

tools 包是一个工具包，其中包含了一些通用的工具函数或工具类，用于辅助实现系统功能或处理特定任务。这些工具可以被其他模块或组件调用，以提高代码复用性和降低重复编写相似功能的工作量。

操作命令

echo 命令

  1. 127.0.0.1:6379> echo helloword
  2. helloword

ping 命令

  1. 127.0.0.1:6379> ping
  2. PONG

set 命令

  1. 127.0.0.1:6379> set user bailiang
  2. OK

set 命令 [过期]

  1. 127.0.0.1:6379> set user bailiang px 10000
  2. OK
  3. 127.0.0.1:6379> set user bailiang ex 10
  4. OK

get 命令

  1. 127.0.0.1:6379> get user
  2. bailiang

del 命令

  1. 127.0.0.1:6379> del username
  2. (integer) 1
  3. 127.0.0.1:6379> del username password
  4. (integer) 2

exists 命令

  1. 127.0.0.1:6379> exists user
  2. (integer) 0

keys 命令

  1. 127.0.0.1:6379> keys *
  2. (empty list or set)

auth 命令

  1. 127.0.0.1:6379> auth 123456
  2. OK

expire 命令

  1. 127.0.0.1:6379> expire user 10000
  2. (integer) 0

select 命令

  1. 127.0.0.1:6379> select 1
  2. OK

dbsize 命令

  1. 127.0.0.1:6379> dbsize
  2. (integer) 2

flushdb 命令

  1. 127.0.0.1:6379> flushdb
  2. OK

flushall 命令

  1. 127.0.0.1:6379> flushall
  2. OK

append 命令

  1. 127.0.0.1:6379> append user bailiang
  2. (integer) 10

move 命令

  1. 127.0.0.1:6379> move user 0
  2. OK

rename 命令

  1. 127.0.0.1:6379> rename username new_username
  2. OK

rpush 命令

  1. 127.0.0.1:6379> rpush key value1 value2
  2. OK

lpush 命令

  1. 127.0.0.1:6379> lpush key value3 value4
  2. OK

llen 命令

  1. 127.0.0.1:6379> llen key
  2. (integer) 4

更新计划

  • 持久存储，存储每条修改命令到本地文件，启动时重新加载实现持久化存储；
  • 日志体系，完善系统中日志打印，制订规范，帮助使用者更快速的追溯问题；
  • 测试用例，针对项目中的每个命令，编写对应的单元测试，提高项目稳定性；

命令列表

Command Supprt Appendfile Test case
set ✅ ✅ ⛔
get ✅ ⚪ ⛔
del ✅ ✅ ⛔
echo ✅ ⚪ ⛔
flushdb ✅ ✅ ⛔
flushall ✅ ✅ ⛔
dbsize ✅ ⚪ ⛔
auth ✅ ⚪ ⛔
select ✅ ⚪ ⛔
llen ✅ ⚪ ⛔
exists ✅ ⚪ ⛔
expire ✅ ✅ ⛔
rename ✅ ✅ ⛔
move ✅ ✅ ⛔
lpush ✅ ✅ ⛔
rpush ✅ ✅ ⛔
append ✅ ✅ ⛔
incr ✅ ✅ ⛔
decr ✅ ✅ ⛔

性能测试

  • percent: 100% lines: 100000/100000 time: 00:00:04

  • percent: 100% lines: 200000/200000 time: 00:00:09

  • percent: 100% lines: 400000/400000 time: 00:00:19

代码仓库

Github：https://github.com/sleeprite/redis-for-rust

Gitee：https://gitee.com/Jmysy/redis-for-rust

开源共建

Redis for rust 项目遵循 GNU GENERAL PUBLIC LICENSE 开源协议，感谢这些优秀的 Contributors。

指南 - 图1