無論是軟體開發的除錯階段還是軟體上線之后的運行階段，日志一直都是非常重要的一個環節，我們也應該養成在程式中記錄日志的好習慣，

log

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

使用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等，

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/43057.html

標籤：Go

上一篇：Go語言檔案操作

下一篇：Go語言標準庫之flag

Go語言標準庫之log

log