無論是軟體開發的調試階段還是軟體上線之後的運行階段,日誌一直都是非常重要的一個環節,我們也應該養成在程序中記錄日誌的好習慣。
log
Go語言內置的log包實現了簡單的日誌服務。本文介紹了標準庫log的基本使用。
使用Logger
log包定義了Logger類型,該類型提供了一些格式化輸出的方法。本包也提供了一個預定義的「標準」logger,可以通過調用函數Print系列(Print|Printf|Println)、Fatal系列(Fatal|Fatalf|Fatalln)、和Panic系列(Panic|Panicf|Panicln)來使用,比自行創建一個logger對象更容易使用。
例如,我們可以像下面的代碼一樣直接通過log包來調用上面提到的方法,默認它們會將日誌信息列印到終端介面:
編譯並執行上面的代碼會得到如下輸出:
logger會列印每條日誌信息的日期、時間,默認輸出到系統的標準錯誤。Fatal系列函數會在寫入日誌信息後調用os.Exit(1)。Panic系列函數會在寫入日誌信息後panic。
配置logger
標準logger的配置
默認情況下的logger只會提供日誌的時間信息,但是很多情況下我們希望得到更多信息,比如記錄該日誌的文件名和行號等。log標準庫中為我們提供了定製這些設置的方法。
log標準庫中的Flags函數會返回標準logger的輸出配置,而SetFlags函數用來設置標準logger的輸出配置。
flag選項
log標準庫提供了如下的flag選項,它們是一系列定義好的常量。
下面我們在記錄日誌之前先設置一下標準logger的輸出選項如下:
編譯執行後得到的輸出結果如下:
配置日誌前綴
log標準庫中還提供了關於日誌信息前綴的兩個方法:
其中Prefix函數用來查看標準logger的輸出前綴,SetPrefix函數用來設置輸出前綴。
上面的代碼輸出如下:
這樣我們就能夠在代碼中為我們的日誌信息添加指定的前綴,方便之後對日誌信息進行檢索和處理。
配置日誌輸出位置
SetOutput函數用來設置標準logger的輸出目的地,默認是標準錯誤輸出。
例如,下面的代碼會把日誌輸出到同目錄下的xx.log文件中。
如果你要使用標準的logger,我們通常會把上面的配置操作寫到init函數中。
創建logger
log標準庫中還提供了一個創建新logger對象的構造函數–New,支持我們創建自己的logger示例。New函數的簽名如下:
New創建一個Logger對象。其中,參數out設置日誌信息寫入的目的地。參數prefix會添加到生成的每一條日誌前面。參數flag定義日誌的屬性(時間、文件等等)。
舉個例子:
將上面的代碼編譯執行之後,得到結果如下:
總結
Go內置的log庫功能有限,例如無法滿足記錄不同級別日誌的情況,我們在實際的項目中根據自己的需要選擇使用第三方的日誌庫,如logrus、zap等。
原文連結:https://www.liwenzhou.com/posts/Go/go_log/
本文作者:李文周,原創授權發布