如何在 Go語言中使用紀錄檔包

2022-04-20 13:00:21

Go 語言標準庫之log 包

正因為紀錄檔很重要，所以 Go 語言標準庫提供了 log 包，可以對紀錄檔做一些簡單的設定，我們可以客製化一套自己的紀錄檔記錄器。

Golang 中的 log 包實現了簡單的 logging 包。它定義了一個型別、Logger 以及格式化輸出的方法。它還具有預定義的“標準”記錄器，可通過輔助函數 Print[f|ln]、Fatal[f|ln] 和 Panic[f|ln] 存取，它們比手動建立記錄器更易於使用。

基本的紀錄檔項包括：字首、日期時間戳、該紀錄檔由哪個原始檔記錄的、原始檔記錄紀錄檔所在行，最後是紀錄檔訊息。讓我們來看一下簡單的使用 log 包：在除法運算時除 0 時的訊息返回程式，而不是直接退出程式。

package main
import (
"errors"
"fmt"
"log"
)
func myDiv(x float64, y float64) (float64, error) {
if y == 0 {
return 0, errors.New("被除數不能為0")
}
return x / y, nil
}
func main() {
var x float64 = 128.2
var y float64
res, err := myDiv(x, y)
if err != nil {
log.Print(err) // Print 寫到標準紀錄檔記錄器
}
fmt.Println(res)
}

執行該程式：

$ go run learninglog.go
2022/04/19 23:18:06 被除數不能為0
0

在上面的程式中，我們匯入了三個包：errors 、fmt、log 。

然後使用了 log 包中的 Print 函數：此時紀錄檔記錄器將寫入標準錯誤並列印每條記錄訊息的日期和時間，這在一般情況下非常有用。每條紀錄檔訊息在單獨的行上都有一個輸出：如果正在列印的訊息沒有在新行結束，記錄器將新增一行。

另外，log 包中的 Fatal 函數在寫入紀錄檔訊息後呼叫 os.Exit(1)。

func main() {
var x float64 = 128.2
var y float64
res, err := myDiv(x, y)
if err != nil {
log.Fatal(err) // 在呼叫 Print() 之後會接著呼叫 os.Exit(1)
}
fmt.Println(res)
}
// 2022/04/19 23:22:44 被除數不能為0
// exit status 1

而 Panic 函數在寫入紀錄檔訊息後呼叫 panic，除非程式執行 recover() 函數，否則會導致程式列印呼叫棧後終止。

func main() {
var x float64 = 128.2
var y float64
res, err := myDiv(x, y)
if err != nil {
log.Panic(err) // Panic 會在呼叫 Print() 之後接著用 panic()
}
fmt.Println(res)
}

執行結果：

2022/04/19 23:24:18 被除數不能為0
panic: 被除數不能為0

goroutine 1 [running]:
log.Panic({0xc000086f60?, 0xc000086f70?, 0x404f99?})
/usr/local/go/src/log/log.go:385 +0x65
main.main()
/home/wade/go/src/logLearning/learninglog.go:26 +0x65
exit status 2

由此可知，Print 系列函數才是寫紀錄檔訊息的標準方法。

如何將紀錄檔訊息儲存在 Go 中的檔案中

上述程式碼中，只是簡單把紀錄檔訊息列印到控制檯，這是遠遠不夠的，因為控制檯是實時的，如果關閉控制檯紀錄檔訊息也就關閉了。

鑑於我們已經學習了 Go 語言如何讀取檔案，所以就可以把紀錄檔訊息儲存到一個檔案中，把所有的紀錄檔儲存到該檔案中。

package main
import (
"errors"
"fmt"
"log"
"os"
)
func myDiv(x float64, y float64) (float64, error) {
if y == 0 {
return 0, errors.New("被除數不能為0")
}
return x / y, nil
}
func main() {
var x float64 = 128.2
var y float64
res, exception := myDiv(x, y)
file, err := os.OpenFile("info.log", os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0600)
if err != nil {
log.Fatal(err)
}
defer file.Close() // 關閉檔案
log.SetOutput(file)
log.Print(exception)
fmt.Println(res)
}

執行程式碼：

$ go run learninglog.go
0

此外，我們會發現目錄中多了一個建立的 info.log 檔案。開啟檔案，你會看到列印出類似下面的內容。

客製化你的紀錄檔記錄器

要想建立一個客製化的紀錄檔記錄器，我們需要建立一個 Logger 型別的結構體，然後給每個紀錄檔記錄器設定一個輸出目的地、字首和標誌。而且每一個紀錄檔記錄器是多 goroutine 安全的，每一個 Logger 結構體都有一個互斥鎖，意味著多個 goroutine 可以同時呼叫來自同一個紀錄檔記錄器的這些函數，而不會有彼此間的寫衝突。來看一下 Logger 結構體的底層實現：

