fix:将系统名称从“芋道管理系统”变更为“AIOTAGRO管理系统

This commit is contained in:
2025-10-04 18:39:38 +08:00
parent 9b110e7296
commit 4ed9b88904
132 changed files with 481 additions and 17852 deletions

View File

@@ -0,0 +1,14 @@
# 后端开发文档(含开发计划)
## 1. 开发环境
- JDK 17、Maven/Gradle、MySQL、Redis、MQ
## 2. WBS 与计划(示例)
- 骨架搭建Auth/User/Config/Log— 8 人日
- 鉴权与网关集成 — 5 人日
- 数据库模型与迁移 — 5 人日
- 业务模块首版(工作流/报表/文件)— 10 人日
- 测试与优化 — 6 人日
## 3. 规范
- 领域分层、统一异常、统一响应、审计日志、灰度与限流。

View File

@@ -0,0 +1,22 @@
# 后端架构文档
## 技术栈与理由
- Spring Boot/Cloud成熟生态、易扩展
- MySQL事务与一致性保障
- Redis缓存与分布式特性
- MQ削峰填谷、解耦
## 服务划分
- Auth、User、RBAC、Workflow、Payment、Report、File 等
## 时序示意(登录鉴权)
```mermaid
sequenceDiagram
participant C as Client
participant G as API Gateway
participant A as Auth Service
C->>G: /auth/login
G->>A: 认证请求
A-->>G: 令牌
G-->>C: 令牌返回
```

View File

@@ -0,0 +1,12 @@
# 后端管理开发文档(含开发计划)
## 内容
- 配置管理、日志中心、链路追踪、任务调度、文件服务、消息队列等。
## WBS
- 配置中心接入 — 3 人日
- 日志中心接入 — 3 人日
- 链路追踪接入 — 3 人日
- 任务调度与监控 — 3 人日
- 文件/对象存储接入 — 3 人日
- MQ 与异步化 — 3 人日

View File

@@ -0,0 +1,10 @@
# 后端管理需求文档
## 1. 目标
- 统一后端的配置、运维与治理能力(应用、日志、监控、告警)。
## 2. 功能范围
- 应用管理、配置中心、日志中心、链路追踪、任务调度、文件服务、消息队列、权限鉴权等。
## 3. 非功能
- 高可用、容灾、审计、访问控制、合规。

8
docs/安全文档.md Normal file
View File

@@ -0,0 +1,8 @@
# 安全文档
## 安全原则
- 最小权限、分层防御、输入输出校验、密钥管理、审计与合规
## 实施要点
- 鉴权OAuth2/OIDC、RBAC、CSRF/XSS/SQL注入防护
- 敏感信息加密存储TLS 加密传输

View File

@@ -0,0 +1,20 @@
# 官网需求文档
## 1. 目标
- 提供品牌展示与转化入口SEO 友好,支持活动运营。
## 2. 核心功能
- 首页、产品/方案页、博客/资讯、联系我们
- 表单线索收集,第三方统计(如埋点/热力图)
## 3. 用户流程
```mermaid
flowchart LR
V[访客] --> P[浏览内容]
P --> L[提交线索]
L --> S[后端存储]
S --> O[后台跟进]
```
## 4. 非功能
- SEO、性能优化、CDN加速、国际化可选

View File

@@ -0,0 +1,11 @@
# 小程序 app 开发文档(含开发计划)
## 技术栈
- 原生/UniApp + 后端 REST
## WBS
- 登录态与会话管理 — 3 人日
- 个人中心与设置页 — 2 人日
- 业务流程与审批 — 5 人日
- 通知与消息 — 2 人日
- 测试与优化 — 3 人日

View File

