Go语言Zap日志库使用教程

一、日志库选型需要和比较

1.日志库选型需求

• 日志性能
• 不同日志级别
• 可读性（包括日志采集、监控等）
• 文件切割（不同维度分割）

2.日志库比较

记录一条消息和 10 个字段：

使用已经有 10 个上下文字段的记录器记录消息：

记录一个静态字符串，没有任何上下文或 printf 样式的模板：

通过上面benchmark测试可以Zap性能是非常出众的。主要是大多数日志库提供的方式是基于反射的序列化和字符串格式化，这种方式代价太高，而 Zap 采取不同的方法。

• 避免 interface{} 使用强类型设计
• 封装强类型，无反射
• 使用零分配内存的 JSON 编码器，尽可能避免序列化开销

二、Zap（Uber-go）

1.安装

go get -u go.uber.org/zap

2.配置Zap Logger

Zap提供了两种类型的日志记录器：Sugared Logger、Logger。在每一微秒和每一次内存分配都很重要的上下文中，使用Logger，内存分配次数也更少，但它只支持强类型的结构化日志记录。对性能不是要求极致，建议使用SugaredLogger，支持结构化和 printf 风格的日志记录。

2.1.Logger

• 通过调用zap.NewProduction() | zap.NewDevelopment() | zap.Example()创建一个 Logger。
• 上面的每一个函数都将创建一个 logger。唯一的区别在于它将记录的信息不同。例如 production logger 默认记录调用函数信息、日期和时间等。
• 通过 Logger 调用 Info/Error 等。
• 默认情况下日志都会打印到应用程序的 console 界面。

package main
import (
	"errors"
	"go.uber.org/zap"
)
var logger *zap.Logger
func main() {
	InitLogger()
	logger.Debug("这是一条日志", zap.String("name", "zhangSang"), zap.Int("age", 18)) // zap.NewProduction() 默认不输出该级别日志
	logger.Info("这是一条日志", zap.String("name", "zhangSang"), zap.Int("age", 18))
	logger.Error("这是一条日志", zap.String("name", "zhangSang"), zap.Error(errors.New("错误信息")))
}
func InitLogger() {
	logger, _ = zap.NewProduction()
	defer logger.Sync()
}

上面代码执行结果：

{“level”:”info”,”ts”:1655165315.1104648,”caller”:”test/main.go:13″,”msg”:”这是一条日志”,”name”:”zhangSang”,”age”:18}
{“level”:”error”,”ts”:1655165315.1105008,”caller”:”test/main.go:14″,”msg”:”这是 一条日志”,”name”:”zhangSang”,”error”:”错误信息”,”stacktrace”:”main.main\n\tD:/Go/Work/src/test/main.go:14\nruntime.main\n\tD:/Go/src/runtime/proc.go:255″

2.2.Sugared Logger

• 基本实现都一样，使用SugaredLogger支持Printf格式记录语句
• 调用logger的sugar()方法来获取一个SugaredLogger

package main
import (
	"errors"
	"go.uber.org/zap"
)
var logger *zap.Logger
var sugar *zap.SugaredLogger
func main() {
	InitLogger()
	sugar.Debug("这是一条日志", zap.String("name", "zhangSang"), zap.Int("age", 18)) // zap.NewProduction() 默认不输出该级别日志
	sugar.Info("这是一条日志", zap.String("name", "zhangSang"), zap.Int("age", 18))
	sugar.Error("这是一条日志", zap.String("name", "zhangSang"), zap.Error(errors.New("错误信息")))
}
func InitLogger() {
	logger, _ = zap.NewProduction()
	defer logger.Sync()
	sugar = logger.Sugar()
}

上面代码执行结果：

{“level”:”info”,”ts”:1655165815.3873067,”caller”:”test/main.go:14″,”msg”:”这是一条日志{name 15 0 zhangSang <nil>} {age 11 18  <nil>}”}
{“level”:”error”,”ts”:1655165815.3880382,”caller”:”test/main.go:15″,”msg”:”这是一条日志{name 15 0 zhangSang <nil>} {error 26 0  错误信息}”,”stacktrace”:”main.main\n\tD:/GoWork/src/test/main.go:15\nruntime.main\n\tD:/Go/src/runtime/proc.go:255″}

2.3. 配置Logger

zap.New()方法来手动传递所有配置，而不是使用像zap.NewProduction()这样的预置方法来创建 logger；zapcore.Core需要三个配置——Encoder，WriteSyncer，LogLevel。

func New(core zapcore.Core, options ...Option) *Logger

1.Encoder: 编码器 (配置日志格式)。此处使用NewJSONEncoder() (如果不喜欢JSON格式日志，NewConsoleEncoder()指定普通 Encoder)，并使用预先设置的ProductionEncoderConfig()，ProductionEncoderConfig()返回一个自定义的EncoderConfig。

func getEncoder() zapcore.Encoder {
	encoderConfig := zap.NewProductionEncoderConfig()
	return zapcore.NewJSONEncoder(encoderConfig)
}

2.WriterSyncer ：指定日志写到何处。使用zapcore.AddSync()函数并且将打开的文件句柄传入。

func getLogWriter() zapcore.WriteSyncer {
	file, _ := os.OpenFile("./test.log", os.O_CREATE|os.O_APPEND|os.O_RDWR, 0666) // 打开文件（不存在创建）
	return zapcore.AddSync(file)
}

3.Log Level-指定日志级别

func InitLogger() {
	writeSyncer := getLogWriter()
	encoder := getEncoder()
	core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel) // DebugLevel
	logger = zap.New(core)
	defer logger.Sync()
	sugarLogger = logger.Sugar()
}

