Files
redis-template/USAGE.md
T

92 lines
2.1 KiB
Markdown
Raw Normal View History

2025-10-20 18:46:59 +08:00
# Redis学习项目使用说明
## 项目结构说明
本项目包含以下主要文件和目录:
### 源代码目录
- `src/main/java/cn/hezhaohui/redis/` - Redis操作类目录
- `RedisConnection.java` - Redis连接管理类
- `RedisStringOperations.java` - 字符串操作类
- `RedisListOperations.java` - 列表操作类
- `RedisSetOperations.java` - 集合操作类
- `RedisHashOperations.java` - 哈希操作类
- `RedisSortedSetOperations.java` - 有序集合操作类
- `RedisBasicOperations.java` - 基础操作类
- `src/main/java/cn/hezhaohui/test/` - 测试类目录
- `RedisConnectionTest.java` - 连接测试类
- `src/main/resources/application.yml` - Spring Boot配置文件
### 测试目录
- `src/test/java/cn/hezhaohui/RedisIntegrationTest.java` - 集成测试类
### 文档文件
- `README.md` - 项目说明文档
- `LEARNING_GUIDE.md` - 详细学习指南
- `LEARNING_PLAN.md` - 学习计划文档
## 使用方法
### 1. 环境准备
确保已安装以下软件:
- Java 17或更高版本
- Maven
- Redis服务器
### 2. 启动Redis服务器
在终端中运行:
```bash
redis-server
```
### 3. 编译项目
```bash
mvn compile
```
### 4. 运行测试
```bash
# 运行连接测试
mvn exec:java -Dexec.mainClass="cn.hezhaohui.RedisConnectionTest"
# 运行所有测试
mvn test
```
### 5. 使用启动脚本
- Linux/Mac: `./start.sh`
- Windows: `start.bat`
### 6. 使用Makefile
```bash
# 显示帮助
make help
# 编译项目
make build
# 运行测试
make test
# 启动Redis服务器
make redis-start
# 检查Redis状态
make redis-status
```
## 学习建议
1. **从基础开始**:先理解Redis的基本概念和数据类型
2. **动手实践**:每个类都有TODO注释,按照注释逐步实现功能
3. **编写测试**:为每个功能编写测试用例验证正确性
4. **循序渐进**:按照学习计划的阶段逐步学习
5. **查阅文档**:参考Redis官方文档和学习指南
## 项目特点
- 完整的Redis操作类实现
- 详细的TODO注释指导学习
- 集成测试框架
- Spring Boot配置支持
- 跨平台支持(Windows/Linux/Mac)