Go語言標准庫log介紹


Go語言標准庫log介紹

轉載自 https://www.liwenzhou.com/posts/Go/go_log/

無論是軟件開發的調試階段還是軟件上線之后的運行階段,日志一直都是非常重要的一個環節,我們也應該養成在程序中記錄日志的好習慣。

mark

log

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

使用Logger

type Logger struct {
	mu     sync.Mutex // ensures atomic writes; protects the following fields
	prefix string     // prefix on each line to identify the logger (but see Lmsgprefix)
	flag   int        // properties
	out    io.Writer  // destination for output
	buf    []byte     // for accumulating text to write
}

log包定義了Logger類型,該類型提供了一些格式化輸出的方法。本包也提供了一個預定義的“標准”logger,可以通過調用函數Print系列(Print|Printf|Println)、Fatal系列(Fatal|Fatalf|Fatalln)、和Panic系列(Panic|Panicf|Panicln)來使用,比自行創建一個logger對象更容易使用。

關於預定義的logger其實也是使用New方法進行的初始化

var std = New(os.Stderr, "", LstdFlags)

例如,我們可以像下面的代碼一樣直接通過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的輸出選項如下:

就是通過SetFlags函數來自定義輸出日志的格式。

func main() {
	log.SetFlags(log.Llsetongfile | 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庫功能有限,例如無法滿足記錄不同級別日志的情況,我們在實際的項目中根據自己的需要選擇使用第三方的日志庫,如logruszap等。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM