个人中心
gpt4 book ai didi

golang有用的库及工具 之 zap.Logger包的使用指南

转载 作者：qq735679552 更新时间：2022-09-27 22:32:09 27 4
gpt4 key购买 nike

CFSDN坚持开源创造价值，我们致力于搭建一个资源共享平台，让每一个IT人在这里找到属于你的精彩世界.

这篇CFSDN的博客文章golang有用的库及工具 之 zap.Logger包的使用指南由作者收集整理，如果你对这篇文章有兴趣，记得点赞哟.

zap.Logger 是go语言中相对日志库中性能最高的。那么如何开始使用?

不多说直接上代码:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
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)
   }
}

如何使用:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
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]))
}

输出:

?
1
2
3
4
{"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来做日志服务 。

我们在项目中，经常会记录一些数据信息到文件中，或者日志文件.

例如nginx会有nginx访问请求日志，使用golang的时候，我也想做一个这样的访问日志，所以我就找到了go的一个开源高效的日志库zap.

很多人也使用logrus或者go自带的Logger(支持的东西太少，性能一般)，具体为啥最后选择了zap，是因为很多人说zap性能更高些，当然我自己没有测试过.

golang有用的库及工具 之 zap.Logger包的使用指南

1、安装zap 。

go get -u go.uber.org/zap 。

如果没反应，可能需要配置下代理， 。

go env -w GOPROXY=https://goproxy.cn 。

然后在执行安装的命令.

2、简单实例（默认配置） 。

Zap提供了两种类型的日志记录器—Sugared Logger和Logger.

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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包 。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
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,   // 全路径编码器
   }
 
   // 设置日志级别（默认info级别，可以根据需要设置级别）
   atom := zap.NewAtomicLevelAt(zap.InfoLevel)
 
   config := zap.Config{
     Level:      atom,                        // 日志级别
     Development:   true,                        // 开发模式，堆栈跟踪
     Encoding:     "json",                       // 输出格式 console 或 json
     EncoderConfig:  encoderConfig,                    // 编码器配置
     OutputPaths:   []string{"stdout", '需要写入文件的路径'},       // 日志写入文件的地址
     ErrorOutputPaths: []string{"stderr", '需要写入文件的路径'},   // 将系统内的error记录到文件的地址
   }
 
   // 构建日志
   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：每行的分隔符。基本zapcore.DefaultLineEnding 即"\n" 。

EncodeLevel：基本zapcore.LowercaseLevelEncoder。将日志级别字符串转化为小写 。

EncodeTime：输出的时间格式 。

EncodeDuration：一般zapcore.SecondsDurationEncoder,执行消耗的时间转化成浮点型的秒 。

EncodeCaller：一般zapcore.ShortCallerEncoder，以包/文件:行号 格式化调用堆栈 。

EncodeName：可选值.

使用案例 。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
package main
import (
  "logger"//导入写好的包（具体需要改为自己写的路径）
)
 
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使用方法，希望能给大家一个参考，也希望大家多多支持我。如有错误或未考虑完全的地方，望不吝赐教.

原文链接：https://blog.csdn.net/niyuelin1990/article/details/78340336 。

最后此篇关于golang有用的库及工具 之 zap.Logger包的使用指南的文章就讲到这里了,如果你想了解更多关于golang有用的库及工具 之 zap.Logger包的使用指南的内容请搜索CFSDN的文章或继续浏览相关文章，希望大家以后支持我的博客！ 。

27 4 0
文章推荐： Spring Cloud与分布式系统简析
文章推荐： PHP实现发送和接收JSON请求
文章推荐： 浅谈Java程序运行机制及错误分析
文章推荐： 使用Lumberjack+zap进行日志切割归档操作