Go语言日志滚动实现指南

碧海醫心

发布时间：2025-09-27 19:08:01

664人浏览过

来源于php中文网

原创

go语言日志滚动实现指南

本文介绍了Go语言标准库 log 包的局限性，即不具备日志滚动功能。针对这一问题，本文探讨了第三方库的选择以及实现日志滚动功能的常用方法，并提供了一些注意事项，帮助开发者在Go项目中实现高效可靠的日志管理。

Go语言的标准库 log 包提供了一种简单的日志记录方式，但它并不包含日志滚动（log rotation）的功能。这意味着，如果不采取额外的措施，日志文件会无限增长，最终可能会耗尽磁盘空间，给系统带来风险。因此，在实际项目中，尤其是需要长时间运行的服务中，日志滚动是必不可少的。

为什么需要日志滚动？

日志滚动的主要目的是管理日志文件的大小，避免单个日志文件过大。通过日志滚动，可以将一个大的日志文件分割成多个小的文件，并根据时间或文件大小进行归档或删除，从而实现日志的有效管理。

Go语言标准库的局限性

Go语言标准库 log 包只提供了基本的日志输出功能，例如输出到控制台、文件等。它没有内置的日志滚动机制。因此，我们需要借助第三方库或者手动实现日志滚动功能。

立即学习“go语言免费学习笔记（深入）”；

实现日志滚动的方法

以下是一些常用的实现Go语言日志滚动的方法：

使用第三方库：

有很多优秀的Go语言日志库提供了日志滚动功能。例如：
- lumberjack: 这是一个流行的日志滚动库，使用简单，功能强大，支持按文件大小、时间等多种方式进行滚动。
  
  LongCat AI
  美团推出的AI对话问答工具
  
  下载
```
package main

import (
    "log"
    "gopkg.in/natefinch/lumberjack.v2"
)

func main() {
    logger := &lumberjack.Logger{
        Filename:   "./app.log", // 日志文件路径
        MaxSize:    100,       // 每个日志文件最大尺寸，单位是MB
        MaxBackups: 5,         // 最大保留的备份文件个数
        MaxAge:     28,        // 最多保留的天数
        Compress:   true,      // 是否压缩
    }

    log.SetOutput(logger)
    log.Println("This is a log message.")

    // 关闭 logger，确保所有日志都被写入
    defer logger.Close()
}
```
  注意事项:
  - Filename 指定了日志文件的路径。
  - MaxSize 定义了每个日志文件的最大大小，单位为MB。当日志文件达到这个大小时，将会触发滚动。
  - MaxBackups 指定了保留的最大备份文件数量。
  - MaxAge 指定了保留日志文件的最大天数。
  - Compress 指定是否对滚动后的日志文件进行压缩。

手动实现日志滚动：

如果不想依赖第三方库，也可以手动实现日志滚动。这通常涉及以下步骤：

定期检查日志文件的大小。
当日志文件达到一定大小时，将其重命名或复制到备份目录。
创建一个新的日志文件，继续写入日志。

这种方法比较复杂，需要自己处理文件操作和错误处理，但可以更好地控制日志滚动的细节。

package main

import (
    "fmt"
    "log"
    "os"
    "path/filepath"
    "time"
)

const (
    logFileName   = "app.log"
    logMaxSize    = 10 * 1024 * 1024 // 10MB
    backupDirName = "backup"
)

func main() {
    // 确保备份目录存在
    if _, err := os.Stat(backupDirName); os.IsNotExist(err) {
        os.Mkdir(backupDirName, 0755)
    }

    logFile, err := os.OpenFile(logFileName, os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
    if err != nil {
        log.Fatalf("failed to open log file: %v", err)
    }
    defer logFile.Close()

    log.SetOutput(logFile)

    for i := 0; i < 1000; i++ {
        log.Printf("This is log message %d\n", i)
        checkAndRotateLog(logFile)
        time.Sleep(100 * time.Millisecond)
    }
}

func checkAndRotateLog(logFile *os.File) {
    fileInfo, err := logFile.Stat()
    if err != nil {
        log.Printf("failed to get log file stat: %v", err)
        return
    }

    if fileInfo.Size() >= logMaxSize {
        rotateLog(logFile)
    }
}

func rotateLog(logFile *os.File) {
    logFile.Close()

    timestamp := time.Now().Format("20060102150405")
    backupFileName := filepath.Join(backupDirName, fmt.Sprintf("%s.%s", logFileName, timestamp))

    err := os.Rename(logFileName, backupFileName)
    if err != nil {
        log.Printf("failed to rename log file: %v", err)
        return
    }

    newLogFile, err := os.OpenFile(logFileName, os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
    if err != nil {
        log.Fatalf("failed to open new log file: %v", err)
    }
    log.SetOutput(newLogFile)
}

注意事项: