Go语言使用Zap轻松搞定结构化日志_Golang

在开发现代应用程序时，日志记录是一个不可或缺的部分。它不仅能帮助我们跟踪程序的运行状态，还能在出现问题时提供宝贵的调试信息。

在 go 语言中，有许多日志库可供选择，但在性能和灵活性方面，zap 是其中的佼佼者。

今天，我将带你深入了解如何在 go 项目中使用 zap 进行结构化日志记录，并且展示如何定制日志输出，以满足生产环境的需求。

为什么选择 zap？

zap 是 uber 开发的一款高性能日志库，专为那些需要快速、结构化日志记录的场景而设计。与其他日志库相比，zap 的性能更为优越，尤其是在需要频繁记录日志的高并发环境中。

此外，zap 提供了两种日志记录接口：logger 和 sugaredlogger。

logger 提供了最基础的、类型安全的结构化日志记录方式。虽然使用时稍显复杂，但在性能上无可匹敌，非常适合对性能有极致要求的场景。
sugaredlogger 则在 logger 之上进行了封装，提供了更为便捷的日志记录方法。尽管在性能上稍逊于 logger，但它的灵活性和易用性使其成为大多数场景下的首选。

基础日志记录示例

为了更好地理解 zap 的使用，让我们从一个简单的例子开始。

package log_demo

import (
	"go.uber.org/zap"
)

var logger *zap.logger

func initlogger() {
	// 初始化 logger，这里我们使用了开发环境的配置
	logger, _ = zap.newdevelopment()
}

func zapprintlog() {
	initlogger()
	defer logger.sync() // 确保日志缓冲区中的所有日志都被写入

	// 记录一条信息级别的日志，并附带结构化的键值对
	logger.info("this is a log message", zap.string("key1", "value1"), zap.float64s("key2", []float64{1.0, 2.0, 3.0}))
}

在这个例子中，我们通过 zap.newdevelopment() 初始化了一个 logger，并使用 logger.info 方法记录了一条信息级别的日志。zap.string 和 zap.float64s 是 zap 提供的用于结构化日志的字段构造器，它们将日志内容按键值对的形式记录下来。

更便捷的 sugaredlogger

虽然结构化日志非常有用，但有时我们只需要快速记录一些信息。此时，sugaredlogger 就派上了用场。它支持类似 fmt.printf 的日志记录方式，使代码更加简洁。

package log_demo

import (
	"go.uber.org/zap"
)

var sugaredlogger *zap.sugaredlogger

func initlogger() {
	logger, _ := zap.newdevelopment()
	sugaredlogger = logger.sugar()
}

func zapprintlog1() {
	initlogger()
	defer sugaredlogger.sync()

	// 使用 sugaredlogger 记录日志
	sugaredlogger.infof("this is a formatted log: %s", "example")
	sugaredlogger.infow("this is a log message", "key1", "value1", "key2", []float64{1.0, 2.0, 3.0})
}

在上面的代码中，sugaredlogger 提供了 infof 和 infow 方法，前者允许你像使用 fmt.printf 一样格式化日志，后者则结合了结构化日志的优点，使日志记录更加灵活。

自定义日志配置

在实际生产环境中，我们可能需要对日志输出进行更精细的控制，比如将日志输出到文件、控制台，或者对日志进行按大小或时间切割。

zap 自身不支持日志切割，但我们可以借助第三方库 lumberjack 来实现这一功能。

package log_demo

import (
	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
	"gopkg.in/natefinch/lumberjack.v2"
)

// initcustomlogger 初始化一个定制的 logger
func initcustomlogger() {
	// 创建一个日志切割器
	writesyncer := zapcore.addsync(&lumberjack.logger{
		filename:   "zap.log",    // 日志文件路径
		maxsize:    10,           // 单个日志文件最大尺寸（mb）
		maxbackups: 5,            // 最多保留5个备份
		maxage:     30,           // 日志保留最长天数
		compress:   true,         // 启用日志压缩
	})

	// 配置日志编码器
	encoderconfig := zap.newproductionencoderconfig()
	encoderconfig.encodetime = zapcore.iso8601timeencoder  // 时间格式
	encoderconfig.encodelevel = zapcore.capitallevelencoder // 日志级别大写
	encoder := zapcore.newconsoleencoder(encoderconfig)

	// 创建 logger core
	core := zapcore.newcore(encoder, writesyncer, zapcore.debuglevel)

	// zap.addcaller() 会在日志中加入调用函数的文件名和行号
	// zap.addcallerskip(1) 会跳过调用函数的文件名和行号
	// 当我们不是直接使用初始化好的logger实例记录日志，而是将其包装成一个函数等，此时日录日志的函数调用链会增加，想要获得准确的调用信息就需要通过addcallerskip函数来跳过
	logger = zap.new(core, zap.addcaller(), zap.addcallerskip(1))
}

func zapprintlog2() {
	initcustomlogger()
	defer logger.sync()

	logger.debug("this is a custom log message", zap.string("key1", "value1"), zap.float64s("key2", []float64{1.0, 2.0, 3.0}))
}

在这个示例中，我们通过 lumberjack.logger 实现了日志文件的自动切割与管理。zapcore.newconsoleencoder 配置了日志的编码格式，确保日志输出不仅有结构化的信息，还带有清晰的时间戳和日志级别标识。此外，我们使用了 zap.addcaller() 和 zap.addcallerskip(1)，这两个函数可以在日志中添加调用函数的文件名和行号，帮助我们更快地定位日志来源。

应用场景示例：记录调试信息

假设我们在开发一个 web 应用时需要记录一些调试信息。此时，使用我们之前定义的 initcustomlogger 函数可以非常方便地记录这些信息。

func main() {
    zapprintlog2() // 调用定制的日志打印函数

    // 假设这里有其他业务逻辑
    for i := 0; i < 3; i++ {
        logger.info("processing iteration", zap.int("iteration", i))
    }
}

在这个简短的示例中，logger.info 会在每次循环中记录当前迭代次数，并将日志输出到指定的日志文件中。