Day06-GO语言简单的日志服务 | 青训营笔记

93 阅读3分钟

这是我参与「第五届青训营 」伴学笔记创作活动的第 6 天

Log:Go语言的log包实现了简单的日志服务

1、使用Logger

log包定义了Logger类型,该类型提供了一些格式化输出的方法。log包也提供了一个预定义的logger,如:Print系列的Print|Printf|Println、Fatal系列的Fatal|Fatalf|Fatalln、和Panic系列的Panic|Panicf|Panicln,可以直接通过log包来调用这些方法,默认它们会将日志信息打印到终端界面:

package main
import (
    "log"
)

func main() {
    log.Println("这是一条很普通的日志。")
    v := "很普通的"
    log.Printf("这是一条%s日志。\n", v)
    log.Fatalln("这是一条会触发fatal的日志。")
    log.Panicln("这是一条会触发panic的日志。")
}

//控制台输出:
2019/10/11 14:04:17 这是一条很普通的日志。
2019/10/11 14:04:17 这是一条很普通的日志。
2019/10/11 14:04:17 这是一条会触发fatal的日志。

logger会打印每条日志信息的日期、时间,默认输出到系统的标准错误。Fatal系列函数会在写入日志信息后调用os.Exit(1)。Panic系列函数会在写入日志信息后panic

2、配置logger

默认情况下的logger只会提供日志的时间信息,但是很多情况下我们希望得到更多信息,比如记录该日志的文件名和行号等。log标准库中为我们提供了定制这些设置的方法。

log标准库中的Flags函数会返回标准logger的输出配置,而SetFlags函数用来设置标准logger的输出配置:

func Flags() int
func SetFlags(flag int)

3、flag选项

log标准库提供了如下的flag选项,它们是一系列定义好的常量。

const (
    // 控制输出日志信息的细节,不能控制输出的顺序和格式。
    // 输出的日志在每一项后会有一个冒号分隔:例如2009/01/23 01:23:23.123123 /a/b/c/d.go:23: message

    Ldate = 1 << iota // 日期:2009/01/23
    Ltime // 时间:01:23:23
    Lmicroseconds // 微秒级别的时间:01:23:23.123123(用于增强Ltime位)
    Llongfile // 文件全路径名+行号: /a/b/c/d.go:23
    Lshortfile // 文件名+行号:d.go:23(会覆盖掉Llongfile)
    LUTC // 使用UTC时间
    LstdFlags = Ldate | Ltime // 标准logger的初始值
)

在记录日志之前先设置一下标准logger的输出选项如下:

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

//输出如下:
2019/10/11 14:05:17.494943 .../log_demo/main.go:11: 这是一条日志。

4、配置日志前缀

log标准库中还提供了关于日志信息前缀的两个方法:

//用来查看标准logger的输出前缀
func Prefix() string

//用来设置输出前缀
func SetPrefix(prefix string)

示例代码:

func main() {
    log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
    log.Println("这是一条日志。")
    log.SetPrefix("[pprof]")
    log.Println("这是一条日志。")
}

//控制台输出:
[pprof]2019/10/11 14:05:57.940542 .../log_demo/main.go:13: 这是一条日志。

5、配置日志输出位置

SetOutput函数用来设置标准logger的输出目的地,默认是标准错误输出:func SetOutput(w io.Writer)例如下面的代码会把日志输出到同目录下的xx.log文件中:

func main() {
    logFile, err := os.OpenFile("./xx.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND,0644)
    if err != nil {
    fmt.Println("open log file failed, err:", err)
    return
}

log.SetOutput(logFile)
log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
log.Println("这是一条很普通的日志。")
log.SetPrefix("[小王子]")
log.Println("这是一条很普通的日志。")
}

如果你要使用标准的logger,我们通常会把上面的配置操作写到init函数中:

func init() {
    logFile, err := os.OpenFile("./xx.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND,0644)
    if err != nil {
    fmt.Println("open log file failed, err:", err)
    return
}

log.SetOutput(logFile)
log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
}

总结 : Go内置的log库能实现大多数开发中的日志要求,但还是功能有限,实际的项目中我们还可以根据自己的需要选择使用第三方的日志库,如logrus、zap等。