大家将上面的方法新增测试代码中，运行结果：

4.时间格式化处理

func getEncoder() zapcore.Encoder {
	encoderConfig := zap.NewProductionEncoderConfig()
	encoderConfig.EncodeTime = customTimeEncoder
	return zapcore.NewJSONEncoder(encoderConfig)
}
func customTimeEncoder(t time.Time, enc zapcore.PrimitiveArrayEncoder) {
	enc.AppendString(t.Format("2006-01-02 15:04:05.000"))
}

运行结果：

5.输出文件名和行号

zap.New()中加上zap.AddCaller()。

func InitLogger() {
	writeSyncer := getLogWriter()
	encoder := getEncoder()
	core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel) // DebugLevel
	logger = zap.New(core, zap.AddCaller())
	defer logger.Sync()
	sugarLogger = logger.Sugar()
}

运行结果：

三.使用 Lumberjack 进行日志切割归档

1. 安装

go get -u github.com/natefinch/lumberjack

2.Zap logger中使用Lumberjack

func getLogWriter() zapcore.WriteSyncer {
	lumberJackLogger := &lumberjack.Logger{
		Filename:   "./test.log", // 日志文件位置
		MaxSize:    1,            // 进行切割之前，日志文件最大值(单位：MB)，默认100MB
		MaxBackups: 10,           // 保留旧文件的最大个数
		MaxAge:     1,            // 保留旧文件的最大天数
		Compress:   false,        // 是否压缩/归档旧文件
	}
	return zapcore.AddSync(lumberJackLogger)
}

3.完整代码

package main
import (
	"github.com/natefinch/lumberjack"
	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
	"time"
)
var logger *zap.Logger
var sugar *zap.SugaredLogger
func main() {
	InitLogger()
	for i := 0; i < 99999; i++ {
		sugar.Debugf("查询用户信息开始 id:%d", 1)
		sugar.Infof("查询用户信息成功 name:%s age:%d", "zhangSan", 20)
		sugar.Errorf("查询用户信息失败 error:%v", "未该查询到该用户信息")
	}
}
func InitLogger() {
	writeSyncer := getLogWriter()
	encoder := getEncoder()
	core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)
	logger = zap.New(core, zap.AddCaller())
	defer logger.Sync()
	sugar = logger.Sugar()
}
func getEncoder() zapcore.Encoder {
	encoderConfig := zap.NewProductionEncoderConfig()
	encoderConfig.EncodeTime = customTimeEncoder
	return zapcore.NewJSONEncoder(encoderConfig)
}
func getLogWriter() zapcore.WriteSyncer {
	lumberJackLogger := &lumberjack.Logger{
		Filename:   "./test.log", // 日志文件位置
		MaxSize:    1,            // 进行切割之前，日志文件最大值(单位：MB)，默认100MB
		MaxBackups: 5,            // 保留旧文件的最大个数
		MaxAge:     1,            // 保留旧文件的最大天数
		Compress:   false,        // 是否压缩/归档旧文件
	}
	return zapcore.AddSync(lumberJackLogger)
}
func customTimeEncoder(t time.Time, enc zapcore.PrimitiveArrayEncoder) {
	enc.AppendString(t.Format("2006-01-02 15:04:05.000"))
}

在main()函数中循环9999次输出日志，运行结果：

总结

zap日志库很强大，性能优势以及绝尘，里面的设计和工程实践很指的学习，有兴趣的盆友可以看看。

到此这篇关于Go语言Zap日志库使用教程的文章就介绍到这了,更多相关Go Zap日志库内容请搜索aitechtogether.com以前的文章或继续浏览下面的相关文章希望大家以后多多支持aitechtogether.com！