本篇內容主要講解“Golang定制化zap日志庫如何使用”，感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷，實用性強。下面就讓小編來帶大家學習“Golang定制化zap日志庫如何使用”吧!
一個產品的誕生一定是因為有需求！新技術大部分都是為了更加便利和實用而誕生的，日志也不例外。日志顧名思義就是對整個項目的事件進行記錄。日志可以幫助我們查看某一天中某一時刻項目的運轉情況等等。
在日常開發過程中難免會遇到BUG出現的情況，日志可以記錄這些BUG出現的地點從而方便進行快速定位和排查?？梢愿鶕枨髮θ罩具M行自定義的輸出，比如輸出到控制臺、文件等。日志也可以幫助我們在開發過程中檢測到程序潛在的問題和程序運行的流程，能夠有效的提高我們的開發效率。
要讓程序記錄有效的，便利的日志。** Logger (日志記錄器) 應該具備以下特點**：
可以將日志信息輸出到控制臺、文件等地方，輸出到文件便于項目長久運行，輸出到控制臺有助于開發過程中檢錯的效率。
一個日志應該具有多個基本的級別，比如info，debug，warn，error，fatal等，他們可以對日志進行分類。
可以對日志進行切割，按照日志大小、日期、時間間隔等因素分割。
可以手動或自動記錄一些開發信息。如前端傳入的數據，異常錯誤信息，程序運行結果，錯誤行數，日志打印位置等等信息進行打印。
Go語言中默認集成了一個log日志庫
func New(out io.Writer, prefix string, flag int) *Logger {
l := &Logger{out: out, prefix: prefix, flag: flag}
if out == io.Discard {
l.isDiscard = 1
}
return l
}使用New可以獲取到該日志對象。第一個參數為實現了Writer接口的對象?？梢允褂?code>os.OpenFile()選擇一個文件，然后將該文件對象作為輸出，也可以使用os.Stdout或os.Stderr輸出到控制臺。第二個參數需要傳入一個日志信息每一行的前綴(如果輸出到控制臺該處可以填空字符串)。第三個參數是設置打印默認信息的能力，比如打印時間等。
var l *log.Logger
func main() {
l.Printf("main method exec fail, err: %v", errors.New("nil Pointer error"))
l.Println("test go log status")
l.Fatal("wait five seconds")
time.Sleep(time.Second * 5)
l.Println("five seconds after!")
}
func init() {
l = log.New(os.Stdout, "[我是一個前綴]", log.LstdFlags)
}[我是一個前綴]2023/02/10 21:15:22 main method exec fail, err: nil Pointer error
[我是一個前綴]2023/02/10 21:15:22 test go log status
[我是一個前綴]2023/02/10 21:15:22 wait five seconds
// Fatal is equivalent to l.Print() followed by a call to os.Exit(1).
func (l *Logger) Fatal(v ...any) {
l.Output(2, fmt.Sprint(v...))
os.Exit(1)
}在Fatal之后的程序均不會執行，因為Fatal執行后會在內部調用os.Exit(1)，從而在打印結束后退出進程。
日志級別只支持Fatal，只有一個Print函數，沒有其他級別
日志自定義參數過少，無法打印棧信息，無法確定請求位置等
Fatal和Painc都是執行后退出，無法容忍錯誤情況的出現就會退出程序
無法指定輸出格式，只能以文本形式進行輸出，沒有根據日志大小、時間間隔、日期進行分割的能力
雖然gologger支持并發，但也只限于簡單用著還行，實際開發用起來并不舒服的情況。
go get -u go.uber.org/zap
zap日志庫是Uber開源的。性能很好，因為不用反射實現，但需要自己去手動指明打印信息的類型（下面會有示例）。個人覺得自己指定打印還是挺舒服的。zap的使用率非常高，不僅支持日志庫的基本功能，而且很靈活的支持你去進一步的封裝或者定制化。zap支持異步打印。
func NewDevelopmentEncoderConfig() zapcore.EncoderConfig
func NewProductionEncoderConfig() zapcore.EncoderConfig
func NewProductionConfig() Config
func NewDevelopmentConfig() Config
這里可以根據實際生產和測試環境需求進行選擇，也可以直接使用其他初始化方式。
// NewProductionEncoderConfig returns an opinionated EncoderConfig for
// production environments.
func NewProductionEncoderConfig() zapcore.EncoderConfig {
return zapcore.EncoderConfig{
// 設置log內容里的一些屬性的key
TimeKey: "ts",//時間對應的key名
LevelKey: "level",//日志級別對應的key名
NameKey: "logger",//logger名對應的key名
CallerKey: "caller",//調用者對應的key名
FunctionKey: zapcore.OmitKey,
MessageKey: "msg",//日志內容對應的key名，此參數必須不為空，否則日志主體不處理
StacktraceKey: "stacktrace",//棧追蹤的key名
// const DefaultLineEnding = "\n" 行末輸出格式
LineEnding: zapcore.DefaultLineEnding,
// 日志編碼級別
EncodeLevel: zapcore.LowercaseLevelEncoder,
// 日志時間解析
EncodeTime: zapcore.EpochTimeEncoder,
// 日志日期解析
EncodeDuration: zapcore.SecondsDurationEncoder,
// 日志調用路徑
EncodeCaller: zapcore.ShortCallerEncoder,
}
}使用NewProductionEncoderConfig()創建的 Logger 在記錄日志時會自動記錄調用函數的信息、打日志的時間，日志級別等信息。
// A LevelEncoder serializes a Level to a primitive type. type LevelEncoder func(Level, PrimitiveArrayEncoder) // 將日志級別進行大寫并帶上顏色 func CapitalColorLevelEncoder(l Level, enc PrimitiveArrayEncoder) // 將日志級別大寫不帶顏色 func CapitalLevelEncoder(l Level, enc PrimitiveArrayEncoder) // 將日志級別小寫帶上顏色 func LowercaseColorLevelEncoder(l Level, enc PrimitiveArrayEncoder) // 將日志級別小寫不帶顏色 func LowercaseLevelEncoder(l Level, enc PrimitiveArrayEncoder)
需要實現LevelEncoder接口?？梢哉{整日志編碼級別，并且選擇帶上或者不帶輸出顏色。
// A TimeEncoder serializes a time.Time to a primitive type. type TimeEncoder func(time.Time, PrimitiveArrayEncoder) // 根據不同時間進行格式化 func EpochTimeEncoder(t time.Time, enc PrimitiveArrayEncoder) func EpochMillisTimeEncoder(t time.Time, enc PrimitiveArrayEncoder) func EpochNanosTimeEncoder(t time.Time, enc PrimitiveArrayEncoder)
定制化時間格式解析，需要實現TimeEncoder接口。
// A DurationEncoder serializes a time.Duration to a primitive type. type DurationEncoder func(time.Duration, PrimitiveArrayEncoder) // 將日期根據不同時間進行格式化 func SecondsDurationEncoder(d time.Duration, enc PrimitiveArrayEncoder) func NanosDurationEncoder(d time.Duration, enc PrimitiveArrayEncoder) func MillisDurationEncoder(d time.Duration, enc PrimitiveArrayEncoder) func StringDurationEncoder(d time.Duration, enc PrimitiveArrayEncoder)
定制日期格式解析。需要實現DruationEncoder接口
encoderConfig := zap.NewProductionEncoderConfig() // 打印級別為大寫 & 彩色 encoderConfig.EncodeLevel = zapcore.CapitalColorLevelEncoder // 時間編碼進行指定格式解析 layout -> "[2006-01-02 15:04:05]" encoderConfig.EncodeTime = parseTime(settings.Conf.Layout)
修改日志打印級別和時間編碼格式
// parseTime 進行時間格式處理
func parseTime(layout string) zapcore.TimeEncoder {
return func(t time.Time, enc zapcore.PrimitiveArrayEncoder) {
type appendTimeEncoder interface {
AppendTimeLayout(time.Time, string)
}
if enc, ok := enc.(appendTimeEncoder); ok {
enc.AppendTimeLayout(t, layout)
return
}
enc.AppendString(t.Format(layout))
}
}實現zapcore.TimeEncoder接口，將指定的Layout參數進行傳入實現閉包即可。
// 日志輸出配置, 借助另外一個庫 lumberjack 協助完成日志切割。
lumberjackLogger := &lumberjack.Logger{
Filename: settings.Conf.Filename, // -- 日志文件名
MaxSize: settings.Conf.MaxSize, // -- 最大日志數 M為單位!!!
MaxAge: settings.Conf.MaxAge, // -- 最大存在天數
MaxBackups: settings.Conf.MaxBackups, // -- 最大備份數量
Compress: false, // --是否壓縮
}
syncer := zapcore.AddSync(lumberjackLogger)zap日志本身不支持日志切割，借助另外一個庫 lumberjack 協助完成日志切割。
// -- 用于開發者模式和生產模式之間的切換
var core zapcore.Core
if settings.Conf.AppConfig.Mode == "debug" {
encoder := zapcore.NewConsoleEncoder(encoderConfig) // 輸出控制臺編碼格式
core = zapcore.NewTee(
zapcore.NewCore(encoder, syncer, zapcore.DebugLevel), // debug級別打印到日志文件
zapcore.NewCore(encoder, zapcore.Lock(os.Stdout), zapcore.DebugLevel), // debug級別打印到控制臺
)
} else {
encoder := zapcore.NewJSONEncoder(encoderConfig)// 輸出Json格式，便于日志檢索
core = zapcore.NewCore(encoder, syncer, zapcore.InfoLevel)// info級別打印到日志文件
}
lg := zap.New(core, zap.AddCaller()) // --添加函數調用信息根據配置信息去選擇具體打印需求。
zap.ReplaceGlobals(lg) // 替換該日志為全局日志
var (
_globalMu sync.RWMutex
_globalL = NewNop()
)
// L returns the global Logger, which can be reconfigured with ReplaceGlobals.
// It's safe for concurrent use.
func L() *Logger {
_globalMu.RLock()
l := _globalL
_globalMu.RUnlock()
return l
}設置該日志為全局日志，將原日志進行替換，即可在任意位置使用zap.L()調用該日志。
// init 初始化日志庫
func init() {
encoderConfig := zap.NewProductionEncoderConfig()
// 打印級別為大寫 & 彩色
encoderConfig.EncodeLevel = zapcore.CapitalColorLevelEncoder
// 時間編碼進行指定格式解析
encoderConfig.EncodeTime = parseTime(settings.Conf.Layout)
// 日志輸出配置, 借助另外一個庫 lumberjack 協助完成日志切割。
lumberjackLogger := &lumberjack.Logger{
Filename: settings.Conf.Filename, // -- 日志文件名
MaxSize: settings.Conf.MaxSize, // -- 最大日志數 M為單位!!!
MaxAge: settings.Conf.MaxAge, // -- 最大存在天數
MaxBackups: settings.Conf.MaxBackups, // -- 最大備份數量
Compress: false, // --是否壓縮
}
syncer := zapcore.AddSync(lumberjackLogger)
// -- 用于開發者模式和生產模式之間的切換
var core zapcore.Core
if settings.Conf.AppConfig.Mode == "debug" {
encoder := zapcore.NewConsoleEncoder(encoderConfig)
core = zapcore.NewTee(
zapcore.NewCore(encoder, syncer, zapcore.DebugLevel),
zapcore.NewCore(encoder, zapcore.Lock(os.Stdout), zapcore.DebugLevel),
)
} else {
encoder := zapcore.NewJSONEncoder(encoderConfig)
core = zapcore.NewCore(encoder, syncer, zapcore.InfoLevel)
}
lg := zap.New(core, zap.AddCaller()) // --添加函數調用信息
zap.ReplaceGlobals(lg) // 替換該日志為全局日志
}
// parseTime 進行時間格式處理
func parseTime(layout string) zapcore.TimeEncoder {
return func(t time.Time, enc zapcore.PrimitiveArrayEncoder) {
type appendTimeEncoder interface {
AppendTimeLayout(time.Time, string)
}
if enc, ok := enc.(appendTimeEncoder); ok {
enc.AppendTimeLayout(t, layout)
return
}
enc.AppendString(t.Format(layout))
}
}zap.L().Info("test info", zap.String("test String", "ok"), zap.Int("test cnt", 1))
zap.L().Debug("test debug", zap.String("test String", "ok"), zap.Int("test cnt", 2))
zap.L().Error("test error", zap.String("test String", "ok"), zap.Int("test cnt", 3))[2023-02-10 22:22:17] INFO xxxxx/main.go:22 test info {“test String”: “ok”, “test cnt”: 1}
[2023-02-10 22:22:17] DEBUG xxxxx/main.go:23 test debug {“test String”: “ok”, “test cnt”: 2}
[2023-02-10 22:22:17] ERROR xxxxx/main.go:24 test error {“test String”: “ok”, “test cnt”: 3}
這里就是上述所說的自指定類型進行輸出的情況。
雖然gin框架有自帶的logger中間件，但我們可以根據gin框架實現的原生日志和異?；謴椭虚g件進行改造并進行替換。
Loger
// GinLogger 替換gin中默認的logger
func GinLogger() gin.HandlerFunc {
return func(c *gin.Context) {
start := time.Now()
path := c.Request.URL.Path
query := c.Request.URL.RawQuery
c.Next()
cost := time.Since(start)
if c.Writer.Status() != http.StatusOK {
// 記錄異常信息
zap.L().Error(query,
zap.Int("status", c.Writer.Status()),
zap.String("method", c.Request.Method),
zap.String("path", path),
zap.String("ip", c.ClientIP()),
zap.String("user-agent", c.Request.UserAgent()),
zap.String("errors", c.Errors.ByType(gin.ErrorTypePrivate).String()),
zap.Duration("cost", cost),
)
}
}如果有錯誤請求，只要不是狀態碼為200的全部進行打印->狀態碼、請求方法（get、post…）、路徑、ip、用戶授權方、錯誤信息、請求花費時間。
// GinRecovery recover掉項目可能出現的panic
func GinRecovery(stack bool) gin.HandlerFunc {
return func(c *gin.Context) {
defer func() {
if err := recover(); err != nil {
// Check for a broken connection, as it is not really a
// condition that warrants a panic stack trace.
var brokenPipe bool
if ne, ok := err.(*net.OpError); ok {
if se, ok := ne.Err.(*os.SyscallError); ok {
if strings.Contains(strings.ToLower(se.Error()), "broken pipe") ||
strings.Contains(strings.ToLower(se.Error()), "connection reset by peer") {
brokenPipe = true
}
}
}
httpRequest, _ := httputil.DumpRequest(c.Request, false)
if brokenPipe {
zap.L().Error(c.Request.URL.Path,
zap.Any("error", err),
zap.String("httpRequest", string(httpRequest)),
)
// If the connection is dead, we can't write a status to it.
c.Error(err.(error)) // nolint: errcheck
c.Abort()
return
}
// 這里可以選擇全部打印出來不必要分割然后循環輸出
request := strings.Split(string(httpRequest), "\r\n")
split := strings.Split(string(debug.Stack()), "\n\t")
if stack {
zap.L().Error("[Recovery from panic]",
zap.Any("error", err))
for _, str := range request {
zap.L().Error("[Recovery from request panic]", zap.String("request", str))
}
for _, str := range split {
zap.L().Error("[Recovery from Stack panic]", zap.String("stack", str))
}
} else {
zap.L().Error("[Recovery from panic]",
zap.Any("error", err))
for _, str := range request {
zap.L().Error("[Recovery from request panic]", zap.String("request", str))
}
}
c.AbortWithStatus(http.StatusInternalServerError)
}
}()
c.Next()
}
}這里在Panic的時候我采用了分割循環打印的方法，也可以全部輸出，但是一堆異常情況，不容易看清楚。也可以選擇不打印棧軌跡輸出，只需要在使用recover中間件時傳入false參數即可。
到此，相信大家對“Golang定制化zap日志庫如何使用”有了更深的了解，不妨來實際操作一番吧！這里是億速云網站，更多相關內容可以進入相關頻道進行查詢，關注我們，繼續學習！
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
