Golang中Gin框架下自定义日志存储轮转-Golang-PHP中文网

gin 默认日志不支持轮转，因其 gin.defaultwriter 绑定 os.stdout 且仅实现 io.writer，不感知文件生命周期；轮转需由 lumberjack 等外部库实现，并通过 gin.loggerwithwriter 直接注入，同时需确保格式兼容、避免多 writer 冲突。

golang中gin框架下自定义日志存储轮转

为什么 Gin 默认日志不支持轮转？

Gin 的 gin.DefaultWriter 默认绑定到 os.Stdout，底层用的是 io.Writer 接口，本身不感知文件生命周期——它只管写，不管“什么时候切文件”“旧日志删不删”。轮转是文件系统层面的策略，必须由外部日志库或手动封装实现。

直接用 log.SetOutput 替换也不行：Gin 内部调用的是自己的 logger 中间件（gin.Logger()），它硬编码使用 gin.DefaultWriter，不走标准库 log 包。

用 lumberjack 实现安全轮转的最小可行方案

lumberjack 是最轻量、被广泛验证的 Go 轮转日志 writer，它实现了 io.WriteCloser，可直接替换 Gin 的输出目标。关键点不是“能不能用”，而是“怎么插进去不破坏 Gin 日志格式”。

必须保留 Gin 原生日志的字段顺序和分隔符（如 time status method path latency size bytes），否则下游解析会出错
不能在 gin.LoggerWithWriter 里传入 *lumberjack.Logger 后再加额外包装（比如套一层 io.MultiWriter），否则时间戳或状态码可能被重复写或错位
lumberjack.Logger 的 MaxSize 单位是 MB，MaxBackups 是保留个数，MaxAge 是天数——三者同时生效，但 MaxAge 是按文件修改时间判断，不是创建时间，注意时区影响

示例代码：

Golang Naming

Go（Golang）命名规范 — 包括包、构造函数、结构体、接口、常量、枚举、错误、布尔值、接收器、getter/setter、函数等。

下载

lw := &lumberjack.Logger{
    Filename:   "./logs/access.log",
    MaxSize:    10, // MB
    MaxBackups: 5,
    MaxAge:     7,  // days
    Compress:   true,
}
r := gin.New()
r.Use(gin.LoggerWithWriter(lw)) // 直接传 lumberjack 实例

自定义日志格式时如何避免轮转失效

如果你用 gin.LoggerWithConfig 自定义了 Format，比如加了 traceID 或修改了字段顺序，那必须确保新格式仍能被 lumberjack 正常写入——它不校验内容，但若格式中包含非法字符（如未转义的换行符 \n）或长度失控（比如超长 traceID 导致单行 > 1MB），会导致轮转判断异常（lumberjack 按字节计数，不是按行）。

所有动态字段（如 {{.Keys.traceID}}）务必做非空判断和截断，例如：{{if .Keys.traceID}}{{.Keys.traceID | printf "%.16s"}}{{else}}-{{end}}
避免在 Format 字符串里拼接结构体或 map，JSON 序列化要走 {{.Keys.data | toJson}} 这类安全函数，而不是直接 {{.Keys.data}}
轮转触发依赖每次 write 的返回值（写入字节数），如果自定义 Format 返回空字符串或全空格，lumberjack 仍会计数，但日志内容丢失——需加测试用例验证实际写入内容

并发写入多个日志文件时的坑

有人想把 error 和 access 分开轮转，于是起两个 lumberjack.Logger 实例分别写不同文件，并用 gin.LoggerWithWriter + 自定义中间件分流。问题在于：lumberjack 每个实例都独立维护文件句柄和轮转逻辑，但 Gin 的 Logger 中间件默认只支持一个 writer；强行用 io.MultiWriter 合并会导致日志混杂、无法按类型轮转。

正确做法是：用单个 lumberjack 实例写主日志，再用 gin.LoggerWithConfig + 自定义 Output 函数，将 error 级别日志额外写入另一个 lumberjack 实例（即双 writer，但 error 写法必须同步、非阻塞）
切记：第二个 lumberjack 实例的 Filename 不能和第一个冲突，且 lumberjack 不支持同一个文件被两个实例打开（会报 permission denied）
更稳妥的方式是放弃 Gin 内置 logger，改用 zap 或 logrus 配合 lumberjack，再用 gin-contrib/zap 等适配器接管 Gin 日志——但这意味着放弃原生格式兼容性