Go語言標準庫log介紹

Go語言標準庫log介紹

不管是軟件開發的調試階段仍是軟件上線以後的運行階段，日誌一直都是很是重要的一個環節，咱們也應該養成在程序中記錄日誌的好習慣。

log

Go語言內置的log包實現了簡單的日誌服務。本文介紹了標準庫log的基本使用。

使用Logger

log包定義了Logger類型，該類型提供了一些格式化輸出的方法。本包也提供了一個預約義的「標準」logger，能夠經過調用函數Print系列(Print|Printf|Println）、Fatal系列（Fatal|Fatalf|Fatalln）、和Panic系列（Panic|Panicf|Panicln）來使用，比自行建立一個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 這是一條很普通的日誌。
2017/06/19 14:04:17 這是一條會觸發fatal的日誌。

logger會打印每條日誌信息的日期、時間，默認輸出到系統的標準錯誤。Fatal系列函數會在寫入日誌信息後調用os.Exit(1)。Panic系列函數會在寫入日誌信息後panic。

配置logger

標準logger的配置

默認狀況下的logger只會提供日誌的時間信息，可是不少狀況下咱們但願獲得更多信息，好比記錄該日誌的文件名和行號等。log標準庫中爲咱們提供了定製這些設置的方法。

log標準庫中的Flags函數會返回標準logger的輸出配置，而SetFlags函數用來設置標準logger的輸出配置。

func Flags() int
func SetFlags(flag int)

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

下面咱們在記錄日誌以前先設置一下標準logger的輸出選項以下：

func main() {
    log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
    log.Println("這是一條很普通的日誌。")
}

編譯執行後獲得的輸出結果以下：

2017/06/19 14:05:17.494943 .../log_demo/main.go:11: 這是一條很普通的日誌。

配置日誌前綴

log標準庫中還提供了關於日誌信息前綴的兩個方法：

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("這是一條很普通的日誌。")
}

上面的代碼輸出以下：

[小王子]2017/06/19 14:05:57.940542 .../log_demo/main.go:13: 這是一條很普通的日誌。

這樣咱們就可以在代碼中爲咱們的日誌信息添加指定的前綴，方便以後對日誌信息進行檢索和處理。

配置日誌輸出位置

func SetOutput(w io.Writer)

SetOutput函數用來設置標準logger的輸出目的地，默認是標準錯誤輸出。

例如，下面的代碼會把日誌輸出到同目錄下的xx.log文件中。

func main() {
    logFile, err := os.OpenFile("./xx.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
    if err != nil {
        fmt.Println("open log file failed, err:", err)
        return
    }
    log.SetOutput(logFile)
    log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
    log.Println("這是一條很普通的日誌。")
    log.SetPrefix("[小王子]")
    log.Println("這是一條很普通的日誌。")
}

若是你要使用標準的logger，咱們一般會把上面的配置操做寫到init函數中。

func init() {
    logFile, err := os.OpenFile("./xx.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
    if err != nil {
        fmt.Println("open log file failed, err:", err)
        return
    }
    log.SetOutput(logFile)
    log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
}

建立logger

log標準庫中還提供了一個建立新logger對象的構造函數–New，支持咱們建立本身的logger示例。New函數的簽名以下：

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

New建立一個Logger對象。其中，參數out設置日誌信息寫入的目的地。參數prefix會添加到生成的每一條日誌前面。參數flag定義日誌的屬性（時間、文件等等）。

舉個例子：

func main() {
    logger := log.New(os.Stdout, "<New>", log.Lshortfile|log.Ldate|log.Ltime)
    logger.Println("這是自定義的logger記錄的日誌。")
}

將上面的代碼編譯執行以後，獲得結果以下：

<New>2017/06/19 14:06:51 main.go:34: 這是自定義的logger記錄的日誌。

總結

Go內置的log庫功能有限，例如沒法知足記錄不一樣級別日誌的狀況，咱們在實際的項目中根據本身的須要選擇使用第三方的日誌庫，如logrus、zap等。