Files
wwjcloud/DEVELOPMENT_PLAN.md

121 lines
3.2 KiB
Markdown
Raw Permalink Normal View History

# WWJCloud 开发计划
## 开发顺序
按以下顺序完成各层开发:
1.**Config 层** - 框架配置中心(已完成基础配置)
2. 🔄 **Core 层** - 基础设施层(进行中)
3.**Vendor 层** - 第三方集成层(待开发)
4.**Common 层** - 通用业务层(最后开发)
## Core 层开发计划
基于 NestJS 官方文档实现以下模块:
### 1. 缓存模块 (Cache Module)
**参考文档**: https://docs.nestjs.cn/techniques/caching
- [ ] 使用 `@nestjs/cache-manager` 集成缓存
- [ ] 实现 Redis 缓存支持
- [ ] 实现内存缓存支持
- [ ] 提供统一的缓存接口
### 2. 队列模块 (Queue Module)
**参考文档**: https://docs.nestjs.cn/techniques/queues
- [ ] 使用 `@nestjs/bull` 集成队列
- [ ] 实现任务队列处理
- [ ] 实现延迟任务
- [ ] 实现任务重试机制
### 3. 事件模块 (Event Module)
**参考文档**: https://docs.nestjs.cn/techniques/events
- [ ] 使用 `@nestjs/event-emitter` 实现事件系统
- [ ] 实现事件发布
- [ ] 实现事件订阅
- [ ] 实现事件监听器
### 4. 安全模块 (Security Module)
**参考文档**: https://docs.nestjs.cn/security/authentication
- [ ] 实现 JWT 认证
- [ ] 实现守卫 (Guards)
- [ ] 实现拦截器 (Interceptors)
- [ ] 实现管道 (Pipes)
### 5. 调度模块 (Scheduler Module)
**参考文档**: https://docs.nestjs.cn/techniques/task-scheduling
- [ ] 使用 `@nestjs/schedule` 实现定时任务
- [ ] 实现 Cron 任务
- [ ] 实现间隔任务
- [ ] 实现超时任务
### 6. 链路追踪模块 (Tracing Module)
- [ ] 实现请求追踪
- [ ] 实现日志追踪
- [ ] 实现性能监控
### 7. 上下文模块 (Context Module)
- [ ] 实现请求上下文
- [ ] 实现用户上下文
- [ ] 实现站点上下文
### 8. 初始化模块 (Init Module)
- [ ] 实现应用启动初始化
- [ ] 实现健康检查
- [ ] 实现优雅关闭
### 9. Swagger 文档模块
**参考文档**: https://docs.nestjs.cn/recipes/swagger
- [ ] 使用 `@nestjs/swagger` 实现 API 文档
- [ ] 实现文档配置
- [ ] 实现文档访问控制
## Vendor 层开发计划
基于 NestJS 官方文档实现第三方集成:
### 1. 支付模块 (Pay Module)
- [ ] 实现支付宝集成
- [ ] 实现微信支付集成
- [ ] 实现统一支付接口
### 2. 短信模块 (SMS Module)
- [ ] 实现阿里云短信
- [ ] 实现腾讯云短信
- [ ] 实现统一短信接口
### 3. 通知模块 (Notice Module)
- [ ] 实现邮件通知
- [ ] 实现站内通知
- [ ] 实现推送通知
### 4. 上传模块 (Upload Module)
- [ ] 实现本地上传
- [ ] 实现云存储上传
- [ ] 实现统一上传接口
### 5. 存储模块 (Storage Module)
- [ ] 实现阿里云 OSS
- [ ] 实现腾讯云 COS
- [ ] 实现七牛云存储
## Config 层完善计划
- [ ] 完善配置验证
- [ ] 实现配置热更新
- [ ] 实现配置缓存
## 开发规范
1. **必须查阅 NestJS 中文网相关文档**
2. **严格遵循 NestJS 官方最佳实践**
3. **使用 NestJS 官方推荐的包和模块**
4. **保持代码风格一致**
5. **添加完整的注释和文档**
## 参考文档
- NestJS 中文文档: https://docs.nestjs.cn/
- NestJS 英文文档: https://docs.nestjs.com/
- NiuCloud Java 版本: /niucloud-java/
- NiuCloud PHP 版本: /niucloud-php/