docs:重构文档结构

- 创建模块化文档系统
- 添加用户认证系统详细文档
- 添加日志系统专门文档
- 简化主README,通过链接引用子系统文档
- 提高文档的可维护性和可读性
This commit is contained in:
moyin
2025-12-17 14:39:55 +08:00
parent 0ed867a2f1
commit eb2ff99b09
3 changed files with 430 additions and 45 deletions

View File

@@ -270,59 +270,30 @@ docs/ # 项目文档
## 核心功能
### 日志系统
### 🔐 用户认证系统
项目集成了完整的日志系统,基于 Pino 高性能日志库
完整的用户认证解决方案,支持多种登录方式和安全特性
**特性:**
- 🚀 高性能日志记
- 🔒 自动敏感信息过滤
- 🎯 多级别日志控制
- 🔍 请求上下文绑定
- 📊 结构化日志输出
- 用户名/邮箱/手机号登录
- GitHub OAuth 第三方登
- 密码重置和修改功能
- bcrypt 密码加密
- 基于角色的权限控制
**使用示例:**
**详细文档**: [用户认证系统文档](./docs/systems/user-auth/README.md)
```typescript
import { AppLoggerService } from './core/utils/logger/logger.service';
### 📊 日志系统
@Injectable()
export class UserService {
constructor(private readonly logger: AppLoggerService) {}
基于 Pino 的高性能日志系统,提供结构化日志记录:
async createUser(userData: CreateUserDto) {
this.logger.info('开始创建用户', {
operation: 'createUser',
email: userData.email,
timestamp: new Date().toISOString()
});
- 高性能日志记录
- 自动敏感信息过滤
- 多级别日志控制
- 请求上下文绑定
try {
const user = await this.userRepository.save(userData);
this.logger.info('用户创建成功', {
operation: 'createUser',
userId: user.id,
email: userData.email
});
**详细文档**: [日志系统文档](./docs/systems/logger/README.md)
return user;
} catch (error) {
this.logger.error('用户创建失败', {
operation: 'createUser',
email: userData.email,
error: error.message
}, error.stack);
throw error;
}
}
}
```
详细使用方法请参考:[后端开发规范指南 - 日志系统使用指南](./docs/backend_development_guide.md#四日志系统使用指南)
**💡 提示:使用 [AI 辅助开发指南](./docs/AI辅助开发规范指南.md) 可以让 AI 帮你自动生成符合规范的日志代码!**
**💡 提示:使用 [AI 辅助开发指南](./docs/AI辅助开发规范指南.md) 可以让 AI 帮你自动生成符合规范的代码!**
## 下一步