我需要在每处返回err的地方加上日志吗?
日志需要在哪个地方使用,与err如何配套使用
我现在的目录结构是pkg与 internal
pkg下面有config\infra\utils
internal 下面有cron\handler\middleware\logic\repo\model
各地方都有可能报错,日志是不是也要加在报错返回之前?日志如何使用
针对"日志谁来打"的问题,有一个最清晰的判定准则:谁负责"终结"这个错误,谁就负责打日志。
1. 为什么 repo 和 model 绝对不打日志?
在 repo(数据库操作)层,它只负责执行 SQL。如果执行失败了,它并不知道这个失败对业务意味着什么。
- 做法:直接
return fmt.Errorf("repo: 查询用户信息失败: %w", err)。 - 理由:如果你在
repo打印了日志,而上层logic发现这个错误其实可以通过读缓存补偿,从而忽略了错误,那你的日志里就会多出一条"虚假报警"。
2. 谁该打日志?(终结者们)
A. Middleware(中间件)------ 必打!
它是所有请求的最后一道防线。
- 职责:记录所有的 HTTP 访问日志,以及
Recovery捕获到的程序崩溃。 - 逻辑:它拿到了最终的结果,所以它记录的是"全局视角"。
B. Cron(定时任务)------ 必打!
定时任务没有前端页面,也没有 Response。
- 职责:如果
logic报错返回给cron了,cron就是这个错误的终结者。 - 逻辑:它必须把错误记下来,否则没人知道后台任务失败了。
C. Handler(控制器)------ 选打(视情况而定)
- 职责:如果一个错误
logic处理不了,传到了handler,handler准备给前端回一个ApiError。 - 建议:如果你已经在
middleware里记录了所有带错误信息的访问日志,那么handler其实可以不打,省得重复。但如果是特殊的业务警告,可以在这里打。
D. Logic(业务逻辑)------ 关键逻辑打
- 职责:这里是处理业务的地方。
- 场景:比如"用户支付失败",这种事关金钱的重大业务异常,即使你还没把错误返回给上层,也建议在这里打一条结构化日志,方便以后对账。
3. "报错即链条"示意图
想象一个请求的传递:
- Repo: 发现连接断了,
return %w。 - Logic: 收到报错,由于是关键业务,
infra.Log("pay").Error("支付中断", "err", err),然后继续return %w。 - Handler: 收到报错,调用
res.ApiError(w, 500, ...)返回给前端。 - Middleware: 最后的 Access Log 记录下:
method=POST status=500 err="logic: pay fail: repo: conn broken"。
结果:你的日志文件里,一条是详细的业务告警,一条是总体的 HTTP 记录。没有废话,全是干货。