01 、介紹

在 Go 語言項目開發(fā)中，我們通常需要查看日志來調(diào)試程序，所以日志的快捷搜索和過濾就會至關(guān)重要。

因為 Go 標準庫中的 log，它不是結(jié)構(gòu)化日志格式，使用上并不方便，所以在 Go 1.21.0 中，Go 標準庫新增結(jié)構(gòu)化日志記錄包 log/slog，它支持鍵值對格式。

本文我們介紹 log/slog 的使用方式。

02、log/slog 使用方式

log/slog 的默認 logger 使用的是 log 的默認 logger，新增日志包 log/slog 和原始日志包 log 協(xié)同工作，使 log/slog 更易上手。

日志級別

log/slog 日志級別包括 Info、Debug、Warn 和 Error，log/slog 為它們分別提供了函數(shù)。

示例代碼：

func main() {
 log.Println("This is log")
 slog.Debug("This is Debug Level")
 slog.Info("This is Info Level")
 slog.Warn("This is Warn Level")
 slog.Error("This is Error Level")
}

輸出結(jié)果：

2023/10/06 11:18:04 This is log
2023/10/06 11:18:04 INFO This is Info Level
2023/10/06 11:18:04 WARN This is Warn Level
2023/10/06 11:18:04 ERROR This is Error Level

閱讀上面這段代碼，我們可以發(fā)現(xiàn) log/slog 的輸出結(jié)果和 log 的輸出結(jié)果非常相似，只是在日志時間和日志消息之間多了日志級別。

因為 log/slog 的默認 logger 使用的是 log 的默認 logger。

除了上述 4 個不同日志級別的函數(shù)之外，還有一個函數(shù) log，我們可以使用 log 函數(shù)替代上述 4 個函數(shù)。

示例代碼：

func main() {
 slog.Log(context.Background(), -4, "This is Debug Level")
 slog.Log(context.Background(), 0, "This is Info Level")
 slog.Log(context.Background(), 4, "This is Warn Level")
 slog.Log(context.Background(), 8, "This is Error Level")
}

輸出結(jié)果：

2023/10/06 11:41:47 INFO This is Info Level
2023/10/06 11:41:47 WARN This is Warn Level
2023/10/06 11:41:47 ERROR This is Error Level

閱讀上面這段代碼，我們可以發(fā)現(xiàn)，log 函數(shù)通過參數(shù)定義日志級別，數(shù)字越大，級別越嚴重，并且不同級別之間，預留 4 個數(shù)字，我們可以定義其他日志級別。

log 函數(shù)與 4 個分別代表不同級別的函數(shù)之間，還有另外一個區(qū)別，它的第一參數(shù)是上下文，其實 4 個分別代表不同級別的函數(shù)也對應 4 個支持第一個參數(shù)是上下文的函數(shù)，分別是 InfoContext()、DebugContext()、WarnContext() 和 ErrorContext。

細心的讀者朋友們可能發(fā)現(xiàn)了，為什么輸出結(jié)果沒有 Debug 級別的日志輸出？

因為  log/slog 的默認 logger 的默認日志級別是 Info，如果我們想要使用日志級別 Debug，可以新建 logger，并把默認日志級別設(shè)置為 Debug。

鍵值對

前面我們已經(jīng)說過 log/slog 支持鍵值對格式，但是上述示例代碼中并沒有體現(xiàn)，接下來，我們以 Info 函數(shù)為例，介紹 log/slog 怎么輸出鍵值對格式。

func main() {
 slog.Info("This is Info Level", "uid", 1001)
}

輸出結(jié)果：

2023/10/06 11:58:07 INFO This is Info Level uid=1001

閱讀上面這段代碼，我們發(fā)現(xiàn) Info 函數(shù)中，在日志消息之后新增兩個參數(shù)，分別是 uid 和 1001，它們就是鍵值對的 key 和 value。

Logger 修改輸出日志格式

因為 log/slog 默認使用 log 的默認 logger，所以輸出格式就是我們上面看到的文本格式。

我們可以使用內(nèi)置的 Handler NewTextHandler 和 NewJSONHandler創(chuàng)建新的 Logger，來輸出新文本格式和 json 格式。

示例代碼：

func main() {
 logger := slog.New(slog.NewTextHandler(os.Stdout, nil))
 logger.Info("This is a new text Info Level", "uid", 1002)

 jsonLogger := slog.New(slog.NewJSONHandler(os.Stdout, nil))
 jsonLogger.Info("This is a json format Info Level", "uid", 1003)
}

輸出結(jié)果：

time=2023-10-06T12:19:21.676+08:00 level=INFO msg="This is a new text Info Level" uid=1002
{"time":"2023-10-06T12:19:21.676846+08:00","level":"INFO","msg":"This is a json format Info Level","uid":1003}

閱讀上面這段代碼，我們可以發(fā)現(xiàn)通過內(nèi)置 Handler 創(chuàng)建新的 Logger，輸出新的日志格式，其中 NewTextHandler 輸出的所有內(nèi)容都是鍵值對格式，NewJSONHandler 輸出一個 json 對象。

此外，我們還可以自定義 Handler，通過實現(xiàn) slog.Handler 接口，生成特定的輸出日志格式或者 wrap 另一個 Handler 來豐富其功能。

03 、總結(jié)

本文我們介紹 log/slog 的使用方式，包括日志級別和輸出日志格式。

限于篇幅，還有一些進階用法沒有介紹，比如 LogAttrs 函數(shù)，以及 NewTextHandler 和 NewJSONHandler 的方法。