From 22de3ced839c82038ad9c0e616201899fb62da51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BC=A0=E7=BF=94?= Date: Sun, 8 Mar 2026 22:01:55 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E6=B8=85=E5=8D=95=E5=88=B0=20v1.9=EF=BC=8C=E6=96=B0=E5=A2=9E?= =?UTF-8?q?=E6=8A=80=E6=9C=AF=E4=B8=93=E9=A2=98=E6=96=87=E6=A1=A3=E7=AB=A0?= =?UTF-8?q?=E8=8A=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/文档清单.md | 90 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 89 insertions(+), 1 deletion(-) diff --git a/docs/文档清单.md b/docs/文档清单.md index af0b85b..a0fa7af 100644 --- a/docs/文档清单.md +++ b/docs/文档清单.md @@ -1,7 +1,7 @@ # 健身房管理系统文档清单 > 文档编号: GYM-DOC-LIST-001 -> 版本：v1.8 +> 版本：v1.9 > 日期: 2026-03-08 > 作者: 张翔 > 状态: 完成 @@ -21,6 +21,8 @@ | v1.6 | 2026-03-08 | 张翔 | 完成文档架构优化，实现业务概要设计（B-HLD）、业务详细设计（B-LLD）、技术实现详细设计（T-ILD）三层架构 | | v1.7 | 2026-03-08 | 张翔 | 删除过时的模块 LLD 文档，内容已整合到 T-ILD 文档中 | | v1.8 | 2026-03-08 | 张翔 | 归档 HLD-技术架构设计文档，内容整合到 T-ILD 文档体系 | +| v1.9 | 2026-03-08 | 张翔 | 新增技术专题文档（数据库设计、API 设计、安全设计），统一文档日期和状态规范 | + --- @@ -292,6 +294,92 @@ --- + +--- + +## 五、技术专题文档 + +### 5.1 数据库设计文档 + +| 属性 | 值 | +|------|-----| +| 文档编号 | GYM-DB-DESIGN-001 | +| 文档名称 | 健身房管理系统数据库设计文档 | +| 文件路径 | [docs/design/technical/DB-数据库设计.md](file:///Users/zhangxiang/Codes/Novalon/gym-manage/docs/design/technical/DB-数据库设计.md) | +| 版本 | v1.0 | +| 日期 | 2026-03-08 | +| 作者 | 张翔 | +| 状态 | 正式发布 | + +**内容概要**: +- 数据库架构设计（多租户架构、分库分表策略） +- 核心表结构设计（会员域、预约域、订阅域） +- 索引设计优化 +- 数据迁移策略（Flyway 版本化管理） +- 性能优化（查询优化、连接池配置） +- 安全设计（数据加密、数据脱敏） + +**参考文档**: +- GYM-T-ILD-BASIC-001 +- GYM-T-ILD-SUBSCRIPTION-001 +- PostgreSQL 官方文档 + +### 5.2 API 接口设计规范 + +| 属性 | 值 | +|------|-----| +| 文档编号 | GYM-API-SPEC-001 | +| 文档名称 | 健身房管理系统 API 接口设计规范 | +| 文件路径 | [docs/design/technical/API-接口设计规范.md](file:///Users/zhangxiang/Codes/Novalon/gym-manage/docs/design/technical/API-接口设计规范.md) | +| 版本 | v1.0 | +| 日期 | 2026-03-08 | +| 作者 | 张翔 | +| 状态 | 正式发布 | + +**内容概要**: +- API 设计原则（RESTful 风格、版本控制、响应式 API 设计） +- API 响应格式（标准响应、列表响应、错误响应） +- API 接口分类（会员管理、预约管理、订阅管理） +- 错误处理（错误码规范、全局异常处理、参数验证） +- 安全设计（JWT 认证、RBAC 授权、限流） +- API 文档（OpenAPI 规范、Swagger UI） +- 性能优化（游标分页、字段过滤、缓存策略） + +**参考文档**: +- GYM-T-ILD-BASIC-001 +- GYM-T-ILD-SUBSCRIPTION-001 +- RESTful API 最佳实践 +- OpenAPI 3.0 规范 + +### 5.3 安全设计文档 + +| 属性 | 值 | +|------|-----| +| 文档编号 | GYM-SEC-DESIGN-001 | +| 文档名称 | 健身房管理系统安全设计文档 | +| 文件路径 | [docs/design/technical/SEC-安全设计.md](file:///Users/zhangxiang/Codes/Novalon/gym-manage/docs/design/technical/SEC-安全设计.md) | +| 版本 | v1.0 | +| 日期 | 2026-03-08 | +| 作者 | 张翔 | +| 状态 | 正式发布 | + +**内容概要**: +- 安全架构设计（安全分层、安全原则） +- 认证与授权（JWT Token 认证、RBAC 授权、数据权限隔离） +- 数据安全（数据加密、数据脱敏、数据备份） +- 网络安全（HTTPS 强制、CORS 配置、限流与防 DDOS） +- 输入验证与输出编码（输入验证、SQL 注入防护、XSS 防护） +- 安全审计（审计日志、日志存储） +- 安全监控（监控指标、告警规则） +- 合规性（GDPR 合规、等保 2.0 合规） + +**参考文档**: +- GYM-T-ILD-BASIC-001 +- GYM-T-ILD-SUBSCRIPTION-001 +- OWASP Top 10 安全规范 +- Spring Security 官方文档 +- GDPR 数据保护条例 + ## 六、高层设计文档（HLD） ### 6.1 技术架构 HLD（已归档）