Go的日志库log竟然这么简单!

2022-08-18 14:29:09 浏览数 (1)

前言

最近在尝试阅读字节开源RPC框架Kitex的源码,看到日志库klog部分,果不其然在Go原生的log库的基础上增加了自己的设计,大体包括增加了一些格式化的输出增加一些常用的日志级别等。

一番了解后,发现有不少开源的日志库也做了类似的事情,以补充原生log库的不足。因为Go原生的log库本身也比较简单,这篇文章先分析一下它的实现,为后续阅读Kitex的日志库klog做一下铺垫。

本次分析基于:GO SDK 1.18.1 /src/log/log.go的源码。

log库的使用

结果如下:

第三个日志因为第二个日志打印之后,调用panic()函数,且没有调用recover(),导致程序终止。如果注释掉第二行日志即可打印出第三个日志的结果如下:

log.xxx能直接打印日志的原因

通过观察源码,log包log.go文件中,提供了9个函数可以直接使用,3个一套,分别针对print型日志输出、panic型日志输出(可以recover)、fatal型日志输出(直接终止程序)。

并且这9个函数中频繁使用到了一个std实例,只要我们引入了log包std就会完成初始化,并且作为默认使用的log实例。

Logger结构

既然std是默认的Logger实例,这里先看一下Logger的结构:

  • mu:互斥锁,用于原子写入操作。
  • prefix:日志前缀/后缀。
  • flag:控制需要展示的日志内容。
  • out:描述输出。
  • buf:缓冲区。

关于flag的使用,Go定义了如下的常量:

iota是常量计数器,从0开始自增,可以配合表达式使用,且在一系列常量声明时,可以只指定第一个位置,后续会默认初始化,这里依次初始化为1、2、4...

  • Ldata:输出当地日期,如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:如果设置了LdataLtime,则将输出UTC时间,而不是本地时区。
  • Lmsgprefix:将prefix信息从当前日志行首部移动到message之前。
  • LstdFlagsstd实例的默认值,表示Ldata | Ltime = 3

官方的注释中给出了一些介绍flag用法的例子,这里介绍一个:

如果:std.flag == Ldate | Ltime | Lmicroseconds | Llongfile == 15

则日志行输出结果为:2009/01/23 01:23:23.123123 /a/b/c/d.go:23: messagemessage为具体的日志内容。

std.Output()

回到上面9个函数打印日志,都通过调用std.Output()实现日志的输出,是log库的核心函数,看一下代码:

  • • 通过l.mu.Lock(),确保日志内容的写入是原子的。
  • • 检查l.flag是否包括Lshortfile或者Llongfile标志位,如果有则需要获取文件名行数,且这一步先释放了锁,因为Caller方法的调用比较耗时(expensive),确保锁住的临界区尽可能小。
  • calldepth:0表示获取调用runtime.Caller(calldepth)的文件名和行数,1表示调用std.Output()的文件名和函数,2表示调用log.Println()的文件名和行数,3则已经用不到了,Go原生log库获取行信息用的都是2。

• 清空缓冲区l.buf,并格式化日志头部信息(日期、文件名、行数),将其append入`buf。

  • • 最后将具体的日志信息s添加入buf,会补全末尾换行符,并调用l.out.Write(),将日志写入事先注册的输出文件。

定制自己的Logger

log库默认使用的std实例是事先初始化好的,那么借助New方法,我们也可以定制自己的logger:

这里指定了日志输出到文件log.txt中,并且定义了一些flag,结果如下:

小结

通过分析,我们发现log是一个很简洁的日志库,它有三种日志输出方式printpanicfatal,且可以自己定制日志的输出格式。但是熟悉其他语言开发的同学可能会对日志级别有更多的需求,且log的格式化用起来比较复杂。

因此会衍生出很多基于log的二次封装的日志库,下一篇文章将讲解字节跳动RPC框架Kitex的日志库klog的实现。

0 人点赞