Go Generate 实现日志语句自动注入文件名、函数名与行号_技术教程

本文介绍如何结合 `go generate` 与 `runtime.caller` 实现编译期日志位置信息自动注入，将形如 `fmt.println("%fn%: error")` 的占位符替换为实际的 `main.go:myfunction():123` 等上下文信息，提升调试效率且不依赖运行时开销。

在 Go 开发中，手动在每条日志前拼接文件名、函数名和行号（如 fmt.Println("main.go:main():25: failed")）既繁琐又易出错。虽然 runtime.Caller() 可在运行时动态获取调用栈信息，但若希望在编译前完成静态替换（例如将 %file%:%func%:%line% 替换为字面量），则需借助 go generate 工具链实现代码生成。

需要注意的是：go generate 本身不执行运行时逻辑，它只是调用外部命令（如自定义 Go 脚本）来扫描源码、匹配模式并重写 .go 文件。因此，我们需分两步设计：

定义可识别的日志模板语法（推荐使用无歧义占位符，如 %%FILE%%, %%FUNC%%, %%LINE%%，避免与 fmt.Printf 格式冲突）；
编写生成器脚本，利用正则匹配这些占位符，并在对应位置插入 runtime.Caller(1) 的封装调用——而非直接展开为字符串字面量（因为位置信息必须在运行时确定）。

✅ 正确做法是：go generate 将原始日志语句

fmt.Println("%%FILE%%:%%FUNC%%:%%LINE%%: failed")

自动改写为：

fmt.Println(fileFuncLine(), "failed")

再配合一个轻量级辅助函数：

func fileFuncLine() string {
    pc, file, line, ok := runtime.Caller(1)
    if !ok {
        return "???:???:0"
    }
    funcName := runtime.FuncForPC(pc).Name()
    // 提取简洁函数名（去掉包路径）
    if lastSlash := strings.LastIndex(funcName, "/"); lastSlash >= 0 {
        funcName = funcName[lastSlash+1:]
    }
    // 提取文件名（不含完整路径）
    _, fileName := filepath.Split(file)
    return fmt.Sprintf("%s:%s:%d", fileName, funcName, line)
}

? 关键点说明：

runtime.Caller(1) 获取调用 fileFuncLine() 的那一行的位置（即日志语句所在位置），而非 fileFuncLine 自身内部位置；
占位符必须设计为 %%...%% 形式（双百分号），避免被 go fmt 或 go vet 误判为格式化动词；
go generate 指令应置于待处理文件顶部，例如：
```
//go:generate go run ./cmd/expand-logs
package main
```

⚠️ 注意事项：

不要尝试用 go generate 直接“计算”出绝对路径或行号并硬编码——这会失去动态性且在代码移动后失效；
所有生成逻辑应幂等（多次运行不改变结果），并跳过已处理过的行（可通过注释标记 // expanded 防重入）；
若项目需零依赖日志定位，建议直接集成 github.com/mohae/deepcopy 类工具，或使用成熟方案如 log/slog（Go 1.21+ 支持 AddSource(true) 自动注入源码位置）。