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

使用Logger

log包定義了Logger型別，該型別提供了一些格式化輸出的方法。本包也提供了一個預定義的“標準”logger，可以通過呼叫函式Print系列(Print|Printf|Println）、Fatal系列（Fatal|Fatalf|Fatalln）、和Panic系列（Panic|Panicf|Panicln）來使用，比自行建立一個logger物件更容易使用。

例如，我們可以像下面的程式碼一樣直接通過log包來呼叫上面提到的方法，預設它們會將日誌資訊列印到終端介面：

func main() {
	defer func() {
		log.Println(recover())  // 捕獲panic丟擲的異常，並輸出
	}()
	log.Println("這是一個普通的日誌")
	v := "一個普通的"
	log.Printf("這是%s日誌\n", v)

	log.Panicln("這是一條會觸發Panicln的日誌")

	log.Fatalln("這是一條會觸發Fatalln的日誌")
}

 

輸出結果：

2021/11/29 15:44:33 這是一個普通的日誌
2021/11/29 15:44:33 這是一個普通的日誌
2021/11/29 15:44:33 這是一條會觸發Panicln的日誌
2021/11/29 15:44:33 這是一條會觸發Panicln的日誌

logger會列印每條日誌資訊的日期、時間，預設輸出到系統的標準錯誤。Fatal系列函式會在寫入日誌資訊後呼叫os.Exit(1)。Panic系列函式會在寫入日誌資訊後panic。

配置Logger

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

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.Ldate | log.Ltime | log.Llongfile)
	log.Printf("標準日誌輸出格式")
}

輸出結果：
2021/11/29 16:26:55 C:/Users/mayanan/Desktop/pro_go/common_standard_library/main.go:7: 標準日誌輸出格式

配置日誌字首

log標準庫中還提供了關於日誌資訊字首的兩個方法：

func main() {
	log.SetFlags(log.Ldate | log.Ltime | log.Llongfile)
	log.Println("標準日誌輸出格式")

	log.SetPrefix("[pprof]")
	log.Println("日誌")
}

輸出結果：

2021/11/29 16:31:30 C:/Users/mayanan/Desktop/pro_go/common_standard_library/main.go:7: 標準日誌輸出格式
[pprof]2021/11/29 16:31:30 C:/Users/mayanan/Desktop/pro_go/common_standard_library/main.go:10: 日誌

這樣我們就能夠在程式碼中為我們的日誌資訊新增指定的字首，方便之後對日誌資訊進行檢索和處理。

配置日誌輸出位置

SetOutput函式用來設定標準logger的輸出目的地，預設是標準錯誤輸出。

func main() {
	// 注意第一步要先建個log目錄,檔案系統可以自己建
	today := time.Now().Format("2006-01-02")
	logPath := fmt.Sprintf("./log/%s.txt", today)
	logFile, err := os.OpenFile(logPath, 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("這是一條很普通的日誌。2222")
	log.SetPrefix("[小王子]")  // 設定日誌輸出字首
	log.Println("這是一條很普通的日誌22222。")
}

如果你要使用標準的logger，我們通常會把上面的配置操作寫到init函式中。

func init() {
	// 注意第一步要先建個log目錄,檔案系統可以自己建
	today := time.Now().Format("2006-01-02")
	logPath := fmt.Sprintf("./log/%s.txt", today)
	logFile, err := os.OpenFile(logPath, 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.SetPrefix("[小王子]")  // 設定日誌輸出字首

}

func main() {
	log.Println("日誌成功完成")
}

建立Logger

log標準庫中還提供了一個建立新logger物件的建構函式–New，支援我們建立自己的logger示例

var MyLogger *log.Logger
func init() {
	// 注意第一步要先建個log目錄,檔案系統可以自己建
	today := time.Now().Format("2006-01-02")
	logPath := fmt.Sprintf("./log/%s.txt", today)
	logFile, err := os.OpenFile(logPath, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
	if err != nil {
		fmt.Println("open log file failed, err:", err)
		return
	}

	MyLogger = log.New(logFile, "sankuan", log.Ldate|log.Ltime|log.Llongfile)

}

func main() {
	MyLogger.Println("我自定義的一個日誌")
}

總結 : Go內建的log庫功能有限，例如無法滿足記錄不同級別日誌的情況，我們在實際的專案中根據自己的需要選擇使用第三方的日誌庫，如logrus、zap等。