1. 程式人生 > 其它 >Golang標準庫之log包

Golang標準庫之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

2.1 標準logger的配置

預設情況下的logger只會提供日誌的時間資訊,但是很多情況下我們希望得到更多資訊,比如記錄該日誌的檔名和行號等。log標準庫中為我們提供了定製這些設定的方法。
log標準庫中的Flags函式會返回標準logger的輸出配置,而SetFlags函式用來設定標準logger的輸出配置。

func Flags() int
func SetFlags(flag int)

2.2 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: 這是一條很普通的日誌。

2.3 配置日誌字首

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: 這是一條很普通的日誌。
這樣我們就能夠在程式碼中為我們的日誌資訊新增指定的字首,方便之後對日誌資訊進行檢索和處理。

2.4 配置日誌輸出位置

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等。