GoLong的学习之路（十三）语法之标准库 log（日志包）的使用

news2024/11/15 11:12:18

上回书说到，flag的问题。这回说到日志。无论是软件开发的调试阶段还是软件上线之后的运行阶段，日志一直都是非常重要的一个环节，我们也应该养成在程序中记录日志的好习惯。

文章目录

log
- 配置logger
- 配置日志前缀
- 配置日志输出位置
- 自定义logger

log

Go语言内置的log包实现了简单的日志服务。
log包定义了Logger类型，该类型提供了一些格式化输出的方法。

我们可以像下面的代码一样直接通过log包来调用上面提到的方法，默认它们会将日志信息打印到终端界面：

package main

import (
	"log"
)

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 这是一条很普通的日志。

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

配置logger

默认情况下的logger只会提供日志的时间信息，但是很多情况下我们希望得到更多信息，比如记录该日志的文件名和行号等。

log标准库中为我们提供了定制这些设置的方法。

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

func Flags() int
func SetFlags(flag int)

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

源码：
在这里插入图片描述
有这么多信息所以我们需要，选取我们自己要用的

func main() {
	//这个就是我们设置输出的日志格式
	log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
	log.Println("这是一条很普通的日志。")
}

配置日志前缀

func Prefix() string
func SetPrefix(prefix string)

Prefix函数用来查看标准logger的输出前缀
SetPrefix函数用来设置输出前缀

这样我们就能够在代码中为我们的日志信息添加指定的前缀，方便之后对日志信息进行检索和处理。

配置日志输出位置

func SetOutput(w io.Writer)

SetOutput函数用来设置标准logger的输出目的地，默认是标准错误输出。(其实就是日志的持久化（就是用一种方式保存起来）。方便出现一些宕机，服务器奔溃，使得整个信息错误信息消失)

自定义logger

log标准库中还提供了一个创建新logger对象的构造函数–New，支持我们创建自己的logger

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

New创建一个Logger对象。其中，参数out设置日志信息写入的目的地。参数prefix会添加到生成的每一条日志前面。参数flag定义日志的属性（时间、文件等等）。

import (
	"log"
	"os"
)

func main() {
	logger := log.New(os.Stdout, "<New>", log.Lshortfile|log.Ldate|log.Ltime)
	logger.Println("这是自定义的logger记录的日志。")

}