生产环境应选用zap或zerolog替代log包:zap强调类型安全与规范,zerolog侧重灵活轻量;需注意Sync()调用、MultiWriteSyncer正确用法、避免init初始化及封装业务日志层。

如何为Golang项目配置日志环境_日志依赖环境准备说明  第1张

Go 标准库的 log 包够用,但生产环境必须换更可控的日志库——否则你没法按 level 过滤、加字段、输出 JSON、轮转文件,甚至会因并发写日志导致 panic。

zap 还是 zerolog?看你的结构化需求强不强

两者都是高性能结构化日志库,零分配、无反射。区别在于设计哲学:

  • zap 更重类型安全:所有字段必须显式调用 zap.String()zap.Int() 等,编译期报错;适合团队规范强、需长期维护的项目
  • zerolog 更轻量灵活:用 log.Str("key", "val") 链式调用,支持动态 key(如 log.Str("user_id_"+id, "active")),但字段名拼错只能靠日志观察
  • 若项目已用 uber-go/zap 生态(比如 fx 框架),优先延续用 zap
  • 若追求极简嵌入、或日志要直接发 HTTP(zerolog 内置 HTTPWriter),选 zerolog

初始化 zap.Logger 时别漏掉 Sync() 调用

这是最常被忽略的坑:不显式调用 logger.Sync(),程序退出时可能丢失最后几条日志。尤其在 CLI 工具或短生命周期服务中极易复现。

func main() {
    logger, _ := zap.NewProduction()
    defer logger.Sync() // 必须有

    logger.Info("app started")
    // ... 其他逻辑
}
  • 只在 main() 或顶层入口 defer,不要每个函数都 defer
  • 如果用 zap.NewDevelopment(),也要 defer Sync() —— 开发模式只是编码器不同,缓冲机制一样
  • 在测试中,可改用 zaptest.NewLogger(t),它自动管理 sync,无需手动 defer

日志输出到文件 + 控制台,别用 io.MultiWriter

看似简单,但 zapWriteSyncer 是线程安全的,而 os.Fileos.Stdout 的 Write 方法不是原子的。直接套 io.MultiWriter 可能导致日志行错乱(比如一行日志被截断成两段)。

立即学习“go语言免费学习笔记(深入)”;

  • 正确做法:用 zapcore.NewMultiWriteSyncer()
  • 示例:
file, _ := os.OpenFile("app.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
consoleSyncer := zapcore.Lock(os.Stdout)
fileSyncer := zapcore.Lock(file)

core := zapcore.NewCore(
    zapcore.JSONEncoder{TimeKey: "ts"},
    zapcore.NewMultiWriteSyncer(consoleSyncer, fileSyncer),
    zapcore.InfoLevel,
)
  • 注意:两个 WriteSyncer 都要用 zapcore.Lock() 包裹,否则并发写文件仍可能出错
  • 轮转需求?别自己实现,直接上 lumberjack.Logger(配合 zapcore.AddSync

环境变量控制日志级别,但别在 init() 里读

很多项目在 init() 函数里读 LOG_LEVEL 并初始化全局 logger,这会导致单元测试无法覆盖不同 level 场景——因为 init() 只跑一次,且早于 test setup。

  • 推荐方式:把 logger 初始化逻辑封装成函数,接受 level 参数,在 main() 或测试 setup 中按需调用
  • 示例:
func NewLogger(level string) (*zap.Logger, error) {
    l, err := zap.ParseAtomicLevel(level)
    if err != nil {
        return nil, err
    }
    return zap.New(zapcore.NewCore(
        zapcore.NewConsoleEncoder(zapcore.EncoderConfig{}),
        zapcore.Lock(os.Stdout),
        l,
    )), nil
}

// main.go
logger, _ := NewLogger(os.Getenv("LOG_LEVEL"))
defer logger.Sync()
  • 这样测试时可传 "debug""error",验证不同路径是否打日志
  • 如果用 flagspf13/cobra,也建议把 level 作为命令行参数而非仅依赖环境变量

真正难的不是选库或写初始化代码,而是让日志字段命名统一、关键上下文(如 request_id、trace_id)自动注入、错误日志必带 stack trace——这些得靠封装一层业务 logger 实现,而不是每次手写 logger.Error("xxx", zap.String("user_id", uid))