Go的小巧日志库log食用方法:

209 阅读4分钟

持续创作,加速成长!这是我参与「掘金日新计划 · 6 月更文挑战」的第14天,点击查看活动详情

🎐 放在前面说的话

大家好,我是沥沥樱 👧🏻

本科在读,此为日常捣鼓.

如有不对,请多指教,也欢迎大家来跟我讨论鸭 👏👏👏

还有还有还有很重要的,麻烦大可爱们动动小手,给沥沥樱点颗心心♥,沥沥樱需要鼓励嗷呜~

无论是软件开发的调试阶段还是软件上线之后的运行阶段,日志一直都是一个非常重要的环节,我们也应该养成在程序中记录日志的好习惯。那么我们今天来看一下Go原生日志库log要如何食用吧!

Let’s get it!

原生log

Go内置的log包实现了简单的日志服务,它支持三种日志输出方式printpanicfatal,且可以自己定制日志的输出格式。

原生log使用

普通栗子

func main() {
	log.Println("print沥沥樱")
	log.Panicln("panic")
	log.Fatalln("fatal")
}

打印:
2022/06/08 22:24:02 print沥沥樱
2022/06/08 22:24:02 panic
panic: panic

goroutine 1 [running]:
log.Panicln({0xc00011df60, 0x0, 0xe96e65})
C:/Program Files/Go/src/log/log.go:368 +0x65
main.main()
D:/Go-workspace/.../main.go:154 +0x78 exit status 2

分析结果

为什么第三个日志没被打印,且报错了
第三个日志因为在第二个日志后面,第二个日志调用panic()函数之后,没有再调用recover(),导致程序终止。注释掉第二个日志,就可以正常打印一三日志了

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

配置logger

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

func Flags() int
func SetFlags(flag int)

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

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

栗子

func main() {
	// 打印日志包含文件全路径名+行号,微秒级别的时间,日期
	log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
	log.Println("沥沥樱")
}

打印:
2022/06/08 22:53:42.718154 D:/Go-workspace/.../main.go:155: 沥沥樱

配置日志前缀

为我们的日志信息添加指定的前缀,方便之后对日志信息进行检索和处理。

前缀签名

func Prefix() string
func SetPrefix(prefix string)

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

栗子

func main() {
	// 打印日志包含文件全路径名+行号,微秒级别的时间,日期
	log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
	log.Println("沥沥樱")
	log.SetPrefix("[掘金]")
	log.Println("沥沥樱")
}

打印:
2022/06/08 22:58:47.534986 D:/Go-workspace/.../main.go:155: 沥沥樱
[掘金]2022/06/08 22:58:47.547205 D:/Go-workspace/.../main.go:157: 沥沥樱

创建logger

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

New签名

func New(out io.Writer, prefix string, flag int) *Logger
  • 参数out设置日志信息写入的目的地。
  • 参数prefix会添加到生成的每一条日志前面。
  • 参数flag定义日志的属性(时间、文件等等)。

栗子

func main() {
	// 打印日志包含文件全路径名+行号,微秒级别的时间,日期
	logger := log.New(os.Stdout, "[掘金]", log.Lshortfile|log.Ldate|log.Ltime)
	logger.Println("沥沥樱")
}

打印:
[掘金]2022/06/08 23:08:48 main.go:158: 沥沥樱

🎉 放在后面说的话

以上是Go原生log的食用方法,请尽情享用