本文介绍如何结合 `runtime.caller` 与 `go generate` 实现日志语句中自动填充文件名、函数名和行号，避免手动硬编码位置信息，提升调试效率与代码可维护性。
在 Go 开发中，调试日志常需附带调用位置（如 main.go:myFunc():15），但手动维护易出错且冗余。虽然 go generate 本身不能直接修改源码中的字符串模板（如将 "%fn%" 替换为实际函数名），但它可被用于生成辅助工具或封装函数，从而在运行时动态获取并注入位置信息。核心思路是：用 runtime.Caller 在运行时解析调用栈，而非编译期文本替换。
✅ 推荐方案：封装带位置信息的日志函数
以下是一个简洁、生产就绪的封装示例：
package logutil
import (
"fmt"
"runtime"
)
// Trace 返回调用点的文件名、函数名和行号（跳过当前帧，返回上层调用者）
func Trace() (file, funcName string, line int) {
pc, file, line, ok := runtime.Caller(1)
if !ok {
return "???", "???", 0
}
fn := runtime.FuncForPC(pc)
if fn == nil {
return file, "???", line
}
return file, fn.Name(), line
}
// LogAt 输出带位置前缀的日志（推荐用于调试）
func LogAt(v ...interface{}) {
file, fn, line := Trace()
prefix := fmt.Sprintf("%s:%s():%d", shortFileName(file), shortFuncName(fn), line)
fmt.Println(append([]interface{}{prefix}, v...)...)
}
// shortFileName 去除 GOPATH/GOROOT 路径前缀，仅保留相对路径（如 "main.go"）
func shortFileName(full string) string {
for i := len(full) - 1; i >= 0; i-- {
if full[i] == '/' || full[i] == '\' {
return full[i+1:]
}
}
return full
}
// shortFuncName 提取函数名（如 "main.myFunc" → "myFunc"）
func shortFuncName(full string) string {
if i := len(full) - 1; i >= 0 {
for j := i; j >= 0; j-- {
if full[j] == '.' {
return full[j+1:]
}
}
}
return full
}使用方式（无需 go generate）：
package main
import "your/module/logutil"
func myFunction() {
err := fmt.Errorf("something went wrong")
logutil.LogAt("There was an error:", err) // 输出：main.go:myFunction():12: There was an error: ...
}
func main() {
logutil.LogAt("Application started")
myFunction()
}⚠️ 关于 go generate 的常见误解与澄清
- ❌ go generate 不是文本预处理器：它不支持类似 C 宏的字符串替换（如 %fn% → myFunc）。它仅用于执行命令（如 go run gen.go），生成 .go 文件。
- ✅ 合理用途：可编写生成器，自动为项目中所有 fmt.Println 调用注入 logutil.LogAt —— 但这属于重构工具范畴，非运行时必需。
- ✅ 更佳替代：直接使用 log 包的 SetFlags(log.Lshortfile) 或结构化日志库（如 zap + zap.AddCaller()），它们底层即基于 runtime.Caller，开箱即用。
✅ 性能与注意事项
- runtime.Caller 有轻微开销（通常 < 1μs），对高频日志需权衡；生产环境建议仅开启调试模式或使用条件日志（如 if debug { logutil.LogAt(...) }）。
- runtime.FuncForPC 在内联函数或某些优化场景下可能返回 nil，务必判空。
- 日志位置信息对单元测试友好（便于定位失败断言），但不应作为业务逻辑依赖。
综上，不要试图用 go generate 替换字符串模板，而应拥抱 Go 的运行时反射能力——封装一个轻量 Trace() 工具，即可安全、清晰、高效地获得精准的调用位置。
