go語言記log-logger

介紹一下golang如何記log。

log
首先是golang自帶的package log。使用godoc查看，godoc -http=:8001，然後就可以在localhost:8001/pkg/log就可以查看了。

最重要的是SetOutput這個函數，原型是func SetOutput(w io.Writer),決定了log應該輸出到什麼地方，默認是標準輸出。下面是把log輸出到文件的一個簡單代碼示例。

package main

import (
    "log"
    "os"
)

func main() {
    f, err := os.OpenFile("logfile.log", os.O_RDWR|os.O_CREATE|os.O_APPEND, 0666)
    if err != nil {
    	log.Fatalf("file open error : %v", err)
    }
    defer f.Close()
    log.SetOutput(f)
    log.Println("This is a test log entry")
}

我們此時打開文件logfile.log，會看到文件內容如下。

2016/03/11 17:54:10 This is a test log entry

有時候我們並不需要前面的日期以及時間信息，比如做自動化測試的時候比對log肯定不希望有時間信息。那應該怎麼辦呢？這時候就該SetFlags()出場了。

package main

import (
    "log"
    "os"
)

func main() {
    f, err := os.OpenFile("logfile.log", os.O_RDWR|os.O_CREATE|os.O_APPEND, 0666)
    if err != nil {
    	log.Fatalf("file open error : %v", err)
    }
    defer f.Close()
    log.SetOutput(f)
    log.SetFlags(0)
    log.Println("This is a test log entry")
}

SetFlags(flag int)函數可以用來自定義log的輸出格式，flag可選如下任意個標誌的或操作的組合。

const (
    Ldate         = 1 << iota     // the date: 2009/01/23
    Ltime                         // the time: 01:23:23
    Lmicroseconds                 // microsecond resolution: 01:23:23.123123.  assumes Ltime.
    Llongfile                     // full file name and line number: /a/b/c/d.go:23
    Lshortfile                    // final file name element and line number: d.go:23. overrides Llongfile
    LstdFlags     = Ldate | Ltime // initial values for the standard logger
)

iota的語法就不細說了，這裏Ldate，Ltime，Lmicroseconds分別表示右起第一二三位。

自定義log形式還可以使用SetPrefix(prefix string)可以在我們的log最前面添加特定的prefix。除此之外剩下的API，比如Fatal，Fatalf，Panic等都相當於先輸出log，然後調用Exit()或者panic函數。

logger
logger是log的一個簡單封裝，使用logger可以使記log更加的便捷。一個簡單的示例如下。

package main

import (
    "log"
    "os"
)

func main() {
    logger := log.New(os.Stdout, "DEBUG", log.Ldata | log.Ltime)
    logger.Println("This is a DEBUG LOG")
}

運行上述go程序，將在終端得到如下結果：

DEBUG: 2016/03/11 22:21:19 This is a DEBUG LOG

我們簡單看一下log.New()函數原型。

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

os.Stdout表示標準輸出，如果你想記錄到文件中，將os.Open()或者os.OpenFile()的返回值傳入即可。“DEBUG”即爲每條log的前綴，最後的flag就爲上述的flag。相比於上面的代碼片段，下面的代碼更加的實用。

package main

import (
    "io"
    "io/ioutil"
    "log"
    "os"
)

var (
    Info    *log.Logger
    Warning *log.Logger
    Error   *log.Logger
)

func Init(
    infoHandle io.Writer,
    warningHandle io.Writer,
    errorHandle io.Writer) {

    Info = log.New(infoHandle,
        "INFO: ",
        log.Ldate|log.Ltime|log.Lshortfile)

    Warning = log.New(warningHandle,
        "WARNING: ",
        log.Ldate|log.Ltime|log.Lshortfile)

    Error = log.New(errorHandle,
        "ERROR: ",
        log.Ldate|log.Ltime|log.Lshortfile)
}

func main() {
    Init(ioutil.Discard, os.Stdout, os.Stdout, os.Stderr)

    Info.Println("Special Information")
    Warning.Println("There is something you need to know about")
    Error.Println("Something has failed")
}

參考資料：
go語言記log：log,logger
Go語言實戰筆記（十八）| Go log 日誌