使用标准库log记录错误并结合zap实现结构化日志,通过错误包装和上下文增强可维护性。

在Go语言开发中,错误日志输出是保障程序可维护性和排查问题的关键环节。良好的日志实践能帮助开发者快速定位异常、分析调用链并提升系统稳定性。Golang标准库提供了基础支持,结合第三方库可以实现更精细的控制。
使用标准库 log 输出错误日志
Go 的 log 包是最基础的日志工具,适合简单场景下的错误记录。
可以通过 log.Printf 或 log.Println 将错误信息写入标准输出或自定义目标。
package main
import (
"log"
"os"
)
func main() {
// 将日志写入文件
file, err := os.OpenFile("error.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
if err != nil {
log.Fatal("无法打开日志文件:", err)
}
defer file.Close()
log.SetOutput(file)
log.SetPrefix("[ERROR] ")
log.SetFlags(log.LstdFlags | log.Lshortfile)
// 记录错误
if _, err := os.Open("nonexistent.txt"); err != nil {
log.Println("文件打开失败:", err)
}
}
说明:通过 SetOutput 指定日志输出位置,SetPrefix 添加标签,SetFlags 控制时间、文件名等格式。
立即学习“go语言免费学习笔记(深入)”;
结合 errors 和 fmt 增强错误上下文
原生 error 类型不带堆栈信息,可通过 fmt.Errorf 加上下文,或使用 errors.Join(Go 1.20+)串联多个错误。
if err := readFile(); err != nil {
log.Printf("处理用户数据失败: %v", fmt.Errorf("读取配置失败: %w", err))
}
利用 %w 包装错误,保留原始错误链,后续可用 errors.Is 或 errors.As 判断类型或展开错误。
使用 zap 或 logrus 实现结构化日志
在生产环境中,推荐使用高性能结构化日志库如 uber-go/zap,它支持 JSON 格式输出,便于日志采集和分析。
package main
import (
"go.uber.org/zap"
)
func main() {
logger, _ := zap.NewProduction()
defer logger.Sync()
if _, err := os.Open("missing.conf"); err != nil {
logger.Error("配置文件读取失败",
zap.String("file", "missing.conf"),
zap.Error(err),
)
}
}
zap 提供两种模式:NewProduction 用于线上,输出结构化 JSON;NewDevelopment 更适合本地调试,输出可读性强的文本。
关键实践建议
- 错误日志应包含足够的上下文,如函数名、参数、用户ID等,但避免泄露敏感信息
- 统一日志格式,尤其是服务集群部署时,利于集中检索
- 区分日志级别:error 仅用于不可恢复问题,warn 可用于预期外但可处理的情况
- 确保日志输出目标持久化,生产环境不要直接打到标准输出
- 定期轮转日志文件,防止磁盘占满
基本上就这些。从标准库起步,按需引入结构化日志库,配合合理的错误包装策略,就能构建清晰可靠的错误追踪体系。