Logger結構體

// A Logger represents an active logging object that generates lines of
// output to an io.Writer. Each logging operation makes a single call to
// the Writer's Write method. A Logger can be used simultaneously from
// multiple goroutines; it guarantees to serialize access to the Writer.
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
}

然後我們來看一個範例程式：

package main
import (
"io"
"io/ioutil"
"log"
"os"
)
var (
Trace *log.Logger // 記錄所有紀錄檔
Info *log.Logger // 重要的資訊
Warning *log.Logger // 警告資訊
Error *log.Logger // 錯誤資訊
)
func init() {
file, err := os.OpenFile("errors.txt", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
if err != nil {
log.Fatalln("Failed to open error log file: ", err)
}
Trace = log.New(ioutil.Discard,
"Trace: ", log.Ldate|log.Ltime|log.Lshortfile)
Info = log.New(os.Stdout, "Info: ", log.Ldate|log.Ltime|log.Lshortfile)
Warning = log.New(os.Stdout, "Warning: ", log.Ldate|log.Ltime|log.Lshortfile)
Error = log.New(io.MultiWriter(file, os.Stderr), "Error: ", log.Ldate|log.Ltime|log.Lshortfile)
}
func main() {
Trace.Println("hello")
Info.Println("Information")
Warning.Println("Warning")
Error.Println("Error")
}

執行結果：

Info: 2022/04/20 00:37:34 learninglog.go:36: Information
Warning: 2022/04/20 00:37:34 learninglog.go:37: Warning
Error: 2022/04/20 00:37:34 learninglog.go:38: Error

使用 log 包的 New 函數，建立並初始化一個 Logger 型別的值，然後 New 函數返回新建立的值的地址。

New 函數

func New(out io.Writer, prefix string, flag int) *Logger {
return &Logger{out: out, prefix: prefix, flag: flag
}

New 函數的第一個引數 out 指定了紀錄檔要寫入的目的地，這個引數傳入的值必須實現了 io.Writer 介面
第二個引數 prefix 會在生成的每行紀錄檔的最開始出現
第三個引數 flag 定義紀錄檔包含哪些屬性

在本程式中：

Trace 紀錄檔記錄器使用了 ioutil 包裡的 Discard 變數作為寫到的目的地，所有的 Writer 呼叫都不會有動作，但是會成功返回。當某個等級的紀錄檔不重要時，使用 Discard 變數可以禁用這個等級的紀錄檔。
紀錄檔記錄器 Info 和 Warning 都使用 stdout 作為紀錄檔輸出。
紀錄檔記錄去 Error 中的 New 函數第一個引數使用了 MultiWriter 函數，這個函數呼叫會返回一個 io.Writer 介面型別的值，這個值包含之前開啟的檔案 file，以及 stderr。這個函數是一個變參函數，可以接受任意個實現了 io.Writer 介面的值，所以會把所有傳入的 io.Writer 繫結在一起，當對這個返回值進行寫入時，會向所有綁在一起的 io.Writer 值做寫入。從而實現向多個 Writer 做輸出。這樣做的好處就是使用 Error 記錄器記錄紀錄檔時，輸出會同時寫到檔案和 stderr 中。

總結

Golang 中 log 包的實現是基於對記錄紀錄檔這個需求長時間的實踐和積累而形成的。比如將輸出寫入 stdout，將紀錄檔記錄到 stderr，這同樣也是很多基於命令列介面的程式使用的方法。

寫紀錄檔的第一件事就是找到一個完美的庫。然後，在您選擇了紀錄檔庫之後，您還需要計劃在程式碼中的何處呼叫記錄器，如何儲存紀錄檔，如何在任何給定時間使它們可用，以及如何分析它們。

Go 紀錄檔的最佳實踐是從主應用程式程序中呼叫自定義記錄器，而不是在 goroutines 中。同時應該將應用程式中的紀錄檔訊息寫入本地檔案，做到永久儲存，同時針對錯誤的資訊應該給到提醒，方便及時定位和處理。

到此這篇關於如何在 Go語言中使用紀錄檔包的文章就介紹到這了,更多相關 Go使用紀錄檔包內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

如何在 Go語言中使用紀錄檔包

目錄

Go 語言標準庫之log 包

如何將紀錄檔訊息儲存在 Go 中的檔案中

客製化你的紀錄檔記錄器

總結

熱門文章