Zap 是一个由 Uber 开发的高性能、结构化的日志库，专门为 Go 语言设计。它的目标是提供比标准日志库更高效的性能，同时也提供丰富的功能，适用于高吞吐量的应用场景。
以下是 Zap 框架的详细笔记，涵盖了基础到高级的功能。
1. Zap 框架简介
Zap 是 Go 语言中高效且功能强大的日志库，特别适用于高性能、低延迟的应用。它支持结构化日志，能够将日志以 JSON 格式输出，并且支持自定义日志级别、字段等。与其他日志库相比，Zap 的性能表现非常出色，尤其在日志量大、吞吐量要求高的场景中。
Zap 的特点：
- 高性能：Zap 的设计目标之一就是高效。它采用零分配的日志记录方式，并且性能比标准库
log和许多其他日志库要好。 - 结构化日志：Zap 支持结构化日志输出，可以非常方便地以 JSON 或其他格式输出日志数据，方便后期的日志分析。
- 灵活的日志级别：Zap 提供了不同的日志级别（如 DEBUG、INFO、WARN、ERROR 等），并且可以灵活设置不同级别的日志记录。
- 自定义字段：Zap 支持在日志中附加自定义字段，可以帮助在日志中输出更多的上下文信息。
2. 安装 Zap
安装 Zap：
go get -u go.uber.org/zap导入包：
import "go.uber.org/zap"3. 基本使用
3.1 创建一个简单的日志记录器
package main
import (
"go.uber.org/zap"
)
func main() {
// 创建一个开发环境的默认日志记录器
logger, _ := zap.NewDevelopment()
defer logger.Sync() // 刷新日志
// 记录一条简单的日志
logger.Info("This is an info log")
// 记录一条带有字段的日志
logger.Info("This is an info log with fields",
zap.String("user", "john"),
zap.Int("age", 30),
)
}zap.NewDevelopment()：创建一个适用于开发环境的日志记录器，输出格式为人类可读的格式，适合调试。logger.Info()：记录INFO级别的日志。zap.String("user", "john")：给日志附加一个字段，字段名为user，字段值为john。
3.2 创建生产环境的日志记录器
在生产环境中，通常使用 JSON 格式输出日志，便于机器处理。
logger, _ := zap.NewProduction()
defer logger.Sync()
logger.Info("This is a production log", zap.String("env", "production"))zap.NewProduction()：创建一个适用于生产环境的日志记录器，输出格式为 JSON，适合机器读取。
4. 日志级别
Zap 提供了多种日志级别，用于记录不同严重程度的日志信息。常用的日志级别有：
- DEBUG：用于调试信息，通常在开发时使用。
- INFO：普通信息，记录应用的正常运行状态。
- WARN：警告信息，表示某些不正常的状态，但不至于影响程序运行。
- ERROR：错误信息，表示程序运行中发生了错误。
- DPANIC：开发者用来标记代码中可能存在的问题，通常会在开发环境中记录，但生产环境不会打印。
- PANIC：严重错误，导致程序崩溃，通常用于程序的致命错误。
- FATAL：与
PANIC类似，表示程序终止。
4.1 设置日志级别
logger, _ := zap.NewProduction()
defer logger.Sync()
logger.Debug("This is a debug log") // 不会输出
logger.Info("This is an info log") // 会输出
logger.Warn("This is a warn log") // 会输出
logger.Error("This is an error log") // 会输出Debug()：记录DEBUG级别的日志。Info()：记录INFO级别的日志。Warn()：记录WARN级别的日志。Error()：记录ERROR级别的日志。
注意：zap.NewProduction() 默认只记录 INFO 及以上级别的日志，低于 INFO 的日志（如 DEBUG）不会输出。
5. 自定义日志字段
Zap 允许在日志记录时附加多个自定义字段，以便记录更多的上下文信息。这些字段可以是任何类型，例如字符串、整数、结构体等。
5.1 添加字段
logger.Info("User logged in", zap.String("username", "john"), zap.Int("user_id", 123))zap.String()：添加一个字符串类型的字段。zap.Int()：添加一个整数类型的字段。
5.2 使用结构化字段
Zap 支持结构化日志，可以将复杂数据结构（如对象、切片等）作为字段值：
user := struct {
Name string
Age int
}{
Name: "john",
Age: 30,
}
logger.Info("User info", zap.Any("user", user))zap.Any("user", user)：将结构体作为字段添加到日志中，Zap 会自动将其序列化为 JSON 格式。
6. 日志的输出格式
Zap 支持输出不同格式的日志，包括开发环境格式和生产环境格式。
6.1 开发环境格式
logger, _ := zap.NewDevelopment()
defer logger.Sync()
logger.Info("This is a development log", zap.String("env", "dev"))- 在开发环境中，日志以人类可读的格式输出，适合调试和查看日志。
6.2 生产环境格式
logger, _ := zap.NewProduction()
defer logger.Sync()
logger.Info("This is a production log", zap.String("env", "prod"))- 在生产环境中，日志以 JSON 格式输出，便于机器解析和存储。
6.3 自定义日志格式
你可以自定义日志的编码器，设置日志输出的格式：
cfg := zap.NewProductionConfig()
cfg.Encoding = "json" // 设置编码格式为 JSON
logger, _ := cfg.Build()
defer logger.Sync()- 你可以自定义编码格式，支持 JSON 或纯文本格式。
7. 异步日志
为了避免日志记录操作影响程序的性能，Zap 支持异步日志记录。
7.1 使用 zapcore.NewCore 实现异步日志
core := zapcore.NewCore(
zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig()),
zapcore.AddSync(os.Stdout),
zap.InfoLevel,
)
logger := zap.New(core)
defer logger.Sync()
logger.Info("This is an async log")- 通过
zapcore.NewCore结合自定义输出和日志级别，启用异步日志。
7.2 性能考虑
Zap 默认是同步的，但你可以通过配置来使日志记录异步，这有助于提高性能，尤其是在高负载的情况下。
8. 日志旋转
虽然 Zap 本身不支持日志文件的轮转，但可以通过将日志输出到 lumberjack 这样的库来实现日志文件的自动轮转。
import "gopkg.in/natefinch/lumberjack.v2"
logger := zap.New(zapcore.NewCore(
zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig()),
zapcore.AddSync(&lumberjack.Logger{
Filename: "logs/myapp.log",
MaxSize: 100, // MB
MaxBackups: 3,
MaxAge: 30, // days
}),
zap.InfoLevel,
))
defer logger.Sync()lumberjack.Logger：用于配置日志文件的自动轮转，包括文件大小、备份数量和保留时间等。
9. 错误处理
在 Zap 中，如果创建日志记录器失败，通常会返回一个错误。错误通常与配置相关，例如日志输出目录不可写或者配置无效。
logger, err := zap.NewProduction()
if err != nil {
panic(fmt.Sprintf("Can't create zap logger: %v", err))
}
defer logger.Sync()总结
Zap 是一个高效、结构化的日志库，非常适合高性能、高并发的应用。它提供了灵活的日志级别、丰富的字段支持，并且能够自定义日志格式和日志处理方式。Zap 特别适合需要高吞吐量、低延迟的系统，同时也能够满足生产环境中日志存储和分析的需求。
