feature/refactor-project-structure #20

moyin · 2025-12-24T18:07:21+08:00

moyin commented

2025-12-24 18:07:21 +08:00

项目架构重构 - 合并请求

概述

本次合并请求包含了对整个项目架构的重大重构，旨在提高代码的可维护性、模块化程度和开发效率。

分支信息

源分支: feature/refactor-project-structure
目标分支: main (或你的主分支)
提交数量: 4个提交

主要变更

1. 文档结构重组 📚

重新组织docs目录结构，按功能模块分类
新增目录:
- docs/deployment/ - 部署相关文档
- docs/development/ - 开发相关文档
更新API文档结构
添加客户端README文档
移除过时的文档文件

2. 业务模块架构重构 🏗️

新增模块:

src/business/auth/ - 认证模块
- 登录控制器和服务
- 认证相关DTO
src/business/security/ - 安全模块
- 限流装饰器和守卫
- 超时拦截器
- 安全中间件
src/business/user-mgmt/ - 用户管理模块
- 用户状态管理
- 用户管理服务
- 用户状态枚举
src/business/shared/ - 共享模块
- 通用DTO
- 错误响应DTO

重构模块:

src/business/admin/ - 管理员模块
- 新增DTO目录和文件
- 新增Guards目录
- 添加测试文件结构
- 添加模块索引文件

3. 核心服务更新 ⚙️

更新用户实体和DTO结构
重构用户服务逻辑
更新登录核心服务
调整应用模块配置以适配新的业务模块结构
更新应用控制器和服务

4. 清理工作 🧹

删除旧的DTO文件（已迁移到对应业务模块）
删除旧的测试目录结构
删除过时的API目录
更新package.json配置
移除不再使用的文件

文件变更统计

新增文件

client/README.md
docs/CONTRIBUTORS.md
docs/deployment/DEPLOYMENT.md
docs/development/TESTING.md
src/business/auth/ 相关文件
src/business/security/ 相关文件
src/business/user-mgmt/ 相关文件
src/business/shared/ 相关文件
src/business/admin/dto/ 相关文件
src/business/admin/guards/ 相关文件

修改文件

README.md
docs/README.md
docs/api/api-documentation.md
package.json
src/app.controller.ts
src/app.module.ts
src/app.service.ts
src/business/admin/admin.controller.ts
src/business/admin/admin.module.ts
src/business/admin/admin.service.ts
src/core/db/users/ 相关文件
src/core/login_core/ 相关文件

删除文件

旧的根目录文档文件
src/dto/ 目录下的所有文件
src/business/login/ 目录
src/core/guards/ 目录
旧的测试目录结构

架构改进

模块化设计

按业务功能划分模块
每个模块都有独立的控制器、服务、DTO和守卫
添加了模块索引文件便于导入

安全性增强

新增安全模块处理限流、超时等安全功能
重构了管理员守卫逻辑
添加了内容类型和维护模式中间件

文档完善

重新组织文档结构
添加了部署和开发指南
完善了API文档

测试建议

在合并前建议进行以下测试：

功能测试
- 验证登录功能正常
- 验证管理员功能正常
- 验证用户管理功能正常
API测试
- 运行现有的API测试
- 验证所有端点正常响应
构建测试
- 确保项目能正常构建
- 确保没有TypeScript编译错误

兼容性说明

向后兼容: 所有现有API端点保持不变
数据库: 无需数据库迁移
配置: 可能需要更新部分配置文件

合并后操作

合并后建议执行：

安装依赖: npm install
运行测试: npm test
启动开发服务器: npm run start:dev
验证所有功能正常

联系信息

如有任何问题或需要澄清，请联系开发团队。

审核清单:

代码审查完成
测试通过
文档更新
无冲突
准备合并

