Преглед изворни кода

docs(readme): 初始化项目文档结构与内容

- 添加项目概述与技术栈说明
- 列出核心功能模块及其对应控制器
- 描述文档目录结构与用途
- 提供开发与部署相关说明
- 记录已知技术问题与解决方案
- 明确数据库与开发规范文档位置
mcbaiyun пре 1 месец
родитељ
комит
422e77f41f
1 измењених фајлова са 66 додато и 0 уклоњено
  1. 66 0
      docs/readme.md

+ 66 - 0
docs/readme.md

@@ -0,0 +1,66 @@
+# 慢病管理App后端项目文档
+
+本项目为慢病管理App的后端服务系统,采用Spring Boot + MyBatis-Plus技术栈构建,主要用于支持移动端用户的健康管理功能。
+
+## 项目结构概览
+
+- `src/main/java/work/baiyun/chronicdiseaseapp`:核心Java源码目录
+- `src/main/resources`:资源配置文件
+- `pom.xml`:Maven项目依赖管理
+- `build-and-run.bat`:Windows环境下的构建与启动脚本
+
+## 核心功能模块
+
+### 数据采集
+- 血糖数据管理 (`BloodGlucoseDataController`)
+- 血压数据管理 (`BloodPressureDataController`)
+- 心率数据管理 (`HeartRateDataController`)
+- 身体数据管理 (`PhysicalDataController`)
+
+### 健康管理
+- 复诊随访管理 (`FollowUpController`)
+- 患者用药记录 (`PatientMedicationController`)
+- 患者健康档案 (`PatientHealthRecordController`)
+- 用药信息管理 (`MedicineController`)
+- 提醒事项管理 (`PatientReminderController`)
+
+### 用户体系
+- 微信登录与Token管理 (`WeChatController`, `UserTokenMapper`)
+- 用户信息与头像管理 (`UserInfoMapper`, `UserAvatarController`)
+- 用户绑定关系管理 (`UserBindingController`)
+- 权限拦截与认证配置 (`AuthInterceptor`, `WebMvcConfig`)
+
+### 系统监控
+- 用户行为日志记录 (`UserActivityLogAspect`, `UserActivityLogController`)
+- 接口调用链追踪 (`TraceInterceptor`, `TraceUtils`)
+- 全局异常处理 (`CustomExceptionHandler`)
+- 统一返回结果封装 (`R.java`)
+
+## 文档目录说明
+
+### `/DB`
+包含所有数据库表结构设计文档,以文本形式描述各表字段、类型及用途。
+
+### `/Dev`
+开发规范与架构设计文档目录,包含核心模块设计和功能模块详细说明。
+
+### `/issues`
+技术问题解决方案归档,记录了项目开发过程中遇到的典型问题及其解决方法,如:
+- Swagger泛型返回类型字段信息不显示问题
+- 前端ID精度丢失问题
+- 患者提醒数据管理功能修复经历
+
+## 技术栈
+
+- **框架**:Spring Boot, MyBatis-Plus
+- **接口文档**:Knife4j (Swagger增强)
+- **数据库**:MySQL(推测)
+- **构建工具**:Maven
+- **日志系统**:Logback
+- **代码风格**:遵循Java编码规范,结合自定义枚举处理器
+
+## 开发与部署
+
+使用 `build-and-run.bat` 脚本可在Windows环境下一键编译并启动应用。项目支持微信OAuth2登录集成,并通过Token机制维护用户会话。
+
+更多细节请参考具体模块文档。