feat: 初始化项目脚手架
This commit is contained in:
UGREEN USER
530
doc/后端项目分析报告.md
Normal file
530
doc/后端项目分析报告.md
Normal file
@@ -0,0 +1,530 @@
|
||||
# GameGroup 项目分析报告
|
||||
|
||||
**分析日期**: 2025-12-19
|
||||
**项目状态**: 第四阶段完成，第五阶段待进行
|
||||
**分析范围**: 代码架构、设计一致性、逻辑漏洞、数据完整性
|
||||
|
||||
---
|
||||
|
||||
## 📊 项目概览
|
||||
|
||||
### 基本信息
|
||||
- **项目名称**: GameGroup 后端系统
|
||||
- **技术栈**: NestJS 11 + TypeScript + MySQL 8.0 + Redis + TypeORM
|
||||
- **代码量**: ~26,500 行
|
||||
- **模块数量**: 12 个核心业务模块
|
||||
- **实体数量**: 15 个数据库实体
|
||||
- **API 接口**: 70+ 个 RESTful 接口
|
||||
- **测试覆盖**: 169 个测试（142 个通过，27 个失败）
|
||||
- **测试覆盖率**: ~84%
|
||||
|
||||
### 项目架构
|
||||
```
|
||||
src/
|
||||
├── common/ # 公共模块（装饰器、守卫、拦截器、管道、工具）
|
||||
├── config/ # 配置文件
|
||||
├── entities/ # 数据库实体
|
||||
└── modules/ # 业务模块（12个）
|
||||
├── auth/ # 认证模块
|
||||
├── users/ # 用户模块
|
||||
├── groups/ # 小组模块
|
||||
├── games/ # 游戏库模块
|
||||
├── appointments/# 预约模块
|
||||
├── ledgers/ # 账目模块
|
||||
├── schedules/ # 排班模块
|
||||
├── blacklist/ # 黑名单模块
|
||||
├── honors/ # 荣誉墙模块
|
||||
├── assets/ # 资产模块
|
||||
├── points/ # 积分模块
|
||||
└── bets/ # 竞猜模块
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ✅ 项目优点
|
||||
|
||||
### 1. 架构设计
|
||||
- ✅ **模块化设计**: 清晰的模块划分，职责明确
|
||||
- ✅ **分层架构**: Controller -> Service -> Repository，层次分明
|
||||
- ✅ **依赖注入**: 使用 NestJS 的 DI 容器，解耦良好
|
||||
- ✅ **配置管理**: 环境变量配置完善，支持多环境
|
||||
|
||||
### 2. 代码质量
|
||||
- ✅ **TypeScript**: 类型安全，减少运行时错误
|
||||
- ✅ **统一响应格式**: 标准化的 API 响应结构
|
||||
- ✅ **全局异常处理**: 统一的错误处理机制
|
||||
- ✅ **日志记录**: 完善的请求/响应日志
|
||||
|
||||
### 3. 安全性
|
||||
- ✅ **JWT 认证**: 基于 Token 的身份验证
|
||||
- ✅ **密码加密**: bcrypt 加密存储
|
||||
- ✅ **权限控制**: RBAC 角色权限管理
|
||||
- ✅ **参数验证**: class-validator 请求数据验证
|
||||
|
||||
### 4. 性能优化
|
||||
- ✅ **HTTP 压缩**: compression 中间件
|
||||
- ✅ **缓存机制**: 内存缓存服务
|
||||
- ✅ **数据库索引**: 关键字段索引优化
|
||||
- ✅ **连接池**: 数据库连接池配置
|
||||
|
||||
### 5. 开发体验
|
||||
- ✅ **Swagger 文档**: 自动生成 API 文档
|
||||
- ✅ **热重载**: 开发环境自动重启
|
||||
- ✅ **代码规范**: ESLint + Prettier
|
||||
- ✅ **单元测试**: Jest 测试框架
|
||||
|
||||
---
|
||||
|
||||
## 🔴 严重问题（必须修复）
|
||||
|
||||
### 1. 财务操作缺少事务管理 ⚠️
|
||||
|
||||
**严重程度**: 🔴 严重
|
||||
**影响范围**: 积分系统、竞猜系统、资产系统
|
||||
|
||||
**问题描述**:
|
||||
- [bets.service.ts:184-207](../src/modules/bets/bets.service.ts#L184-L207): 竞猜结算没有事务保护
|
||||
- [points.service.ts:32-73](../src/modules/points/points.service.ts#L32-L73): 积分操作没有事务保护
|
||||
- [assets.service.ts:215-226](../src/modules/assets/assets.service.ts#L215-L226): 资产借用没有事务保护
|
||||
|
||||
**风险**:
|
||||
- 如果操作过程中断，可能导致财务数据不一致
|
||||
- 部分用户收到积分，部分没有
|
||||
- 积分池总和不匹配
|
||||
|
||||
**修复方案**:
|
||||
```typescript
|
||||
async settleBet(appointmentId: string, winningOption: string) {
|
||||
await this.dataSource.transaction(async (manager) => {
|
||||
// 所有数据库操作使用 manager
|
||||
const bets = await manager.find(Bet, { ... });
|
||||
for (const bet of bets) {
|
||||
// 积分分配逻辑
|
||||
await manager.save(Point, { ... });
|
||||
await manager.save(Bet, { ... });
|
||||
}
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
**修复优先级**: 🔴 最高
|
||||
|
||||
---
|
||||
|
||||
### 2. 并发竞态条件 ⚠️
|
||||
|
||||
**严重程度**: 🔴 严重
|
||||
**影响范围**: 小组管理、预约管理、资产管理
|
||||
|
||||
**问题列表**:
|
||||
|
||||
#### 2.1 小组成员数竞态
|
||||
**位置**: [groups.service.ts:165-172](../src/modules/groups/groups.service.ts#L165-L172)
|
||||
|
||||
```typescript
|
||||
// ❌ 问题代码
|
||||
await this.groupMemberRepository.save(member);
|
||||
group.currentMembers += 1;
|
||||
await this.groupRepository.save(group);
|
||||
```
|
||||
|
||||
**风险**: 多个用户同时加入可能超过 `maxMembers` 限制
|
||||
|
||||
#### 2.2 预约人数竞态
|
||||
**位置**: [appointments.service.ts](../src/modules/appointments/appointments.service.ts)
|
||||
|
||||
**风险**: 预约人数可能超过 `maxParticipants`
|
||||
|
||||
#### 2.3 资产借用竞态
|
||||
**位置**: [assets.service.ts:215-217](../src/modules/assets/assets.service.ts#L215-L217)
|
||||
|
||||
```typescript
|
||||
// ❌ 问题代码
|
||||
asset.status = AssetStatus.IN_USE;
|
||||
await this.assetRepository.save(asset);
|
||||
```
|
||||
|
||||
**风险**: 多个用户可能同时借用同一资产
|
||||
|
||||
**修复方案**:
|
||||
```typescript
|
||||
// ✅ 原子更新
|
||||
await this.groupRepository
|
||||
.createQueryBuilder()
|
||||
.update(Group)
|
||||
.set({ currentMembers: () => 'currentMembers + 1' })
|
||||
.where('id = :id AND currentMembers < maxMembers', { id: groupId })
|
||||
.execute();
|
||||
|
||||
// 或者使用悲观锁
|
||||
const group = await this.groupRepository
|
||||
.createQueryBuilder('group')
|
||||
.setLock('pessimistic_write')
|
||||
.where('group.id = :id', { id: groupId })
|
||||
.getOne();
|
||||
```
|
||||
|
||||
**修复优先级**: 🔴 最高
|
||||
|
||||
---
|
||||
|
||||
### 3. 积分计算精度损失 ⚠️
|
||||
|
||||
**严重程度**: 🟡 中等
|
||||
**影响范围**: 竞猜系统
|
||||
|
||||
**问题位置**: [bets.service.ts:187](../src/modules/bets/bets.service.ts#L187)
|
||||
|
||||
```typescript
|
||||
// ❌ 问题代码
|
||||
const winAmount = Math.floor((bet.amount / winningTotal) * totalPool);
|
||||
```
|
||||
|
||||
**问题**:
|
||||
- 使用 `Math.floor()` 会导致积分池积分无法完全分配
|
||||
- 示例：总池 100 积分，3 个赢家按 33:33:34 分配，实际可能只分配出 99 积分
|
||||
- 剩余积分丢失
|
||||
|
||||
**修复方案**:
|
||||
```typescript
|
||||
// ✅ 最后一个赢家获得剩余积分
|
||||
let distributedAmount = 0;
|
||||
const winningBets = bets.filter(b => b.betOption === winningOption);
|
||||
|
||||
for (let i = 0; i < winningBets.length; i++) {
|
||||
const bet = winningBets[i];
|
||||
let winAmount: number;
|
||||
|
||||
if (i === winningBets.length - 1) {
|
||||
// 最后一个赢家获得剩余所有积分
|
||||
winAmount = totalPool - distributedAmount;
|
||||
} else {
|
||||
winAmount = Math.floor((bet.amount / winningTotal) * totalPool);
|
||||
distributedAmount += winAmount;
|
||||
}
|
||||
|
||||
bet.winAmount = winAmount;
|
||||
}
|
||||
```
|
||||
|
||||
**修复优先级**: 🔴 高
|
||||
|
||||
---
|
||||
|
||||
## 🟡 中等问题（建议修复）
|
||||
|
||||
### 4. 权限检查模型不一致
|
||||
|
||||
**严重程度**: 🟡 中等
|
||||
**影响范围**: 黑名单模块、全局权限控制
|
||||
|
||||
**问题位置**: [blacklist.service.ts:105](../src/modules/blacklist/blacklist.service.ts#L105)
|
||||
|
||||
```typescript
|
||||
// ❌ 不一致的权限检查
|
||||
if (!user.isMember) {
|
||||
throw new ForbiddenException('需要会员权限');
|
||||
}
|
||||
```
|
||||
|
||||
**问题**:
|
||||
- 黑名单审核使用 `user.isMember` 判断权限
|
||||
- 其他模块使用 `GroupMemberRole.ADMIN` 或 `GroupMemberRole.OWNER`
|
||||
- 权限模型混乱
|
||||
|
||||
**修复方案**:
|
||||
1. 统一使用基于角色的权限控制（RBAC）
|
||||
2. 定义清晰的权限层级
|
||||
3. 创建统一的权限检查装饰器
|
||||
|
||||
**修复优先级**: 🟡 中
|
||||
|
||||
---
|
||||
|
||||
### 5. 级联删除策略不明确
|
||||
|
||||
**严重程度**: 🟡 中等
|
||||
**影响范围**: 所有实体关系
|
||||
|
||||
**问题位置**: [point.entity.ts:20,27](../src/entities/point.entity.ts#L20)
|
||||
|
||||
```typescript
|
||||
// user 和 group 都设置了级联删除
|
||||
@ManyToOne(() => User, (user) => user.points, { onDelete: 'CASCADE' })
|
||||
@ManyToOne(() => Group, { onDelete: 'CASCADE' })
|
||||
```
|
||||
|
||||
**问题**:
|
||||
- 删除用户时自动删除积分记录
|
||||
- 删除小组时也会删除积分记录
|
||||
- 数据清理策略不明确
|
||||
|
||||
**修复方案**:
|
||||
1. 明确级联删除策略
|
||||
2. 考虑使用软删除替代硬删除
|
||||
3. 添加数据归档机制
|
||||
|
||||
**修复优先级**: 🟡 中
|
||||
|
||||
---
|
||||
|
||||
### 6. 缓存一致性问题
|
||||
|
||||
**严重程度**: 🟡 中等
|
||||
**影响范围**: 所有使用缓存的服务
|
||||
|
||||
**问题位置**: [groups.service.ts:298-299](../src/modules/groups/groups.service.ts#L298-L299)
|
||||
|
||||
**问题**:
|
||||
- 只在更新时清除缓存
|
||||
- 删除操作未清除缓存
|
||||
- 可能返回已删除数据的缓存
|
||||
|
||||
**修复方案**:
|
||||
1. 在所有删除操作中添加缓存清除
|
||||
2. 实现统一的缓存管理策略
|
||||
3. 使用缓存键的版本控制
|
||||
|
||||
**修复优先级**: 🟡 中
|
||||
|
||||
---
|
||||
|
||||
### 7. 手动维护计数字段的风险
|
||||
|
||||
**严重程度**: 🟡 中等
|
||||
**影响范围**: 预约模块、小组模块
|
||||
|
||||
**问题位置**: [appointment.entity.ts:60-61](../src/entities/appointment.entity.ts#L60-L61)
|
||||
|
||||
```typescript
|
||||
@Column({ default: 0, comment: '当前参与人数' })
|
||||
currentParticipants: number;
|
||||
```
|
||||
|
||||
**问题**:
|
||||
- `currentParticipants` 字段手动维护
|
||||
- 如果应用崩溃，可能与实际值不一致
|
||||
- 需要定期校验
|
||||
|
||||
**修复方案**:
|
||||
1. 使用数据库查询实时计算（性能优化可用缓存）
|
||||
2. 添加定期校验任务修正数据
|
||||
3. 使用数据库触发器自动维护
|
||||
|
||||
**修复优先级**: 🟡 中
|
||||
|
||||
---
|
||||
|
||||
## 🟢 低优先级问题（可选修复）
|
||||
|
||||
### 8. 缺少实体级验证装饰器
|
||||
|
||||
**严重程度**: 🟢 低
|
||||
**影响范围**: 所有实体
|
||||
|
||||
**问题**:
|
||||
- 实体没有使用 `class-validator` 装饰器
|
||||
- 仅依赖数据库约束
|
||||
- 数据验证不够早期
|
||||
|
||||
**修复方案**:
|
||||
```typescript
|
||||
@Entity('users')
|
||||
export class User {
|
||||
@Column()
|
||||
@IsNotEmpty()
|
||||
@MinLength(3)
|
||||
username: string;
|
||||
|
||||
@Column()
|
||||
@IsEmail()
|
||||
email: string;
|
||||
}
|
||||
```
|
||||
|
||||
**修复优先级**: 🟢 低
|
||||
|
||||
---
|
||||
|
||||
### 9. 错误消息不够具体
|
||||
|
||||
**严重程度**: 🟢 低
|
||||
**影响范围**: 所有服务
|
||||
|
||||
**问题**:
|
||||
- 很多地方抛出通用错误消息
|
||||
- 缺少具体上下文
|
||||
- 调试困难
|
||||
|
||||
**修复方案**:
|
||||
1. 提供更详细的错误信息
|
||||
2. 添加错误追踪 ID
|
||||
3. 记录完整的错误堆栈
|
||||
|
||||
**修复优先级**: 🟢 低
|
||||
|
||||
---
|
||||
|
||||
## 📋 修复建议实施计划
|
||||
|
||||
### 阶段一：紧急修复（1-2 天）
|
||||
|
||||
**优先级**: 🔴 最高
|
||||
**时间**: 2-3 小时
|
||||
|
||||
1. **添加事务管理**（1 小时）
|
||||
- bets.service.ts - 竞猜结算
|
||||
- points.service.ts - 积分操作
|
||||
- assets.service.ts - 资产借还
|
||||
|
||||
2. **修复并发竞态**（1-2 小时）
|
||||
- groups.service.ts - 小组成员数
|
||||
- appointments.service.ts - 预约人数
|
||||
- assets.service.ts - 资产状态
|
||||
|
||||
3. **修复积分计算**（30 分钟）
|
||||
- bets.service.ts - 积分分配算法
|
||||
|
||||
---
|
||||
|
||||
### 阶段二：重要改进（3-5 天）
|
||||
|
||||
**优先级**: 🟡 中等
|
||||
**时间**: 3-5 小时
|
||||
|
||||
1. **统一权限模型**（1-2 小时）
|
||||
- 创建统一权限检查装饰器
|
||||
- 替换所有硬编码权限检查
|
||||
- 添加权限测试
|
||||
|
||||
2. **优化缓存策略**（1 小时）
|
||||
- 实现统一缓存管理
|
||||
- 添加缓存失效策略
|
||||
- 缓存一致性测试
|
||||
|
||||
3. **明确删除策略**（1-2 小时）
|
||||
- 审查所有级联删除
|
||||
- 实现软删除机制
|
||||
- 数据归档策略
|
||||
|
||||
---
|
||||
|
||||
### 阶段三：代码质量提升（1 周）
|
||||
|
||||
**优先级**: 🟢 低
|
||||
**时间**: 2-3 小时
|
||||
|
||||
1. **添加验证装饰器**（1-2 小时）
|
||||
- 所有实体添加验证
|
||||
- DTO 同步验证
|
||||
|
||||
2. **改进错误处理**（1 小时）
|
||||
- 统一错误码
|
||||
- 详细错误信息
|
||||
- 错误追踪
|
||||
|
||||
---
|
||||
|
||||
## 🧪 测试建议
|
||||
|
||||
### 必须添加的测试
|
||||
|
||||
1. **并发测试**
|
||||
```typescript
|
||||
describe('并发测试', () => {
|
||||
it('多个用户同时加入小组', async () => {
|
||||
const promises = Array(10).fill(null).map(() =>
|
||||
groupsService.join(userId, groupId)
|
||||
);
|
||||
await Promise.all(promises);
|
||||
// 验证成员数不超过限制
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
2. **事务回滚测试**
|
||||
```typescript
|
||||
it('竞猜结算失败时回滚', async () => {
|
||||
jest.spyOn(pointRepository, 'save').mockRejectedValueOnce(
|
||||
new Error('Database error')
|
||||
);
|
||||
await expect(
|
||||
betsService.settleBet(appointmentId, winningOption)
|
||||
).rejects.toThrow();
|
||||
// 验证数据没有部分更新
|
||||
});
|
||||
```
|
||||
|
||||
3. **数据一致性测试**
|
||||
```typescript
|
||||
it('积分总和必须一致', async () => {
|
||||
const beforePool = await getTotalPool();
|
||||
await betsService.settleBet(appointmentId, winningOption);
|
||||
const afterPool = await getTotalPool();
|
||||
expect(afterPool).toEqual(beforePool);
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📊 项目健康度评分
|
||||
|
||||
| 评估项 | 评分 | 说明 |
|
||||
|--------|------|------|
|
||||
| 架构设计 | ⭐⭐⭐⭐⭐ | 模块化设计优秀，职责清晰 |
|
||||
| 代码质量 | ⭐⭐⭐⭐ | TypeScript 类型安全，但缺少注释 |
|
||||
| 安全性 | ⭐⭐⭐⭐ | 认证授权完善，但需加强权限一致性 |
|
||||
| 性能 | ⭐⭐⭐⭐ | 有缓存和优化，但可进一步优化 |
|
||||
| 测试覆盖 | ⭐⭐⭐ | 84% 覆盖率，但缺少并发测试 |
|
||||
| 文档完善度 | ⭐⭐⭐⭐⭐ | 文档齐全，已整理到 doc 目录 |
|
||||
| **总体评分** | ⭐⭐⭐⭐ | **良好，需要修复关键问题** |
|
||||
|
||||
---
|
||||
|
||||
## 🎯 后续建议
|
||||
|
||||
### 短期（1-2 周）
|
||||
1. ✅ 修复所有高优先级问题
|
||||
2. ✅ 添加并发测试
|
||||
3. ✅ 完善事务管理
|
||||
4. ✅ 提高测试覆盖率到 90%+
|
||||
|
||||
### 中期（1-2 个月）
|
||||
1. 实现软删除机制
|
||||
2. 添加数据归档功能
|
||||
3. 实现缓存预热策略
|
||||
4. 添加性能监控
|
||||
|
||||
### 长期（3-6 个月）
|
||||
1. 微服务拆分（如需要）
|
||||
2. 引入消息队列
|
||||
3. 实现分布式锁
|
||||
4. 添加链路追踪
|
||||
|
||||
---
|
||||
|
||||
## 📝 总结
|
||||
|
||||
GameGroup 项目整体架构设计合理，模块划分清晰，代码质量较高。但在以下方面需要改进：
|
||||
|
||||
**必须立即修复**:
|
||||
1. 财务操作缺少事务管理（可能导致财务数据不一致）
|
||||
2. 并发竞态条件（可能导致业务逻辑错误）
|
||||
3. 积分计算精度损失（可能导致积分丢失）
|
||||
|
||||
**建议尽快修复**:
|
||||
4. 权限模型不统一（可能导致权限漏洞）
|
||||
5. 缓存一致性问题（可能返回过期数据）
|
||||
6. 级联删除策略不明确（可能导致数据意外删除）
|
||||
|
||||
**可选改进**:
|
||||
7. 添加实体级验证装饰器
|
||||
8. 改进错误消息
|
||||
|
||||
建议按照优先级分阶段修复，每个修复都应有充分的测试覆盖。修复完成后，项目质量将显著提升。
|
||||
|
||||
---
|
||||
|
||||
**报告生成时间**: 2025-12-19
|
||||
**分析人员**: Claude Code
|
||||
**下次审查时间**: 修复完成后重新评估
|
||||
Reference in New Issue
Block a user