# 项目架构重构 - 合并请求 ## 概述本次合并请求包含了对整个项目架构的重大重构，旨在提高代码的可维护性、模块化程度和开发效率。 ## 分支信息 - **源分支**: `feature/refactor-project-structure` - **目标分支**: `main` (或你的主分支) - **提交数量**: 4个提交 ## 主要变更 ### 1. 文档结构重组 📚 - **重新组织docs目录结构**，按功能模块分类 - **新增目录**: - `docs/deployment/` - 部署相关文档 - `docs/development/` - 开发相关文档 - **更新API文档结构** - **添加客户端README文档** - **移除过时的文档文件** ### 2. 业务模块架构重构 🏗️ #### 新增模块: - **`src/business/auth/`** - 认证模块 - 登录控制器和服务 - 认证相关DTO - **`src/business/security/`** - 安全模块 - 限流装饰器和守卫 - 超时拦截器 - 安全中间件 - **`src/business/user-mgmt/`** - 用户管理模块 - 用户状态管理 - 用户管理服务 - 用户状态枚举 - **`src/business/shared/`** - 共享模块 - 通用DTO - 错误响应DTO #### 重构模块: - **`src/business/admin/`** - 管理员模块 - 新增DTO目录和文件 - 新增Guards目录 - 添加测试文件结构 - 添加模块索引文件 ### 3. 核心服务更新 ⚙️ - **更新用户实体和DTO结构** - **重构用户服务逻辑** - **更新登录核心服务** - **调整应用模块配置**以适配新的业务模块结构 - **更新应用控制器和服务** ### 4. 清理工作 🧹 - **删除旧的DTO文件**（已迁移到对应业务模块） - **删除旧的测试目录结构** - **删除过时的API目录** - **更新package.json配置** - **移除不再使用的文件** ## 文件变更统计 ### 新增文件 - `client/README.md` - `docs/CONTRIBUTORS.md` - `docs/deployment/DEPLOYMENT.md` - `docs/development/TESTING.md` - `src/business/auth/` 相关文件 - `src/business/security/` 相关文件 - `src/business/user-mgmt/` 相关文件 - `src/business/shared/` 相关文件 - `src/business/admin/dto/` 相关文件 - `src/business/admin/guards/` 相关文件 ### 修改文件 - `README.md` - `docs/README.md` - `docs/api/api-documentation.md` - `package.json` - `src/app.controller.ts` - `src/app.module.ts` - `src/app.service.ts` - `src/business/admin/admin.controller.ts` - `src/business/admin/admin.module.ts` - `src/business/admin/admin.service.ts` - `src/core/db/users/` 相关文件 - `src/core/login_core/` 相关文件 ### 删除文件 - 旧的根目录文档文件 - `src/dto/` 目录下的所有文件 - `src/business/login/` 目录 - `src/core/guards/` 目录 - 旧的测试目录结构 ## 架构改进 ### 模块化设计 - 按业务功能划分模块 - 每个模块都有独立的控制器、服务、DTO和守卫 - 添加了模块索引文件便于导入 ### 安全性增强 - 新增安全模块处理限流、超时等安全功能 - 重构了管理员守卫逻辑 - 添加了内容类型和维护模式中间件 ### 文档完善 - 重新组织文档结构 - 添加了部署和开发指南 - 完善了API文档 ## 测试建议在合并前建议进行以下测试： 1. **功能测试** - 验证登录功能正常 - 验证管理员功能正常 - 验证用户管理功能正常 2. **API测试** - 运行现有的API测试 - 验证所有端点正常响应 3. **构建测试** - 确保项目能正常构建 - 确保没有TypeScript编译错误 ## 兼容性说明 - **向后兼容**: 所有现有API端点保持不变 - **数据库**: 无需数据库迁移 - **配置**: 可能需要更新部分配置文件 ## 合并后操作合并后建议执行： 1. 安装依赖: `npm install` 2. 运行测试: `npm test` 3. 启动开发服务器: `npm run start:dev` 4. 验证所有功能正常 ## 联系信息如有任何问题或需要澄清，请联系开发团队。 --- **审核清单**: - [ ] 代码审查完成 - [ ] 测试通过 - [ ] 文档更新 - [ ] 无冲突 - [ ] 准备合并

moyin added 5 commits 2025-12-24 18:07:22 +08:00

docs: 全面更新API接口文档 032c97a1fc

- 重构文档结构，按功能模块分类
- 新增应用状态接口 (GET /)
- 完善用户认证接口，新增4个邮箱验证相关接口
- 新增管理员后台接口，包含用户管理和日志管理
- 更新错误代码说明和数据验证规则
- 完善使用示例和注意事项
- 更新版本日志至v1.0.0

涵盖后端所有API接口，提供完整的开发参考文档

docs: 重构文档结构和组织 85d488a508

- 重新组织docs目录结构，按功能模块分类
- 新增deployment和development目录
- 更新API文档结构
- 添加客户端README文档
- 移除过时的文档文件

feat: 重构业务模块架构 47a738067a

- 新增auth模块处理认证逻辑
- 新增security模块处理安全相关功能
- 新增user-mgmt模块管理用户相关操作
- 新增shared模块存放共享组件
- 重构admin模块，添加DTO和Guards
- 为admin模块添加测试文件结构

refactor: 更新核心服务和应用配置 e6d8c28806

- 更新用户实体和DTO结构
- 重构用户服务逻辑
- 更新登录核心服务
- 调整应用模块配置以适配新的业务模块结构
- 更新应用控制器和服务

chore: 清理旧文件和更新项目配置 612755de63

- 删除旧的DTO文件（已迁移到对应业务模块）
- 删除旧的测试目录结构
- 删除过时的API目录
- 更新package.json配置
- 移除不再使用的文件

moyin merged commit 64230db651 into main

2025-12-24 18:07:33 +08:00

moyin deleted branch feature/refactor-project-structure

2025-12-24 18:07:33 +08:00

moyin referenced this issue from a commit

2025-12-24 18:07:33 +08:00

Merge pull request 'feature/refactor-project-structure' (#20) from feature/refactor-project-structure into main

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: datawhale/whale-town-end#20