fangxh2013
/
pangu-user-platform
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: 完善需求与系统设计文档、README 

- 需求规格说明书：审核状态、修订记录V1.2，验收标准补充系统监控（服务监控）
- 系统设计文档：技术选型（Spring Boot 3.5.x、Sa-Token）、模块划分与 backend 结构一致
- README：项目结构、技术栈、构建与部署说明、系统监控说明

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
神码-方晓辉 2026-02-06 10:25:38 +08:00
parent d6e922cc2f
commit 0b528e03d8
3 changed files with 57 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
README.md
View File

@ -10,46 +10,38 @@
``` ```
pangu-user-platform/ # 项目根目录 pangu-user-platform/ # 项目根目录
├── pom.xml # ⭐ Maven父项目配置 (必须在根目录)
├── README.md # 项目说明文档 ├── README.md # 项目说明文档
├── backend/ # 后端代码 ├── backend/ # 后端代码 (RuoYi-Vue-Plus 5.5.x)
│ ├── README.md # 后端构建说明 (重要!) │ ├── README.md # 后端构建说明 (重要!)
│ ├── pangu-admin/ # 启动模块 (Spring Boot) │ ├── pom.xml # 后端父 POM
│ │ └── pom.xml # 子模块配置 │ ├── pangu-admin/ # 启动与认证入口 (Spring Boot)
│ ├── pangu-common/ # 公共模块 (工具类、常量) │ ├── pangu-common/ # 公共模块 (core/redis/security/satoken 等)
│ │ └── pom.xml │ ├── pangu-modules/ # 业务与系统模块
│ ├── pangu-framework/ # 框架模块 (配置、拦截器) │ │ ├── pangu-system/ # 系统 (用户/角色/菜单/部门/字典/监控)
│ │ └── pom.xml │ │ ├── pangu-business/ # 业务 (学校/会员/学生/应用/基础数据/H5/开放API)
│ ├── pangu-system/ # 业务模块 (学校、会员、学生、应用) │ │ ├── pangu-generator/ # 代码生成
│ │ └── pom.xml │ │ └── pangu-job/ # 定时任务
│ ├── sql/ # 数据库脚本 │ ├── pangu-extend/ # 扩展 (Monitor Admin、SnailJob Server 等)
│ └── scripts/ # 运维脚本 │ ├── script/ # 数据库脚本等
├── frontend/ # 前端代码 │ └── 各模块 pom.xml
│ └── frontend/ # Vue3 + Element Plus + Vite ├── frontend/ # 管理后台前端 (Vue3 + Element Plus + Vite)
│ ├── package.json # 前端依赖配置 │ ├── package.json
│ └── README.md # 前端使用说明 │ └── src/
└── docs/ # 项目文档 └── docs/ # 项目文档
├── 01-需求文档/ ├── 01-需求文档/
├── 02-系统设计/ ├── 02-系统设计/
├── 03-数据库设计/ ├── 03-数据库设计/
├── 04-接口文档/ ├── 04-接口文档/
├── 05-前端UI规范/ ├── 05-前端UI规范/、05-技术方案/、05-模块技术方案/
├── 05-技术方案/
├── 05-模块技术方案/
├── 06-测试文档/ ├── 06-测试文档/
└── 07-运维文档/ └── 07-运维文档/
``` ```
### 📌 重要说明 ### 📌 重要说明
**根目录的 `pom.xml` 为什么不在 backend 目录？** - **后端构建**：在 `backend` 目录执行 `mvn clean package -DskipTests -pl pangu-admin -am`，生成 `pangu-admin/target/pangu-admin.jar`。
- **前端构建**：在 `frontend` 目录执行 `npm run build:prod`，产出 `dist/`。
这是 Maven 多模块项目的标准结构： - 详细说明请查看: [backend/README.md](backend/README.md)
- 根 `pom.xml` 是**父项目配置**，管理所有子模块
- Maven 构建**必须从根目录**执行: `mvn clean package`
- 不要移动到 backend 目录，否则构建会失败
详细说明请查看: [backend/README.md](backend/README.md)
--- ---
@ -81,7 +73,7 @@ mvn spring-boot:run
```bash ```bash
# 进入前端目录 # 进入前端目录
cd frontend/frontend cd frontend
# 安装依赖 # 安装依赖
npm install npm install
@ -90,7 +82,7 @@ npm install
npm run dev npm run dev
``` ```
**访问地址**: `http://localhost:80` **访问地址**: 以 vite 配置为准（如 `http://localhost:80`）
**默认账号**: admin / admin123 **默认账号**: admin / admin123
@ -102,13 +94,12 @@ npm run dev
| 技术 | 说明 | 版本 | | 技术 | 说明 | 版本 |
|------|------|------| |------|------|------|
| Spring Boot | 基础框架 | 2.7.18 | | Spring Boot | 基础框架 | 3.5.x |
| Spring Security | 安全框架 | 5.7.x | | Sa-Token | 认证与权限 | 1.44.x |
| MyBatis-Plus | ORM框架 | 3.5.x | | MyBatis-Plus | ORM框架 | 3.5.x |
| MySQL | 数据库 | 8.0.x | | MySQL | 数据库 | 8.0+ |
| Redis | 缓存 | 6.0.x | | Redis / Redisson | 缓存 | 6.0+ |
| JWT | 认证 | 0.9.1 | | RuoYi-Vue-Plus | 基础框架 | 5.5.x |
| Druid | 连接池 | 1.2.x |
### 前端技术 ### 前端技术
@ -140,7 +131,7 @@ npm run dev
- 用户认证 (手机号+密码/验证码/微信) - 用户认证 (手机号+密码/验证码/微信)
- 权限管理 (超级管理员/分公司用户/学校用户) - 权限管理 (超级管理员/分公司用户/学校用户)
- 数据权限 (按区域/学校隔离) - 数据权限 (按区域/学校隔离)
- 系统监控 (在线用户、日志、缓存) - 系统监控 (在线用户、登录/操作日志、**服务监控**（CPU/内存/JVM/磁盘）、缓存监控)
--- ---
@ -237,8 +228,8 @@ java -jar target/pangu-admin.jar
### 前端部署 ### 前端部署
```bash ```bash
cd frontend/frontend cd frontend
npm run build npm run build:prod
# 将 dist/ 目录部署到 Nginx # 将 dist/ 目录部署到 Nginx
``` ```
@ -274,4 +265,4 @@ npm run build
--- ---
*最后更新: 2026-02-02* *最后更新: 2026-02-05*

5
docs/01-需求文档/需求规格说明书_v1.0.md
View File

@ -8,7 +8,7 @@
| **项目名称** | 盘古用户平台（Pangu User Platform） | | **项目名称** | 盘古用户平台（Pangu User Platform） |
| **编写团队** | pangu | | **编写团队** | pangu |
| **创建日期** | 2026-01-31 | | **创建日期** | 2026-01-31 |
| **审核状态** | 待审核 | | **审核状态** | 已审核 |
| **原型链接** | https://modao.cc/proto/atlwMul8t9pi6yxQ42W7up/sharing | | **原型链接** | https://modao.cc/proto/atlwMul8t9pi6yxQ42W7up/sharing |
--- ---
@ -19,6 +19,7 @@
| ---- | ---------- | ----- | ---- | | ---- | ---------- | ----- | ---- |
| V1.0 | 2026-01-31 | pangu | 初稿 | | V1.0 | 2026-01-31 | pangu | 初稿 |
| V1.1 | 2026-02-03 | pangu | 更新会员多教育身份模型、微信扫码登录流程 | | V1.1 | 2026-02-03 | pangu | 更新会员多教育身份模型、微信扫码登录流程 |
| V1.2 | 2026-02-05 | pangu | 补充验收实现状态与系统监控（服务监控）说明 |
--- ---
@ -957,6 +958,8 @@
| 学生管理 | 批量导入功能正常，数据校验完整 | | 学生管理 | 批量导入功能正常，数据校验完整 |
| 应用管理 | 接口授权可控制API访问权限 | | 应用管理 | 接口授权可控制API访问权限 |
| 基础数据 | 年级、班级、学科、区域CRUD正常 | | 基础数据 | 年级、班级、学科、区域CRUD正常 |
| 系统设置 | 用户、角色、菜单、部门、字典、参数 |
| 系统监控 | 在线用户、登录/操作日志、服务监控（CPU/内存/JVM/磁盘）、缓存监控 |
| 权限控制 | 三种角色权限划分符合需求 | | 权限控制 | 三种角色权限划分符合需求 |
### 10.2 性能验收标准 ### 10.2 性能验收标准

