5.5 KiB
5.5 KiB
RuoYi-Vue-Plus 项目文档中心
文档概述
本文档中心包含了 RuoYi-Vue-Plus 项目的完整技术文档，涵盖需求分析、系统设计、开发指南、测试规范、部署运维等各个方面。
📚 文档目录结构
🎯 需求文档
存放项目的需求相关文档，明确项目功能和业务规则。
主要内容：
- 功能需求文档
- 业务流程文档
- 原型设计文档
- 业务规则文档
已有文档：
🏗️ 设计文档
存放项目的设计相关文档，包括系统架构、数据库设计、接口设计等。
主要内容：
- 系统架构设计
- 数据库设计文档
- API 接口设计
- 安全设计文档
- 性能设计文档
💻 开发文档
存放项目的开发相关文档，为开发人员提供详细的开发指南。
主要内容：
- 开发环境搭建
- 开发规范和指南
- 代码样例和模板
- 功能开发指南
- 问题记录和解决方案
🧪 测试文档
存放项目的测试相关文档，确保项目质量和稳定性。
主要内容：
- 测试计划文档
- 测试用例文档
- 测试报告
- 自动化测试
- 性能测试
🚀 部署文档
存放项目的部署相关文档，指导项目的部署和运维。
主要内容：
- 环境配置文档
- 容器化部署
- 自动化部署
- 监控和告警
- 运维手册
⚙️ 中间件配置
存放项目使用的各种中间件配置文档和最佳实践。
主要内容：
- 数据库配置（MySQL、Redis 等）
- 消息中间件配置
- 反向代理和负载均衡
- 监控组件配置
- 存储服务配置
🔧 技术栈概览
后端技术栈
- 框架: Spring Boot 3.4.6
- Java: JDK 17/21
- ORM: MyBatis-Plus 3.5.12
- 权限: Sa-Token 1.42.0 + JWT
- 缓存: Redis + Redisson 3.45.1
- 数据库: MySQL/Oracle/PostgreSQL/SQLServer
- 任务调度: SnailJob 1.5.0
- 工作流: Warm-Flow 1.7.3
前端技术栈
- 框架: Vue 3 + TypeScript
- UI 组件: Element Plus
- 构建工具: Vite
- 状态管理: Pinia
部署技术栈
- 容器化: Docker + Docker Compose
- 编排: Kubernetes
- 反向代理: Nginx
- 监控: Prometheus + Grafana
- 日志: ELK Stack
📖 快速导航
🚀 新手入门
💼 业务开发
🔧 运维部署
🧪 质量保证
📋 重要规范
🔒 安全规范
- 所有接口必须进行权限校验
- 敏感数据必须加密存储
- 生产环境密码定期更换
- API 接口启用加解密传输
📊 数据库规范
- 使用雪花 ID 作为主键
- 所有业务表包含基础字段（id、tenant_id、create_by 等）
- 多租户字段必须建索引
- 遵循命名规范（下划线命名法）
🌐 接口规范
- 遵循 RESTful API 设计原则
- 统一响应格式（code、msg、data）
- 使用 SpringDoc 自动生成文档
- 完整的参数校验和异常处理
🔄 代码变更规则
每次代码调整必须同步更新以下文档：
- API 文档：接口变更时更新 OpenAPI 文档
- 数据库文档：表结构变更时更新 DDL 和文档
- 配置文档：配置项变更时更新配置说明
- 部署文档：部署流程变更时更新部署手册
📞 技术支持
🔗 官方资源
- 官方文档: https://plus-doc.dromara.org
- 源码仓库: https://gitee.com/dromara/RuoYi-Vue-Plus
- 问题反馈: https://gitee.com/dromara/RuoYi-Vue-Plus/issues
📝 文档贡献
- 发现文档错误或缺失，请及时更新
- 新功能开发完成后，必须更新相关文档
- 重要经验和最佳实践，建议添加到相应文档中
📈 文档维护
- 文档版本与代码版本保持同步
- 定期 review 文档内容的准确性
- 过期文档及时标记或删除
🎯 版本信息
- 项目版本: RuoYi-Vue-Plus 5.4.0
- 文档版本: v1.0
- 最后更新: 2025 年 1 月
- 维护团队: 技术开发团队
注意: 本文档中心会随着项目的发展持续更新，请及时关注最新版本。如有任何问题或建议，欢迎通过 Issue 或技术群进行反馈。