Go语言log包 | 青训营笔记

57 阅读2分钟

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

log包定义了Logger类型,该类型提供了一些格式化输出的方法。

本包也提供了一个预定义的“标准”logger,可以通过调用函数Print系列(Print|Printf|Println)、Fatal系列(Fatal|Fatalf|Fatalln)、和Panic系列(Panic|Panicf|Panicln)来使用

func main() {
        log.Println("这是一条很普通的日志。")

        v := "很普通的"

        log.Printf("这是一条%s日志。\n", v)

        log.Fatalln("这是一条会触发fatal的日志。")

        log.Panicln("这是一条会触发panic的日志。")}

执行结果

2017/06/19 14:04:17 这是一条很普通的日志。

2017/06/19 14:04:17 这是一条很普通的日志。

2017/06/19 14:04:17 这是一条会触发fatal的日志。

logger会打印每条日志信息的日期、时间,默认输出到系统的标准错误。

Fatal系列函数会在写入日志信息后调用os.Exit(1)。Panic系列函数会在写入日志信息后panic。

配置logger

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

func Flags() int

func SetFlags(flag int)

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的初始值)

设置flag选项

func main() {

        log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)

        log.Println("这是一条很普通的日志。")}

输出

2023/01/23 15:30:23.114155 c:/Users/xxx/go/src/github.com/yyy/test/main.go:14: 这是一条很
普通的日志。

设置日志前缀

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

func Prefix() string

func SetPrefix(prefix string)

    log.SetPrefix("[logs]")

    log.Println("这是一条很普通的日志。")

输出[logs]2023/01/23 15:35:32 这是一条很普通的日志。


配置日志输出位置

SetOutput函数用来设置标准logger的输出目的地,默认是标准错误输出。

func SetOutput(w io.Writer)

func main() {
        //默认输出到xx.log文件

        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.SetPrefix("[aaa]")
        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)}

创建新的logger

New创建一个Logger对象。

其中,参数out设置日志信息写入的目的地。

参数prefix会添加到生成的每一条日志前面。

参数flag定义日志的属性(时间、文件等等)。

func New(out io.Writer, prefix string, flag int) *Logger

   logger := log.New(os.Stdout, "", log.Lshortfile|log.Ldate|log.Ltime)

   logger.Println("这是自定义的logger记录的日志。")

Go内置的log库功能有限,例如无法满足记录不同级别日志的情况,我们在实际的项目中根据自己的需要选择使用第三方的日志库,如logrus、zap等。