Go 日志封裝實戰(zhàn)示例詳解
背景
日志是框架中至關重要的一部分。在 Golang 只也提供了基本的日志組件,但其沒有提供給比較多的功能。當然現(xiàn)在也有很多第三方已經封裝好的庫使用起來也很方便。作為成熟的開發(fā)者也應該學會封裝自己的類庫,以便后續(xù)在自己的個人項目中使用它。
Logger 封裝的理解
Logger 庫主要是一系列方法或接口,提供給應用程序代碼調用然后將相關的數(shù)據(jù)記錄到日志記錄庫中。就是在代碼和底層日志庫中間的一層。需要實現(xiàn)的功能是能夠記錄日志,且支持不同日志記錄庫的切換或添加新的記錄庫。
封裝包,首先需要先定義一些能夠描述日志方法的接口,基本的都是你的應用程序所需要的方法。比如,基本的日志接口基本的方法有 Info、Warn、 Error。然后就可以創(chuàng)建此接口的實現(xiàn),將數(shù)據(jù)記錄到記錄庫中。定義了接口和實現(xiàn),就可以創(chuàng)建一個 logger 封裝,并將相關的接口方法公開。
簡單包封裝
以下定義了五個方法:Info, Warn, Error 和 Fatal. 這些方法接口接收 2個參數(shù),一個字符串和一個字段映射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{})
}
接下來就是實現(xiàn)啦 Logger 方法,底層的實現(xiàn)主要是依賴使用 Logrus。首先需要創(chuàng)建一個 LLogger 結構體,該結構體包含 Logrus 實例。當然還需要一個 NewLLogger 方法來實例化一個 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)
}
這樣一個簡單日志封裝就完成了,使用時就可以直接使用。
func main() {
ctx := ... // context 信息
lg := NewLLogger(ctx)
fields := map[string]interface{}{
"userId": "xiaoxiong",
"ipAddress": "127.0.0.1",
}
lg.Info("這是測試信息", fields)
}
多日志庫切換
當?shù)讓有枰褂玫氖遣煌娜罩編爝M行記錄日志時,那就需要封裝另外的日志,但是在實例化方法時可以增加一種日志類型參數(shù),然后根據(jù)不同的類型實例化不同的日志。
比如使用了zap 包,那童養(yǎng)媳與奧實現(xiàn)接口的四個方法 :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))
}
定義其他日志庫的方法后就只需對這個兩個日志庫進行封裝,根據(jù)不同的類型初始化出不同的日志,然后使用日志時候就使用相應的包進行處理。
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 上下文的內容,主要是為了記錄一些公共屬性。就像經常在鏈路追蹤時可需要請求ID ,請求IP 等相關的信息。但是日志實例都是在程序啟動時進行初始化的,在每次的請求時可能請求ID或者IP 都是不一樣,所以要記錄這部分信息,可以使用中間件將上下文的信息添加到日志消息中。
以上就是Go 日志封裝實戰(zhàn)示例詳解的詳細內容,更多關于Go 日志封裝的資料請關注腳本之家其它相關文章!
相關文章
GO 使用Webhook 實現(xiàn)github 自動化部署的方法
這篇文章主要介紹了GO 使用Webhook 實現(xiàn)github 自動化部署的方法,本文通過實例代碼給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-05-05
詳解golang 定時任務time.Sleep和time.Tick實現(xiàn)結果比較
本文主要介紹了golang 定時任務time.Sleep和time.Tick實現(xiàn)結果比較,文中通過示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下2022-02-02