@@ -0,0 +1,11 @@
# 小程序 app 接口设计文档
## 约定
- BaseURL: /api/mp
- 认证:小程序登录态换取后端会话(或 JWT
## 接口(示例)
- 登录POST /mp/auth/login { code }
- 个人信息GET /mp/profile
- 业务列表GET /mp/biz/list?page&size
- 提交审批POST /mp/bpm/submit { formData }

View File

@@ -0,0 +1,10 @@
# 小程序 app 需求文档
## 1. 目标
- 为业务用户提供便捷使用入口,支持审批、报表与个人中心等功能。
## 2. 功能范围
- 登录注册、个人中心、业务流程、消息通知、数据展示。
## 3. 非功能
- 性能与体验优化、离线与弱网策略、数据安全与隐私保护。

View File

@@ -0,0 +1,13 @@
# 小程序架构文档
## 技术选型
- 原生小程序或 UniApp + 后端 REST API
## 架构示意
```mermaid
flowchart LR
MP[MiniProgram] --> API
API --> DB[(MySQL)]
API --> Redis[(Cache)]
API --> MQ{{Async}}
```

View File

@@ -0,0 +1,52 @@
# 数据库设计文档
## 1. ER 图(核心)
```mermaid
erDiagram
TENANT ||--o{ USER : has
USER }o--o{ USER_ROLE : link
ROLE ||--o{ USER_ROLE : has
ROLE ||--o{ ROLE_MENU : grant
MENU ||--o{ ROLE_MENU : has
DEPT ||--o{ USER : belong
```
## 2. 表定义(示例)
### tenant
| 字段 | 类型 | 说明 |
|---|---|---|
| id | bigint | 主键 |
| name | varchar(64) | 租户名称 |
| status | tinyint | 状态 |
| created_at | datetime | 创建时间 |
### user
| 字段 | 类型 | 说明 |
|---|---|---|
| id | bigint | 主键 |
| username | varchar(64) | 用户名 |
| password_hash | varchar(255) | 密码哈希 |
| dept_id | bigint | 部门ID |
| tenant_id | bigint | 租户ID |
| status | tinyint | 状态 |
| created_at | datetime | 创建时间 |
### role
| 字段 | 类型 | 说明 |
|---|---|---|
| id | bigint | 主键 |
| code | varchar(64) | 角色编码 |
| name | varchar(64) | 角色名称 |
| tenant_id | bigint | 租户ID |
### menu
| 字段 | 类型 | 说明 |
|---|---|---|
| id | bigint | 主键 |
| name | varchar(64) | 菜单名称 |
| path | varchar(128) | 路由路径 |
| perms | varchar(128) | 权限标识 |
| parent_id | bigint | 父节点 |
其余表按需扩展dept、dict、log、config、file、task 等)

View File

@@ -0,0 +1,41 @@
# 整个项目的架构文档
## 1. 技术选型
- 前端Vue3 + Vite + Element Plus移动端小程序原生或 UniApp
- 后端Spring Boot/Cloud鉴权OAuth2/OIDC数据库MySQL缓存Redis消息队列Kafka/Redis Stream
## 2. 总体架构图
```mermaid
flowchart LR
Web[Website] --> CDN --> Nginx --> FE[Admin/Front]
MP[MiniProgram] --> API
FE --> API[API Gateway]
API --> S1[Auth Service]
API --> S2[Biz Service]
API --> S3[File Service]
S1 --> DB[(MySQL)]
S2 --> DB
S2 --> Cache[(Redis)]
S2 --> MQ{{MQ}}
S3 --> OSS[(Object Storage)]
```
## 3. 部署视图
```mermaid
flowchart TB
subgraph Edge
CDN --> Nginx
end
subgraph App
FE[Node Static] --> API[Spring Boot/Cloud]
end
API --> MySQL
API --> Redis
API --> MQ[(Kafka/Redis Stream)]
API --> OSS[(S3/MinIO)]
```
## 4. 风险与策略
- 性能瓶颈:缓存、异步化、读写分离、限流与降级
- 单点故障:多副本、健康检查、熔断与重试
- 安全漏洞:统一鉴权、输入校验、审计日志、密钥安全

View File

@@ -0,0 +1,41 @@
# 整个项目需求文档
## 1. 背景与目标
- 背景:统一构建“官网 + 管理后台 + 小程序 + 后端服务”的一体化平台。
- 目标:实现多端一致的用户体验、统一的权限与数据治理、可持续交付。
## 2. 角色与用户
- 访客(官网)
- 管理员(管理后台)
- 业务用户(小程序/网页端)
- 运维与安全管理员
## 3. 核心功能范围
- 官网内容展示与营销转化
- 管理后台:用户/角色/菜单、租户、配置、日志、报表等
- 小程序:会员与业务流程
- 后端:统一 API、鉴权、数据存储与基础设施
## 4. 用户流程(示意)
```mermaid
flowchart LR
A[访客浏览官网] --> B[注册/登录]
B --> C[成为业务用户]
C --> D[使用小程序或前端业务]
D --> E[数据写入后端]
E --> F[管理员在后台运营]
```
## 5. 非功能需求
- 性能:关键页面首屏 < 2sAPI P95 < 200ms
- 安全OAuth2/OIDCRBAC审计与合规
- 可用性99.9% SLA灰度与回滚
- 可运维日志指标链路追踪告警
## 6. 里程碑
- M1最小可用版本官网基础后台基础后端骨架
- M2小程序首版核心业务上线
- M3性能与稳定性优化自动化测试完善
## 7. 验收标准
- 需求可追踪用例覆盖率缺陷关闭率达标业务流程可用且指标稳定

13
docs/测试文档.md Normal file
View File

@@ -0,0 +1,13 @@
# 测试文档
## 测试范围
- 单元测试、接口测试、端到端测试、性能测试、安全测试。
## 测试流程
```mermaid
flowchart LR
Plan --> Design --> Implement --> Execute --> Report --> Fix --> Regress
```
## 指标
- 覆盖率、缺陷率、性能指标、可靠性指标。

View File

@@ -0,0 +1,10 @@
# 用户手册文档
## 面向对象
- 管理员、业务用户、访客
## 基本使用
- 登录系统、浏览与检索、常见操作(创建/编辑/审批)
## 常见问题
- 无法登录、无权限、数据未刷新、浏览器兼容性

View File

@@ -0,0 +1,12 @@
# 管理后台开发文档(含开发计划)
## 技术栈
- Vue3 + Vite + Element Plus + Pinia + Vue Router
## WBS
- 登录与权限路由守卫 — 3 人日
- 用户/角色/菜单模块 — 6 人日
- 日志与审计 — 3 人日
- 主题与国际化 — 2 人日
- 组件封装(表单、表格)— 3 人日
- 测试与优化 — 3 人日

View File

@@ -0,0 +1,32 @@
# 管理后台接口设计文档
## 约定
- BaseURL: /api
- 认证Bearer TokenAuthorization: Bearer <token>
- 响应规范:{ code, msg, data }
## 接口一览(示例)
### 登录
- 方法POST /auth/login
- 请求:{ username, password }
- 响应:{ token, expireAt }
### 用户列表
- 方法GET /system/users
- 查询page, size, keyword
- 响应:{ total, list: [ {id, username, deptName, status} ] }
### 创建用户
- 方法POST /system/users
- 请求:{ username, password, deptId, roleIds, tenantId }
- 响应:{ id }
### 角色列表
- 方法GET /system/roles
### 菜单树
- 方法GET /system/menus/tree
### 错误码
- 400 参数错误401 未认证403 无权限404 不存在500 服务器异常

View File

@@ -0,0 +1,16 @@
# 管理后台架构文档
## 技术选型与理由
- Vue3 + Vite性能与开发体验
- Element Plus中后台组件丰富
- Pinia状态管理简单稳定
## 前端模块边界
- 路由与权限、组件库、表单与表格、国际化、主题
## 页面流程(示例:登录后跳转)
```mermaid
flowchart LR
Login --> AuthAPI --> Token
Token --> RouterGuard --> Home
```

View File

@@ -0,0 +1,12 @@
# 管理后台需求文档
## 1. 目标
- 提供完整的运营与管理能力:用户、角色、菜单、租户、配置、日志、报表等。
## 2. 核心模块
- 系统功能:用户/角色/菜单/部门/租户/词典/配置
- 审计与日志:登录、操作、错误码
- 业务扩展:工作流、支付、报表、文件、消息等
## 3. 关键页面
- 登录、首页、用户管理、角色管理、菜单管理、租户管理、日志中心等。

12
docs/运维文档.md Normal file
View File

@@ -0,0 +1,12 @@
# 运维文档
## 监控与告警
- 指标CPU/内存/磁盘、QPS/延迟、错误率
- 日志:访问日志、异常日志、审计日志
- 链路Trace + Span 分析
## 日常操作
- 发布与回滚、数据库变更流程、配置变更流程
## 故障处理
- 预案:限流、降级、熔断、重试

19
docs/部署文档.md Normal file
View File

@@ -0,0 +1,19 @@
# 部署文档
## 环境
- 服务器CentOS 64位
- 前端:静态资源由 Nginx/HTTP 服务托管
- 后端Spring Boot/Cloud + MySQL + Redis + MQ
## 前端部署
1. 构建:`pnpm build:prod`
2.`dist/` 上传至服务器Nginx 静态目录)
3. Nginx 配置:启用 gzip、缓存策略、路由回退到 index.html
## 后端部署(示意)
1. 打包后端服务jar/容器镜像)
2. 配置 MySQL/Redis/MQ 连接
3. 以 systemd 或容器编排方式运行,启用健康检查与日志采集
## 灰度与回滚
- 蓝绿或金丝雀发布;版本回滚策略与数据迁移回退方案。