Files
hzdyjs/docs/项目总览/README.md
T
zlwu 7843da8943 docs: 更新项目文档
1. 更新API文档基础规范
2. 更新项目总览文档
3. 删除旧的变更记录文件
2025-07-05 13:54:12 +08:00

301 lines
8.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 项目总览
## 📋 项目基本信息
**项目名称**:高校后勤校园管理系统 (HZDYJS_XG)
**项目类型**:企业级 Web 应用系统
**开发模式**:前后端分离 + 移动端 App
**架构模式**:微服务架构 + 多租户设计
**当前版本**:v1.0.0
**开发周期**:2024.01 - 2024.10
## 🎯 项目愿景
构建一个**现代化、智能化、易用性强**的高校后勤管理平台,提升后勤服务效率,改善师生体验,实现后勤管理的数字化转型。
## 📊 核心业务领域
### 1. 📋 后勤满意度调查系统
- **目标**:收集师生对后勤服务的满意度反馈
- **价值**:数据驱动的服务质量改进
- **覆盖范围**:餐饮、宿舍、保洁、维修等全方位后勤服务
### 2. 🏛️ 报告厅预约管理系统
- **目标**:优化校园会议室/报告厅资源配置
- **价值**:提高场地利用率,减少冲突和浪费
- **覆盖范围**:各类会议室、报告厅、活动场所
### 3. 🔧 后勤维修服务系统
- **目标**:建立高效的设施维修服务流程
- **价值**:快速响应,提升维修效率
- **覆盖范围**:宿舍、教学楼、公共设施维修
### 4. 🍽️ 餐饮服务管理系统
- **目标**:提升校园餐饮服务质量和体验
- **价值**:菜品管理、营养配餐、师生反馈
- **覆盖范围**:食堂管理、外卖配送、营养健康
## 🏗️ 技术架构概览
### 系统架构图
```mermaid
graph TB
subgraph "前端层"
A1[Web管理端<br/>Vue3 + Element Plus]
A2[移动端App<br/>UniApp + uView UI]
end
subgraph "网关层"
B1[API Gateway<br/>Spring Cloud Gateway]
end
subgraph "业务服务层"
C1[用户管理服务<br/>Spring Boot]
C2[满意度调查服务<br/>Spring Boot]
C3[报告厅预约服务<br/>Spring Boot]
C4[系统管理服务<br/>Spring Boot]
end
subgraph "数据层"
D1[MySQL 8.0<br/>主数据库]
D2[Redis 7.0<br/>缓存/会话]
D3[MinIO<br/>文件存储]
end
subgraph "基础设施"
E1[Docker<br/>容器化部署]
E2[Nginx<br/>负载均衡]
E3[ELK<br/>日志分析]
E4[Prometheus<br/>监控告警]
end
A1 --> B1
A2 --> B1
B1 --> C1
B1 --> C2
B1 --> C3
B1 --> C4
C1 --> D1
C2 --> D1
C3 --> D1
C4 --> D1
C1 --> D2
C2 --> D2
C3 --> D2
C4 --> D2
C1 --> D3
C2 --> D3
C3 --> D3
C4 --> D3
```
### 技术栈详情
#### 后端技术栈
- **核心框架**:Spring Boot 3.4.6 + Spring Cloud 2023.0.x
- **开发语言**:Java 17/21
- **ORM 框架**:MyBatis-Plus 3.5.12
- **权限认证**:Sa-Token 1.42.0 + JWT
- **数据库**:MySQL 8.0(主库)+ Redis 7.0(缓存)
- **消息队列**:RabbitMQ 3.12
- **任务调度**:SnailJob 1.5.0
- **工作流引擎**:Warm-Flow 1.7.3
- **文档管理**:SpringDoc + Knife4j
#### 前端技术栈
- **Web 框架**:Vue 3.5.13 + TypeScript 5.8.3
- **UI 组件库**:Element Plus 2.9.8
- **构建工具**:Vite 7.0.9
- **状态管理**:Pinia
- **HTTP 客户端**:Axios
- **图表组件**:ECharts 5.x
#### 移动端技术栈
- **跨平台框架**:uni-app
- **UI 组件库**:uView UI
- **状态管理**:Vuex
- **地图服务**:高德地图 API
#### 部署运维
- **容器化**:Docker + Docker Compose
- **容器编排**:Kubernetes(生产环境)
- **Web 服务器**:Nginx(反向代理 + 负载均衡)
- **CI/CD**:GitLab CI/CD
- **监控告警**:Prometheus + Grafana + AlertManager
- **日志管理**:ELK Stack(Elasticsearch + Logstash + Kibana)
## 📈 项目规模指标
### 代码规模
- **后端代码**:约 15 万行 Java 代码
- **前端代码**:约 8 万行 Vue/TypeScript 代码
- **移动端代码**:约 3 万行 JavaScript 代码
- **数据库表**:约 80 张业务表
### 功能模块
- **核心业务模块**:4 个
- **基础支撑模块**:6 个
- **管理配置模块**:8 个
- **API 接口数量**:约 200 个
### 性能指标
- **并发用户数**:支持 1000+在线用户
- **响应时间**:平均响应时间 < 200ms
- **可用性**:99.9%系统可用性
- **数据处理**:支持千万级数据查询
## 👥 团队组织结构
### 项目团队
- **项目经理**:1 人(项目管理 + 需求分析)
- **架构师**:1 人(技术架构 + 核心开发)
- **后端开发**:2 人(Spring Boot 微服务开发)
- **前端开发**:2 人(Vue3 + 移动端开发)
- **测试工程师**:1 人(功能测试 + 自动化测试)
- **运维工程师**:1 人(部署运维 + 监控告警)
### 开发分工
| 模块 | 负责人 | 开发重点 |
| ------------------- | ------ | -------------------- |
| 用户管理 + 系统管理 | 张三 | 权限体系、多租户架构 |
| 满意度调查系统 | 李四 | 问卷设计器、数据统计 |
| 报告厅预约系统 | 王五 | 工作流引擎、预约算法 |
| 前端 UI + 移动端 | 赵六 | 用户体验、界面设计 |
## 📅 项目时间线
### 第一阶段:基础架构搭建(2024.01-2024.02)
- ✅ 技术选型和架构设计
- ✅ 开发环境搭建
- ✅ 基础框架集成
- ✅ 用户权限系统开发
### 第二阶段:核心功能开发(2024.03-2024.06)
- ✅ 满意度调查系统开发
- 🟡 报告厅预约系统开发(进行中)
- ⭕ 维修服务系统开发(待开始)
- ⭕ 餐饮管理系统开发(待开始)
### 第三阶段:系统集成测试(2024.07-2024.08)
- ⭕ 功能测试和集成测试
- ⭕ 性能测试和优化
- ⭕ 安全测试和加固
- ⭕ 用户验收测试
### 第四阶段:部署上线(2024.09-2024.10)
- ⭕ 生产环境部署
- ⭕ 数据迁移和初始化
- ⭕ 用户培训和推广
- ⭕ 运维监控体系建立
## 🎯 项目目标与 KPI
### 业务目标
- **服务效率提升**:报告厅预约流程效率提升 80%
- **用户满意度**:后勤服务满意度达到 90%以上
- **数据驱动决策**:建立完善的数据分析和报告体系
- **成本控制**:通过系统化管理降低运营成本 15%
### 技术目标
- **系统稳定性**:99.9%系统可用性
- **响应性能**:平均响应时间 < 200ms
- **扩展性**:支持 10 倍用户增长的架构设计
- **安全性**:通过等保三级安全认证
### 质量目标
- **代码质量**:代码覆盖率 > 80%
- **文档完整性**:100%API 文档覆盖
- **用户体验**:移动端 App 评分 > 4.5 星
- **培训效果**:用户培训通过率 > 95%
## 🔧 开发工具链
### 开发环境
- **IDE**:IntelliJ IDEA 2024.x
- **版本控制**:Git + GitLab
- **数据库工具**:Navicat Premium
- **API 测试**:Postman + Swagger UI
- **代码质量**:SonarQube
### 协作工具
- **项目管理**:禅道 + GitLab Issues
- **文档协作**:语雀 + Markdown
- **设计工具**:Figma + ProcessOn
- **沟通工具**:企业微信 + 腾讯会议
## 📋 下一步行动计划
### 近期重点(未来 2 周)
1. **完成报告厅预约系统后端开发**
2. **启动前端界面开发**
3. **完善 API 文档和测试用例**
4. **建立 CI/CD 自动化流水线**
### 中期规划(未来 1 个月)
1. **完成核心功能模块集成**
2. **开始系统性能测试**
3. **完善用户手册和培训材料**
4. **准备生产环境部署方案**
### 长期愿景(未来 3 个月)
1. **系统全面上线运行**
2. **建立运维监控体系**
3. **收集用户反馈,持续优化**
4. **探索 AI 智能化功能集成**
---
**🎯 项目愿景**:打造高校后勤管理的标杆系统,为数字化校园建设贡献力量!
## 📖 相关文档
- **业务模块详情**:[业务模块文档](../业务模块/README.md)
- **技术架构设计**:[设计文档](../设计文档/README.md)
- **开发指南**:[开发文档](../开发文档/README.md)
- **部署指南**:[部署文档](../部署文档/README.md)
## UI 设计系统
### 主题色规范
- **Web 端主题色**: rgb(50, 20, 255)
- 定义位置: web/src/assets/styles/art-variables.scss
- CSS 变量: --art-primary
- 更新时间: 2025-07-05
### 设计语言
- Art Design Pro UI 设计规范
- 轮廓式按钮设计系统
- 响应式布局
- 现代化智慧校园风格