快捷導(dǎo)航

Go 日志封裝實(shí)戰(zhàn)示例詳解

更新時(shí)間：2023年04月17日 10:40:08 作者：小雄Ya

這篇文章主要為大家介紹了Go 日志封裝實(shí)戰(zhàn)示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

背景

日志是框架中至關(guān)重要的一部分。在 Golang 只也提供了基本的日志組件，但其沒(méi)有提供給比較多的功能。當(dāng)然現(xiàn)在也有很多第三方已經(jīng)封裝好的庫(kù)使用起來(lái)也很方便。作為成熟的開(kāi)發(fā)者也應(yīng)該學(xué)會(huì)封裝自己的類庫(kù)，以便后續(xù)在自己的個(gè)人項(xiàng)目中使用它。

Logger 封裝的理解

Logger 庫(kù)主要是一系列方法或接口，提供給應(yīng)用程序代碼調(diào)用然后將相關(guān)的數(shù)據(jù)記錄到日志記錄庫(kù)中。就是在代碼和底層日志庫(kù)中間的一層。需要實(shí)現(xiàn)的功能是能夠記錄日志，且支持不同日志記錄庫(kù)的切換或添加新的記錄庫(kù)。

封裝包，首先需要先定義一些能夠描述日志方法的接口，基本的都是你的應(yīng)用程序所需要的方法。比如，基本的日志接口基本的方法有 Info、Warn、 Error。然后就可以創(chuàng)建此接口的實(shí)現(xiàn)，將數(shù)據(jù)記錄到記錄庫(kù)中。定義了接口和實(shí)現(xiàn)，就可以創(chuàng)建一個(gè) logger 封裝，并將相關(guān)的接口方法公開(kāi)。

簡(jiǎn)單包封裝

以下定義了五個(gè)方法：Info, Warn, Error 和 Fatal. 這些方法接口接收 2個(gè)參數(shù)，一個(gè)字符串和一個(gè)字段映射map.

type Logger interface {
	Debug(msg string, field map[string]interface{})
	Info(msg string, field map[string]interface{})
	Warn(msg string, field map[string]interface{})
	Error(msg string, field map[string]interface{})
	Fatal(msg string, field map[string]interface{})
}

接下來(lái)就是實(shí)現(xiàn)啦 Logger 方法，底層的實(shí)現(xiàn)主要是依賴使用 Logrus。首先需要?jiǎng)?chuàng)建一個(gè) LLogger 結(jié)構(gòu)體，該結(jié)構(gòu)體包含 Logrus 實(shí)例。當(dāng)然還需要一個(gè) NewLLogger 方法來(lái)實(shí)例化一個(gè) LLogger。

type LLogger struct {
	logger *logrus.Logger
	ctx    context.Context
}
func NewLLogger(ctx context.Context) *LLogger {
	logger := logrus.New()
	logger.Out = os.Stdout
	return &LLogger{logger: logger, ctx: ctx}
}
func (l *LLogger) Info(msg string, fields map[string]interface{}) {
	l.logger.WithFields(fields).Info(msg)
}
func (l *LLogger) Warn(msg string, fields map[string]interface{}) {
	l.logger.WithFields(fields).Warn(msg)
}
func (l *LLogger) Error(msg string, fields map[string]interface{}) {
	l.logger.WithFields(fields).Error(msg)
}
func (l *LLogger) Fatal(msg string, fields map[string]interface{}) {
	l.logger.WithFields(fields).Fatal(msg)
}

這樣一個(gè)簡(jiǎn)單日志封裝就完成了，使用時(shí)就可以直接使用。

func main() {
	ctx := ... // context 信息
	lg := NewLLogger(ctx)
	fields := map[string]interface{}{
		"userId":    "xiaoxiong",
		"ipAddress": "127.0.0.1",
	}
	lg.Info("這是測(cè)試信息", fields)
}

多日志庫(kù)切換

當(dāng)?shù)讓有枰褂玫氖遣煌娜罩編?kù)進(jìn)行記錄日志時(shí)，那就需要封裝另外的日志，但是在實(shí)例化方法時(shí)可以增加一種日志類型參數(shù)，然后根據(jù)不同的類型實(shí)例化不同的日志。

比如使用了zap 包，那童養(yǎng)媳與奧實(shí)現(xiàn)接口的四個(gè)方法：Info, Warn, Error and Fatal.

type ZapLog struct {
	logger *zap.Logger
	ctx    context.Context
}
func NewZapLog(ctx context.Context) *ZapLog {
	logger, _ := zap.NewProduction()
	return &ZapLog{logger: logger, ctx: ctx}
}
func (l *ZapLog) Info(msg string, fields map[string]interface{}) {
	l.logger.Info(msg, zap.Any("args", fields))
}
func (l *ZapLog) Warn(msg string, fields map[string]interface{}) {
	l.logger.Warn(msg, zap.Any("args", fields))
}
func (l *ZapLog) Error(msg string, fields map[string]interface{}) {
	l.logger.Error(msg, zap.Any("args", fields))
}
func (l *ZapLog) Fatal(msg string, fields map[string]interface{}) {
	l.logger.Fatal(msg, zap.Any("args", fields))
}

定義其他日志庫(kù)的方法后就只需對(duì)這個(gè)兩個(gè)日志庫(kù)進(jìn)行封裝，根據(jù)不同的類型初始化出不同的日志，然后使用日志時(shí)候就使用相應(yīng)的包進(jìn)行處理。

type LoggerWrapper struct {
	logger Logger
}
func NewLoggerWrapper(loggerType string, ctx context.Context) *LoggerWrapper {
	var logger Logger
	switch loggerType {
	case "logrus":
		logger = NewLLogger(ctx)
	case "zap":
		logger = NewZapLog(ctx)
	default:
		logger = NewLLogger(ctx)
	}
	return &LoggerWrapper{logger: logger}
}

使用中間件記錄公共信息

封裝中增加了 Context 上下文的內(nèi)容，主要是為了記錄一些公共屬性。就像經(jīng)常在鏈路追蹤時(shí)可需要請(qǐng)求ID ，請(qǐng)求IP 等相關(guān)的信息。但是日志實(shí)例都是在程序啟動(dòng)時(shí)進(jìn)行初始化的，在每次的請(qǐng)求時(shí)可能請(qǐng)求ID或者IP 都是不一樣，所以要記錄這部分信息，可以使用中間件將上下文的信息添加到日志消息中。

以上就是Go 日志封裝實(shí)戰(zhàn)示例詳解的詳細(xì)內(nèi)容，更多關(guān)于Go 日志封裝的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: