在现代 Go 语言程序中,可以使用标准库和第三方库来实现日志的产生并写入文件。以下是详细步骤和示例代码,使用标准库的 log 包和 os 包:

使用标准库实现日志写入文件

  1. 导入必要的包

    • os:用于文件操作。
    • log:用于日志输出。
  2. 创建或打开日志文件
    使用 os.OpenFile 打开或创建日志文件。
  3. 设置日志输出目标
    使用 log.SetOutput 将日志输出定向到文件。
  4. 编写日志记录逻辑
    使用 log.Printlnlog.Printf 等记录日志。

示例代码

package main

import (
    "log"
    "os"
)

func main() {
    // 打开或创建日志文件
    logFile, err := os.OpenFile("app.log", os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
    if err != nil {
        log.Fatalf("无法打开日志文件: %v", err)
    }
    defer logFile.Close()

    // 设置日志输出到文件
    log.SetOutput(logFile)

    // 配置日志前缀和时间格式
    log.SetFlags(log.Ldate | log.Ltime | log.Lshortfile)

    // 记录日志
    log.Println("程序启动")
    log.Printf("正在运行的 PID: %d", os.Getpid())

    // 模拟一些日志输出
    for i := 0; i < 5; i++ {
        log.Printf("这是第 %d 条日志", i+1)
    }

    log.Println("程序结束")
}

运行结果

运行该程序后,会生成或追加到 app.log 文件中,文件内容示例:

2024/12/02 14:00:00 main.go:21: 程序启动
2024/12/02 14:00:00 main.go:22: 正在运行的 PID: 12345
2024/12/02 14:00:00 main.go:26: 这是第 1 条日志
2024/12/02 14:00:00 main.go:26: 这是第 2 条日志
2024/12/02 14:00:00 main.go:26: 这是第 3 条日志
2024/12/02 14:00:00 main.go:26: 这是第 4 条日志
2024/12/02 14:00:00 main.go:26: 这是第 5 条日志
2024/12/02 14:00:00 main.go:28: 程序结束

使用第三方库 logrus

如果需要更高级的功能(如结构化日志),可以使用第三方日志库,如 logrus

  1. 安装 logrus

    go get github.com/sirupsen/logrus
  2. 示例代码

    package main
    
    import (
        "os"
    
        log "github.com/sirupsen/logrus"
    )
    
    func main() {
        // 打开或创建日志文件
        logFile, err := os.OpenFile("app.log", os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
        if err != nil {
            log.Fatalf("无法打开日志文件: %v", err)
        }
        defer logFile.Close()
    
        // 设置输出目标为文件
        log.SetOutput(logFile)
    
        // 设置日志格式为 JSON
        log.SetFormatter(&log.JSONFormatter{})
    
        // 日志记录
        log.WithFields(log.Fields{
            "event": "启动",
            "pid":   os.Getpid(),
        }).Info("程序启动")
    
        log.Info("这是普通日志信息")
        log.Warn("这是警告日志信息")
        log.Error("这是错误日志信息")
    }
  3. 运行结果
    日志文件 app.log 中的内容可能是这样的:

    {"event":"启动","level":"info","msg":"程序启动","pid":12345,"time":"2024-12-02T14:00:00Z"}
    {"level":"info","msg":"这是普通日志信息","time":"2024-12-02T14:00:00Z"}
    {"level":"warning","msg":"这是警告日志信息","time":"2024-12-02T14:00:00Z"}
    {"level":"error","msg":"这是错误日志信息","time":"2024-12-02T14:00:00Z"}

总结

  • 使用标准库的 log 包可以满足基础需求,简单易用。
  • 使用第三方库(如 logruszap)适合更复杂的需求,比如结构化日志、异步日志等。

标签: none

添加新评论