Golang日志格式化输出方法详解与选项对比

在Golang中定制你的日志输出格式

处理日志时，你是否觉得默认的输出格式不够用？别担心，Golang的log包提供了相当灵活的格式化能力。核心就在于两个方法：SetFlags和SetPrefix。通过它们，你可以轻松调整日志的前缀和内容格式。

基础格式选项：组合你的日志样式

log包预定义了几个常用的格式常量，你可以像搭积木一样，用按位或操作符（|）把它们组合起来。常用的选项有这么几个：

1. log.Ldate: 显示当前日期。
2. log.Ltime: 显示当前时间。
3. log.Llongfile: 显示完整的文件名和行号，方便定位代码。
4. log.Lshortfile: 只显示文件名（不含完整路径），更简洁。
5. log.LUTC: 使用UTC时间而非本地时间，这在分布式系统中很有用。

举个例子，如果你希望日志条目同时包含日期、时间以及具体的代码位置，可以这样设置：

package main

import (
    "log"
)

func main() {
    log.SetFlags(log.Ldate | log.Ltime | log.Llongfile)
    log.Println("这是一条日志信息")
}

运行后，日志输出就会包含类似“2023/10/27 14:35:02 /path/to/main.go:10: 这是一条日志信息”的详细信息。

进阶玩法：实现自定义格式化器

当然，预定义的选项可能无法满足所有场景，比如你需要将日志输出为JSON格式以便接入ELK等日志分析系统。这时，就需要祭出自定义log.Formatter接口这个大招了。

下面是一个将日志输出为JSON格式的典型实现：

package main

import (
    "encoding/json"
    "log"
    "os"
    "time"
)

type JSONFormatter struct{}

func (f JSONFormatter) Format(entry *log.Entry) ([]byte, error) {
    record := struct {
        Time        string                 `json:"time"`
        Level       string                 `json:"level"`
        Message     string                 `json:"message"`
        Stacktrace  []string               `json:"stacktrace,omitempty"`
        Additional  map[string]interface{} `json:"additional,omitempty"`
    }{
        Time:       entry.Time.Format(time.RFC3339),
        Level:      entry.Level.String(),
        Message:    entry.Message,
        Additional: entry.Data,
    }
    if len(entry.Stacktrace) > 0 {
        record.Stacktrace = entry.Stacktrace
    }
    return json.Marshal(record)
}

func main() {
    logger := log.New(os.Stdout, "", log.LstdFlags)
    logger.SetFormatter(JSONFormatter{})
    logger.Println("这是一条日志信息")
}

这段代码的脉络很清晰：我们定义了一个JSONFormatter结构体，并实现了Format方法。在这个方法里，我们把日志条目（包含时间、级别、消息等字段）重新组织成一个结构体，然后通过json.Marshal将其序列化为标准的JSON字符串。最后，创建一个新的log.Logger实例，并将它的格式化器设置为我们自定义的JSONFormatter。这样一来，所有通过这个logger输出的日志，都会自动变成机器易读、结构清晰的JSON格式。

通过这两种方式——基础选项的组合与自定义格式化器的实现——你基本上就能应对Golang项目中的各种日志格式化需求了。选择哪种，完全取决于你的实际应用场景和复杂度要求。