golang有用的庫及工具 之 zap.Logger包的使用指南
更新時間：2020年12月16日 12:04:30 作者：逆月林
這篇文章主要介紹了golang有用的庫及工具 之 zap.Logger包的使用指南，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧
zap.Logger 是go語言中相對日志庫中性能最高的。那么如何開始使用？
不多說直接上代碼：
import (
"encoding/json"
"fmt"
"log"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
)
var Logger *zap.Logger
func InitLogger() {
// 日志地址 "out.log" 自定義
lp := Conf.Common.LogPath
// 日志級別 DEBUG,ERROR, INFO
lv := Conf.Common.LogLevel
// 是否 DEBUG
isDebug := true
if Conf.Common.IsDebug != true {
isDebug = false
}
initLogger(lp, lv, isDebug)
log.SetFlags(log.Lmicroseconds | log.Lshortfile | log.LstdFlags)
}
func initLogger(lp string, lv string, isDebug bool) {
var js string
if isDebug {
js = fmt.Sprintf(`{
"level": "%s",
"encoding": "json",
"outputPaths": ["stdout"],
"errorOutputPaths": ["stdout"]
}`, lv)
} else {
js = fmt.Sprintf(`{
"level": "%s",
"encoding": "json",
"outputPaths": ["%s"],
"errorOutputPaths": ["%s"]
}`, lv, lp, lp)
}
var cfg zap.Config
if err := json.Unmarshal([]byte(js), &cfg); err != nil {
panic(err)
}
cfg.EncoderConfig = zap.NewProductionEncoderConfig()
cfg.EncoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
var err error
Logger, err = cfg.Build()
if err != nil {
log.Fatal("init logger error: ", err)
}
}
如何使用：
func TestInitLogger(t *testing.T) {
InitLogger("out.log", "DEBUG", false)
s := []string{
"hello info",
"hello error",
"hello debug",
"hello fatal",
}
Log.Info("info:", zap.String("s", s[0]))
Log.Error("info:", zap.String("s", s[1]))
Log.Debug("info:", zap.String("s", s[2]))
Log.Fatal("info:", zap.String("s", s[3]))
}
輸出：
{"level":"info","ts":"2017-10-25 13:45:42.332","caller":"logger/logger_test.go:16","msg":"info:","s":"hello info"}
{"level":"error","ts":"2017-10-25 13:45:42.396","caller":"logger/logger_test.go:17","msg":"info:","s":"hello error","stacktrace":"go.uber.org/zap.Stack\n\tD:/gopath/src/go.uber.org/zap/field.go:191\ngo.uber.org/zap.(*Logger).check\n\tD:/gopath/src/go.uber.org/zap/logger.go:301\ngo.uber.org/zap.(*Logger).Error\n\tD:/gopath/src/go.uber.org/zap/logger.go:202\ngithub.com/corego/hermes/logger.TestInitLogger\n\tD:/gopath/src/github.com/corego/hermes/logger/logger_test.go:17\ntesting.tRunner\n\tD:/Program Files (x86)/go/src/testing/testing.go:746"}
{"level":"debug","ts":"2017-10-25 13:45:42.396","caller":"logger/logger_test.go:18","msg":"info:","s":"hello debug"}
{"level":"fatal","ts":"2017-10-25 13:45:42.396","caller":"logger/logger_test.go:19","msg":"info:","s":"hello fatal","stacktrace":"go.uber.org/zap.Stack\n\tD:/gopath/src/go.uber.org/zap/field.go:191\ngo.uber.org/zap.(*Logger).check\n\tD:/gopath/src/go.uber.org/zap/logger.go:301\ngo.uber.org/zap.(*Logger).Fatal\n\tD:/gopath/src/go.uber.org/zap/logger.go:235\ngithub.com/corego/hermes/logger.TestInitLogger\n\tD:/gopath/src/github.com/corego/hermes/logger/logger_test.go:19\ntesting.tRunner\n\tD:/Program Files (x86)/go/src/testing/testing.go:746"}
拓展：Golang成長之路：使用Zap來做日志服務(wù)
我們在項目中，經(jīng)常會記錄一些數(shù)據(jù)信息到文件中，或者日志文件。
例如nginx會有nginx訪問請求日志，使用golang的時候，我也想做一個這樣的訪問日志，所以我就找到了go的一個開源高效的日志庫zap。
很多人也使用logrus或者go自帶的Logger(支持的東西太少，性能一般)，具體為啥最后選擇了zap，是因為很多人說zap性能更高些，當然我自己沒有測試過。
1、安裝zap
go get -u go.uber.org/zap
如果沒反應(yīng)，可能需要配置下代理，
go env -w GOPROXY=https://goproxy.cn
然后在執(zhí)行安裝的命令。
2、簡單實例（默認配置）
Zap提供了兩種類型的日志記錄器—Sugared Logger和Logger。
package main
import (
"go.uber.org/zap"
"time"
)
func main() {
// zap.NewDevelopment 格式化輸出
logger, _ := zap.NewDevelopment()
defer logger.Sync()
logger.Info("測試",
zap.String("url", "http://www.baidu.com"),
zap.Int("attempt", 3),
zap.Duration("backoff", time.Second),
)
// zap.NewProduction json序列化輸出
logger, _ := zap.NewProduction()
defer logger.Sync()
logger.Info("測試",
zap.String("url", "http://www.baidu.com"),
zap.Int("attempt", 3),
zap.Duration("backoff", time.Second),
)
}
3、自定義配置
封裝好一個logger包
package logger
import (
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"time"
"fmt"
)
var sugarLogger *zap.SugaredLogger
//格式化日期
func formatEncodeTime(t time.Time, enc zapcore.PrimitiveArrayEncoder) {
enc.AppendString(fmt.Sprintf("%d-%02d-%02d %02d:%02d:%02d", t.Year(), t.Month(), t.Day(), t.Hour(), t.Minute(), t.Second()))
}
func InitConfig() *zap.SugaredLogger {
encoderConfig := zapcore.EncoderConfig{
TimeKey: "ts",
LevelKey: "level",
NameKey: "logger",
CallerKey: "caller",
MessageKey: "msg",
StacktraceKey: "stacktrace",
LineEnding: zapcore.DefaultLineEnding,
EncodeLevel: zapcore.LowercaseLevelEncoder, // 小寫編碼器
EncodeTime: formatEncodeTime, //時間格式
EncodeDuration: zapcore.SecondsDurationEncoder,
EncodeCaller: zapcore.FullCallerEncoder, // 全路徑編碼器
}
// 設(shè)置日志級別（默認info級別，可以根據(jù)需要設(shè)置級別）
atom := zap.NewAtomicLevelAt(zap.InfoLevel)
config := zap.Config{
Level: atom, // 日志級別
Development: true, // 開發(fā)模式，堆棧跟蹤
Encoding: "json", // 輸出格式 console 或 json
EncoderConfig: encoderConfig, // 編碼器配置
OutputPaths: []string{"stdout", '需要寫入文件的路徑'}, // 日志寫入文件的地址
ErrorOutputPaths: []string{"stderr", '需要寫入文件的路徑'}, // 將系統(tǒng)內(nèi)的error記錄到文件的地址
}
// 構(gòu)建日志
logger, _ := config.Build()
sugarLogger = logger.Sugar()
return sugarLogger
}
func Debug(args ...interface{}) {
sugarLogger.Debug(args...)
}
func Debugf(template string, args ...interface{}) {
sugarLogger.Debugf(template, args...)
}
func Info(args ...interface{}) {
sugarLogger.Info(args...)
}
func Infof(template string, args ...interface{}) {
sugarLogger.Infof(template, args...)
}
func Infow(template string, args ...interface{}) {
sugarLogger.Infow(template, args...)
}
func Warn(args ...interface{}) {
sugarLogger.Warn(args...)
}
func Warnf(template string, args ...interface{}) {
sugarLogger.Warnf(template, args...)
}
func Error(args ...interface{}) {
sugarLogger.Error(args...)
}
func Errorf(template string, args ...interface{}) {
sugarLogger.Errorf(template, args...)
}
func DPanic(args ...interface{}) {
sugarLogger.DPanic(args...)
}
func DPanicf(template string, args ...interface{}) {
sugarLogger.DPanicf(template, args...)
}
func Panic(args ...interface{}) {
sugarLogger.Panic(args...)
}
func Panicf(template string, args ...interface{}) {
sugarLogger.Panicf(template, args...)
}
func Fatal(args ...interface{}) {
sugarLogger.Fatal(args...)
}
func Fatalf(template string, args ...interface{}) {
sugarLogger.Fatalf(template, args...)
}
EncoderConfig配置說明
MessageKey：輸入信息的key名
LevelKey：輸出日志級別的key名
TimeKey：輸出時間的key名
NameKey CallerKey StacktraceKey跟以上類似，看名字就知道
LineEnding：每行的分隔符?；緕apcore.DefaultLineEnding 即"\n"
EncodeLevel：基本zapcore.LowercaseLevelEncoder。將日志級別字符串轉(zhuǎn)化為小寫
EncodeTime：輸出的時間格式
EncodeDuration：一般zapcore.SecondsDurationEncoder,執(zhí)行消耗的時間轉(zhuǎn)化成浮點型的秒
EncodeCaller：一般zapcore.ShortCallerEncoder，以包/文件:行號 格式化調(diào)用堆棧
EncodeName：可選值。
使用案例
package main
import (
"logger"http://導(dǎo)入寫好的包（具體需要改為自己寫的路徑）
)
func main() {
//初始化日志配置
logger.InitConfig()
//寫入文件
logger.Infow("access_log",
"code", 200,
"ip", 192.168.1.1,
"Method", "POST",
"url", "www.baidu.com",
"latencyTime(ms)", 1000,
)
}
好了，這就是自己搗鼓的zap使用方法，希望能給大家一個參考，也希望大家多多支持腳本之家。如有錯誤或未考慮完全的地方，望不吝賜教。
相關(guān)文章
大家都知道如何在goland調(diào)試遠程代碼嗎？今天小編給大家分享一篇教程幫助大家學(xué)習(xí)goland調(diào)試遠程代碼的操作步驟，感興趣的朋友跟隨小編一起看看吧2021-06-06
本文詳細介紹了Go語言中strings包的基本使用方法,包括字符串的前綴、后綴判斷,字符串包含、索引查找、字符串替換、計數(shù)、重復(fù)、大小寫轉(zhuǎn)換、修剪、分割、拼接以及數(shù)據(jù)類型轉(zhuǎn)換等功能,示例代碼豐富,適合初學(xué)者和需要使用字符串處理功能的開發(fā)者參考學(xué)習(xí)2024-10-10
本文主要介紹了Go項目在GoLand中導(dǎo)入依賴標紅問題解決,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2024-08-08
深入理解Go語言設(shè)計模式之函數(shù)式選項模式
在 Go 語言中，函數(shù)選項模式（Function Options Pattern）是一種常見且強大的設(shè)計模式，用于構(gòu)建可擴展、易于使用和靈活的 API,本文就來看看它的具體用法吧2023-05-05
這篇文章主要介紹了golang移除數(shù)組中重復(fù)的元素操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12
這篇文章主要為大家介紹了Go語言單元測試模擬服務(wù)請求和接口返回示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-06-06
對于無類型常量，可能大家是第一次聽說，但我們每天都在用，每天都有無數(shù)潛在的坑被埋下。本文就來和大家聊聊它的相關(guān)注意事項吧，希望對大家有所幫助2023-03-03
這篇文章匯總了在開發(fā)和刷面試題過程中遇到的Golang容易搞錯的知識點，關(guān)鍵部分也都為大家寫了代碼示例，感興趣的小伙伴可以了解一下2022-09-09
Golang 支持一些類似面向?qū)ο缶幊痰奶匦?，方法就其中之一，本文將詳細介紹 Golang 中方法相關(guān)的知識，感興趣的小伙伴跟著小編一起來學(xué)習(xí)吧2023-07-07
Go語言實現(xiàn)統(tǒng)計字符串中每個字符出現(xiàn)的次數(shù)
這篇文章主要為大家詳細介紹了如何使用Go語言開發(fā)一個簡易頻率分析器,實現(xiàn)統(tǒng)計字符串中每個字符出現(xiàn)的次數(shù),感興趣的小伙伴可以了解一下2025-07-07