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来做日志服务

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

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

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

1、安装zap

go get -u go.uber.org/zap

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

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

然后在执行安装的命令。

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, // 全路径编码器 } // 设置日志级别（默认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：可选值。

使用案例

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使用方法，希望能给大家一个参考，也希望大家多多支持软件开发网。如有错误或未考虑完全的地方，望不吝赐教。

您可能感兴趣的文章:使用Lumberjack+zap进行日志切割归档操作golang 输出重定向:fmt Log,子进程Log,第三方库logrus的详解golang的time包:秒、毫秒、纳秒时间戳输出方式golang 使用time包获取时间戳与日期格式化操作golang return省略用法说明

工具 golang