GO的日誌庫log竟然這麼簡單!

前言

最近在嘗試閱讀位元組開源RPC框架Kitex的源碼,看到日誌庫klog部分,果不其然在Go原生的log庫的基礎上增加了自己的設計,大體包括增加了一些格式化的輸出增加一些常用的日誌級別等。

一番了解後,發現有不少開源的日誌庫也做了類似的事情,以補充原生log庫的不足。因為Go原生的log庫本身也比較簡單,這篇文章先分析一下它的實現,為後續閱讀Kitex的日誌庫klog做一下鋪墊。

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

log庫的使用

結果如下:

image-20220530210344181

第三個日誌因為第二個日誌列印之後,調用panic()函數,且沒有調用recover(),導致程式終止。如果注釋掉第二行日誌即可列印出第三個日誌的結果如下:

image-20220530210752882

log.xxx能直接列印日誌的原因

carbon

通過觀察源碼,log包log.go文件中,提供了9個函數可以直接使用,3個一套,分別針對print型日誌輸出、panic型日誌輸出(可以recover)、fatal型日誌輸出(直接終止程式)。

並且這9個函數中頻繁使用到了一個std實例,只要我們引入了log包std就會完成初始化,並且作為默認使用的log實例。

image-20220530211928675

Logger結構

既然std是默認的Logger實例,這裡先看一下Logger的結構:

image-20220531123015509

  • mu:互斥鎖,用於原子寫入操作。
  • prefix:日誌前綴/後綴。
  • flag:控制需要展示的日誌內容。
  • out:描述輸出。
  • buf:緩衝區。

關於flag的使用,Go定義了如下的常量:

image-20220531124125730

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庫的核心函數,看一下程式碼:

image-20220531122130791

  • 通過l.mu.Lock(),確保日誌內容的寫入是原子的。
  • 檢查l.flag是否包括Lshortfile或者Llongfile標誌位,如果有則需要獲取文件名行數,且這一步先釋放了鎖,因為Caller方法的調用比較耗時(expensive),確保鎖住的臨界區儘可能小。
  • calldepth:0表示獲取調用runtime.Caller(calldepth)的文件名和行數,1表示調用std.Output()的文件名和函數,2表示調用log.Println()的文件名和行數,3則已經用不到了,Go原生log庫獲取行資訊用的都是2。

image-20220531141453630

  • 清空緩衝區l.buf,並格式化日誌頭部資訊(日期、文件名、行數),將其append入`buf。
  • 最後將具體的日誌資訊s添加入buf,會補全末尾換行符,並調用l.out.Write(),將日誌寫入事先註冊的輸出文件。

訂製自己的Logger

image-20220531135448565

log庫默認使用的std實例是事先初始化好的,那麼藉助New方法,我們也可以訂製自己的logger:

image-20220531142257578

這裡指定了日誌輸出到文件log.txt中,並且定義了一些flag,結果如下:

image-20220531142835128

小結

通過分析,我們發現log是一個很簡潔的日誌庫,它有三種日誌輸出方式printpanicfatal,且可以自己訂製日誌的輸出格式。但是熟悉其他語言開發的同學可能會對日誌級別有更多的需求,且log的格式化用起來比較複雜。

因此會衍生出很多基於log的二次封裝的日誌庫,下一篇文章將講解字節跳動RPC框架Kitex的日誌庫klog的實現。