refactor: 后端日志系统重构
- 新增模块化日志器(pkg/logger/module.go) - 新增 GORM 日志适配器 - 统一日志入口,移除所有 zap.L() 全局 logger 调用 - 字段标准化 - 启动阶段使用结构化日志 - 更新所有相关测试
This commit is contained in:
@@ -15,7 +15,7 @@
|
||||
- **WHEN** 应用启动
|
||||
- **THEN** SHALL 初始化 zap logger
|
||||
- **THEN** SHALL 根据配置设置日志级别
|
||||
- **THEN** SHALL 配置日志输出格式为 JSON
|
||||
- **THEN** SHALL 配置日志输出格式为 JSON(文件)和 Console(stdout)
|
||||
|
||||
#### Scenario: 日志字段
|
||||
|
||||
@@ -27,9 +27,9 @@
|
||||
#### Scenario: 日志注入
|
||||
|
||||
- **WHEN** 创建需要记录日志的组件
|
||||
- **THEN** SHALL 通过构造函数注入 *zap.Logger
|
||||
- **THEN** SHALL 允许 logger 参数为 nil,此时使用全局 logger zap.L()
|
||||
- **THEN** SHALL NOT 直接使用全局 logger zap.L()(除非在构造函数默认值中)
|
||||
- **THEN** SHALL 通过构造函数注入 `*zap.Logger`
|
||||
- **THEN** 调用方 SHALL 必须传入有效的 logger
|
||||
- **THEN** SHALL NOT 使用全局 logger `zap.L()`(测试代码除外)
|
||||
|
||||
### Requirement: 支持日志滚动
|
||||
|
||||
@@ -76,7 +76,8 @@
|
||||
#### Scenario: 日志关联请求 ID
|
||||
|
||||
- **WHEN** 记录请求相关的日志
|
||||
- **THEN** SHALL 自动包含请求 ID 字段
|
||||
- **THEN** SHALL 从 Context 提取 request_id
|
||||
- **THEN** SHALL 自动包含 request_id 字段
|
||||
- **THEN** SHALL 支持通过请求 ID 检索日志
|
||||
|
||||
### Requirement: 记录请求日志
|
||||
@@ -116,7 +117,7 @@
|
||||
|
||||
- **WHEN** 配置为生产模式
|
||||
- **THEN** SHALL 使用 info 级别
|
||||
- **THEN** SHALL 仅输出到文件
|
||||
- **THEN** SHALL 输出到控制台和文件
|
||||
|
||||
### Requirement: 日志存储位置
|
||||
|
||||
@@ -141,12 +142,77 @@ ConversionEngine SHALL 通过依赖注入获取 logger。
|
||||
#### Scenario: ConversionEngine 构造函数
|
||||
|
||||
- **WHEN** 创建 ConversionEngine 实例
|
||||
- **THEN** 构造函数 SHALL 接受 *zap.Logger 参数
|
||||
- **THEN** 参数为 nil 时 SHALL 使用 zap.L() 作为默认值
|
||||
- **THEN** 构造函数 SHALL 接受 `*zap.Logger` 参数
|
||||
- **THEN** 调用方 SHALL 必须传入有效的 logger
|
||||
- **THEN** SHALL 将 logger 存储在结构体字段中
|
||||
|
||||
#### Scenario: ConversionEngine 日志使用
|
||||
|
||||
- **WHEN** ConversionEngine 记录日志
|
||||
- **THEN** SHALL 使用注入的 logger 字段
|
||||
- **THEN** SHALL NOT 直接调用 zap.L()
|
||||
- **THEN** SHALL NOT 直接调用 `zap.L()`
|
||||
|
||||
### Requirement: 字段标准化
|
||||
|
||||
系统 SHALL 使用标准化字段定义。
|
||||
|
||||
#### Scenario: 标准字段常量
|
||||
|
||||
- **WHEN** 记录日志字段
|
||||
- **THEN** SHALL 使用 `pkg/logger/field.go` 中定义的常量
|
||||
- **THEN** 字段名 SHALL 包括:`request_id`、`provider_id`、`model_name`、`method`、`path`、`status`、`latency`
|
||||
|
||||
#### Scenario: 错误字段统一
|
||||
|
||||
- **WHEN** 记录错误日志
|
||||
- **THEN** SHALL 使用 `zap.Error(err)`
|
||||
- **THEN** SHALL NOT 使用 `zap.String("error", err.Error())`
|
||||
|
||||
#### Scenario: 字段构造函数
|
||||
|
||||
- **WHEN** 构造日志字段
|
||||
- **THEN** SHALL 优先使用 `pkg/logger` 提供的辅助函数
|
||||
- **THEN** 辅助函数 SHALL 返回 `zap.Field` 类型
|
||||
|
||||
### Requirement: 启动日志统一
|
||||
|
||||
系统 SHALL 在启动阶段使用结构化日志。
|
||||
|
||||
#### Scenario: 最小化 logger 初始化
|
||||
|
||||
- **WHEN** 应用启动时配置加载前
|
||||
- **THEN** SHALL 初始化最小化 logger(仅 stdout,console 格式)
|
||||
- **THEN** SHALL 支持记录启动错误
|
||||
|
||||
#### Scenario: Logger 升级
|
||||
|
||||
- **WHEN** 配置加载完成
|
||||
- **THEN** SHALL 升级为完整 logger(文件 + stdout)
|
||||
- **THEN** SHALL 应用配置的日志级别和轮转策略
|
||||
|
||||
#### Scenario: 配置摘要结构化
|
||||
|
||||
- **WHEN** 打印配置摘要
|
||||
- **THEN** SHALL 使用结构化日志记录
|
||||
- **THEN** SHALL NOT 使用 `fmt.Printf` 或 `fmt.Println`
|
||||
|
||||
### Requirement: 单行输出
|
||||
|
||||
系统 SHALL 保证所有日志单行输出。
|
||||
|
||||
#### Scenario: Console 单行
|
||||
|
||||
- **WHEN** 输出到 stdout
|
||||
- **THEN** SHALL 单行输出
|
||||
- **THEN** 字段之间 SHALL 使用空格分隔
|
||||
|
||||
#### Scenario: JSON 单行
|
||||
|
||||
- **WHEN** 输出到文件
|
||||
- **THEN** SHALL 单行紧凑 JSON
|
||||
- **THEN** SHALL NOT 使用美化缩进
|
||||
|
||||
#### Scenario: 多行数据保留
|
||||
|
||||
- **WHEN** 日志数据本身包含多行(堆栈跟踪、SQL 换行等)
|
||||
- **THEN** SHALL 保留原始多行格式
|
||||
|
||||
Reference in New Issue
Block a user