快捷導(dǎo)航

Go語言使用Zap輕松搞定結(jié)構(gòu)化日志

更新時間：2024年11月14日 08:30:34 作者：左詩右碼

在?Go?語言中,有許多日志庫可供選擇,但在性能和靈活性方面,Zap?是其中的佼佼者,下面我們就來看看Go?項目中如何使用?Zap?進(jìn)行結(jié)構(gòu)化日志記錄吧

為什么選擇 Zap？

Zap 是 Uber 開發(fā)的一款高性能日志庫，專為那些需要快速、結(jié)構(gòu)化日志記錄的場景而設(shè)計。與其他日志庫相比，Zap 的性能更為優(yōu)越，尤其是在需要頻繁記錄日志的高并發(fā)環(huán)境中。

此外，Zap 提供了兩種日志記錄接口：Logger 和 SugaredLogger。

Logger 提供了最基礎(chǔ)的、類型安全的結(jié)構(gòu)化日志記錄方式。雖然使用時稍顯復(fù)雜，但在性能上無可匹敵，非常適合對性能有極致要求的場景。
SugaredLogger 則在 Logger 之上進(jìn)行了封裝，提供了更為便捷的日志記錄方法。盡管在性能上稍遜于 Logger，但它的靈活性和易用性使其成為大多數(shù)場景下的首選。

基礎(chǔ)日志記錄示例

為了更好地理解 Zap 的使用，讓我們從一個簡單的例子開始。

package log_demo

import (
	"go.uber.org/zap"
)

var logger *zap.Logger

func InitLogger() {
	// 初始化 Logger，這里我們使用了開發(fā)環(huán)境的配置
	logger, _ = zap.NewDevelopment()
}

func ZapPrintLog() {
	InitLogger()
	defer logger.Sync() // 確保日志緩沖區(qū)中的所有日志都被寫入

	// 記錄一條信息級別的日志，并附帶結(jié)構(gòu)化的鍵值對
	logger.Info("This is a log message", zap.String("key1", "value1"), zap.Float64s("key2", []float64{1.0, 2.0, 3.0}))
}

在這個例子中，我們通過 zap.NewDevelopment() 初始化了一個 Logger，并使用 logger.Info 方法記錄了一條信息級別的日志。zap.String 和 zap.Float64s 是 Zap 提供的用于結(jié)構(gòu)化日志的字段構(gòu)造器，它們將日志內(nèi)容按鍵值對的形式記錄下來。

更便捷的 SugaredLogger

雖然結(jié)構(gòu)化日志非常有用，但有時我們只需要快速記錄一些信息。此時，SugaredLogger 就派上了用場。它支持類似 fmt.Printf 的日志記錄方式，使代碼更加簡潔。

package log_demo

import (
	"go.uber.org/zap"
)

var sugaredLogger *zap.SugaredLogger

func InitLogger() {
	logger, _ := zap.NewDevelopment()
	sugaredLogger = logger.Sugar()
}

func ZapPrintLog1() {
	InitLogger()
	defer sugaredLogger.Sync()

	// 使用 SugaredLogger 記錄日志
	sugaredLogger.Infof("This is a formatted log: %s", "example")
	sugaredLogger.Infow("This is a log message", "key1", "value1", "key2", []float64{1.0, 2.0, 3.0})
}

在上面的代碼中，SugaredLogger 提供了 Infof 和 Infow 方法，前者允許你像使用 fmt.Printf 一樣格式化日志，后者則結(jié)合了結(jié)構(gòu)化日志的優(yōu)點，使日志記錄更加靈活。

自定義日志配置

在實際生產(chǎn)環(huán)境中，我們可能需要對日志輸出進(jìn)行更精細(xì)的控制，比如將日志輸出到文件、控制臺，或者對日志進(jìn)行按大小或時間切割。

Zap 自身不支持日志切割，但我們可以借助第三方庫 lumberjack 來實現(xiàn)這一功能。

package log_demo

import (
	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
	"gopkg.in/natefinch/lumberjack.v2"
)

// InitCustomLogger 初始化一個定制的 Logger
func InitCustomLogger() {
	// 創(chuàng)建一個日志切割器
	writeSyncer := zapcore.AddSync(&lumberjack.Logger{
		Filename:   "zap.log",    // 日志文件路徑
		MaxSize:    10,           // 單個日志文件最大尺寸（MB）
		MaxBackups: 5,            // 最多保留5個備份
		MaxAge:     30,           // 日志保留最長天數(shù)
		Compress:   true,         // 啟用日志壓縮
	})

	// 配置日志編碼器
	encoderConfig := zap.NewProductionEncoderConfig()
	encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder  // 時間格式
	encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder // 日志級別大寫
	encoder := zapcore.NewConsoleEncoder(encoderConfig)

	// 創(chuàng)建 Logger Core
	core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)

	// zap.AddCaller() 會在日志中加入調(diào)用函數(shù)的文件名和行號
	// zap.AddCallerSkip(1) 會跳過調(diào)用函數(shù)的文件名和行號
	// 當(dāng)我們不是直接使用初始化好的logger實例記錄日志，而是將其包裝成一個函數(shù)等，此時日錄日志的函數(shù)調(diào)用鏈會增加，想要獲得準(zhǔn)確的調(diào)用信息就需要通過AddCallerSkip函數(shù)來跳過
	logger = zap.New(core, zap.AddCaller(), zap.AddCallerSkip(1))
}

func ZapPrintLog2() {
	InitCustomLogger()
	defer logger.Sync()

	logger.Debug("This is a custom log message", zap.String("key1", "value1"), zap.Float64s("key2", []float64{1.0, 2.0, 3.0}))
}

在這個示例中，我們通過 lumberjack.Logger 實現(xiàn)了日志文件的自動切割與管理。zapcore.NewConsoleEncoder 配置了日志的編碼格式，確保日志輸出不僅有結(jié)構(gòu)化的信息，還帶有清晰的時間戳和日志級別標(biāo)識。此外，我們使用了 zap.AddCaller() 和 zap.AddCallerSkip(1)，這兩個函數(shù)可以在日志中添加調(diào)用函數(shù)的文件名和行號，幫助我們更快地定位日志來源。

應(yīng)用場景示例：記錄調(diào)試信息

假設(shè)我們在開發(fā)一個 web 應(yīng)用時需要記錄一些調(diào)試信息。此時，使用我們之前定義的 InitCustomLogger 函數(shù)可以非常方便地記錄這些信息。

func main() {
    ZapPrintLog2() // 調(diào)用定制的日志打印函數(shù)

    // 假設(shè)這里有其他業(yè)務(wù)邏輯
    for i := 0; i < 3; i++ {
        logger.Info("Processing iteration", zap.Int("iteration", i))
    }
}

在這個簡短的示例中，logger.Info 會在每次循環(huán)中記錄當(dāng)前迭代次數(shù)，并將日志輸出到指定的日志文件中。