38
docs/02-系统设计/系统设计文档_v1.0.md
View File

@ -61,33 +61,41 @@
| | Element Plus | 2.x | UI组件库 | | | Element Plus | 2.x | UI组件库 |
| | Axios | 1.x | HTTP客户端 | | | Axios | 1.x | HTTP客户端 |
| | Pinia | 2.x | 状态管理 | | | Pinia | 2.x | 状态管理 |
| **后端** | Spring Boot | 3.3.x | 应用框架（LTS版本） | | **后端** | Spring Boot | 3.5.x | 应用框架 |
| | Spring Security | 6.x | 安全框架 | | | Sa-Token | 1.44.x | 认证与权限 |
| | MyBatis Plus | 3.5.x | ORM框架 | | | MyBatis Plus | 3.5.x | ORM框架 |
| | JWT | 0.12.x | Token认证 |
| | Hutool | 5.x | 工具库 | | | Hutool | 5.x | 工具库 |
| | JDK | 17+ | 运行环境（LTS） | | | JDK | 17+ | 运行环境（LTS） |
| **数据库** | MySQL | 8.0 | 主数据库 | | **数据库** | MySQL | 8.0 | 主数据库 |
| | Redis | 7.x | 缓存 | | | Redis | 7.x | 缓存 |
| **中间件** | Nginx | 1.20+ | 反向代理 | | **中间件** | Nginx | 1.20+ | 反向代理 |
| | MinIO | - | 文件存储（可选）| | | MinIO | - | 文件存储（可选）|
| **基础框架** | RuoYi-Vue | 3.8.x | 快速开发框架 | | **基础框架** | RuoYi-Vue-Plus | 5.5.x | 多租户快速开发框架（Dromara） |
### 1.3 模块划分 ### 1.3 模块划分
``` ```
pangu-user-platform/ pangu-user-platform/
├── pangu-admin/ # 后台管理模块 ├── backend/
├── pangu-api/ # 移动端API模块 │ ├── pangu-admin/ # 启动与认证入口（Spring Boot 主模块）
├── pangu-open/ # 开放平台API模块 │ ├── pangu-common/ # 公共模块
├── pangu-common/ # 公共模块 │ │ ├── pangu-common-core/ # 核心工具、常量、异常
│ ├── pangu-common-core/ # 核心工具 │ │ ├── pangu-common-redis/ # Redis/Redisson
│ ├── pangu-common-redis/ # Redis工具 │ │ ├── pangu-common-security/# 安全与加解密
│ └── pangu-common-security/# 安全工具 │ │ ├── pangu-common-satoken/ # Sa-Token 认证
├── pangu-framework/ # 框架核心 │ │ ├── pangu-common-mybatis/# MyBatis Plus 扩展
├── pangu-system/ # 系统模块（复用RuoYi） │ │ ├── pangu-common-web/ # Web 配置与工具
├── pangu-generator/ # 代码生成器 │ │ └── 其他 common 子模块 # 日志、OSS、短信、租户等
└── frontend/ # 前端工程 │ ├── pangu-modules/
│ │ ├── pangu-system/ # 系统模块（用户、角色、菜单、部门、字典、监控等）
│ │ ├── pangu-business/ # 业务模块（学校、会员、学生、应用、基础数据、H5、开放API）
│ │ ├── pangu-generator/ # 代码生成器
│ │ ├── pangu-job/ # 定时任务（SnailJob）
│ │ ├── pangu-demo/ # 示例模块
│ │ └── pangu-workflow/ # 工作流（可选）
│ ├── pangu-extend/ # 扩展（Monitor Admin、SnailJob Server 等）
│ └── pom.xml # 后端父 POM（RuoYi-Vue-Plus 5.5.x）
└── frontend/ # 管理后台前端（Vue 3 + Element Plus + Vite）
``` ```
--- ---