一文理清GO语言日志库实现开发项目中的日志功能（rotatelogs/zap分析）

一文理清GO语言日志库实现开发项目中的日志功能（rotatelogs/zap分析）

rotatelogs

rotatelogs 是一个用于管理日志文件的 Go 语言库，它提供了自动轮换、压缩和删除旧日志文件的功能。这个库可以帮助你更好地管理和维护你的应用程序日志。要使用 rotatelogs，你需要先安装它：

go get -u github.com/lestrrat-go/file-rotatelogs

package main

import (
	"github.com/lestrrat-go/file-rotatelogs"
	"time"
)

func main() {
	logFilePath := ""
	logFileName := ""
	// 创建一个日志文件轮换器
	r, err := rotatelogs.New(
		logFilePath+logFileName+"./mylog.%Y%m%d", // 日志文件名格式
		rotatelogs.WithLinkName("./mylog"),       // 软链接名
		rotatelogs.WithMaxAge(7*24*time.Hour),    // 最大保存时间
		rotatelogs.WithRotationTime(24*time.Hour), // 轮换间隔
	)
	if err != nil {
		panic(err)
	}

	// 使用 r 作为日志输出源
	logger := log.New(r, "", log.LstdFlags)
	logger.Println("Hello, rotatelogs!")
}

该示例代码会创建一个名为 mylog.YYYYMMDD 的日志文件，每天轮换一次，并保留最近 7 天的日志文件。你可以根据需要调整这些参数。

“go.uber.org/zap” 和 “go.uber.org/zap/zapcore” 是Go语言中的两个日志库。这两个库提供了高性能、可扩展的日志记录功能。

“go.uber.org/zap”

这个库提供了一个简单的API，用于记录日志。它包含了一些高级功能，如结构化日志记录、日志级别过滤、日志格式化等。要使用这个库，你需要先安装它：

go get -u go.uber.org/zap

然后在你的代码中导入并使用它：

package main

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

func main() {
	logger, err := zap.NewProduction()
	if err != nil {
		panic(err)
	}
	defer logger.Sync() // flushes buffer, if any
	logger.Info("Hello, zap!")
}

下面是一些使用 “go.uber.org/zap” 进行高级日志记录的示例：

1. 结构化日志记录：

   你可以使用结构体来记录日志，这样可以更方便地添加和删除字段。例如：

type MyLog struct {
	Time     time.Time `json:"time"`
	Level    string    `json:"level"`
	Message  string    `json:"message"`
	Username string    `json:"username,omitempty"`
}

func main() {
	logger, err := zap.NewProduction()
	if err != nil {
		panic(err)
	}
	defer logger.Sync() // flushes buffer, if any

	log := MyLog{
		Time:     time.Now(),
		Level:    "info",
		Message:  "Hello, zap!",
		Username: "Alice",
	}

	logger.Info("My log", zap.Object("log", log))
}

2. 日志级别过滤：

   你可以设置不同的日志级别，以便在生产环境中只记录关键信息。例如：

func main() {
	logger, err := zap.NewDevelopment()
	if err != nil {
		panic(err)
	}
	defer logger.Sync() // flushes buffer, if any

	logger.Debug("Debug message") // 不会输出，因为当前级别是 info
	logger.Info("Info message")   // 会输出
	logger.Warn("Warn message")   // 会输出
	logger.Error("Error message") // 会输出
}

3. 日志格式化：

   你可以自定义日志的输出格式。例如，你可以使用 JSON 格式输出日志：

func main() {
	cfg := zap.NewProductionConfig()
	cfg.Encoding = "json"
	cfg.OutputPaths = []string{"stdout"}
	logger, err := cfg.Build()
	if err != nil {
		panic(err)
	}
	defer logger.Sync() // flushes buffer, if any

	logger.Info("Hello, zap!", zap.String("foo", "bar"))
}

这些示例展示了如何使用 “go.uber.org/zap” 进行高级日志记录。你可以根据需要调整配置和使用这些功能。

“go.uber.org/zap/zapcore”

这个库提供了核心的日志记录功能，包括日志级别、日志格式、日志输出等。它是"go.uber.org/zap"库的基础。要使用这个库，你也需要先安装它：

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

然后在你的代码中导入并使用它：

package main

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

func main() {
	encoderConfig := zapcore.EncoderConfig{
		TimeKey:        "time",
		LevelKey:       "level",
		NameKey:        "logger",
		CallerKey:      "caller",
		MessageKey:     "msg",
		StacktraceKey:  "stacktrace",
		EncodeLevel:    zapcore.LowercaseLevelEncoder,
		EncodeTime:     zapcore.ISO8601TimeEncoder,
		EncodeDuration: zapcore.SecondsDurationEncoder,
		EncodeCaller:   zapcore.FullCallerEncoder,
	}
}

“go.uber.org/zap” 库提供了多种高级日志记录功能，以下是一些具体的例子和解释：

1. 结构化日志记录

Zap 支持使用结构体创建结构化的日志条目。例如：

import "go.uber.org/zap"

type LogEntry struct {
    UserID   int       `json:"user_id"`
    Username string    `json:"username"`
    Email    string    `json:"email"`
    Message  string    `json:"message"`
    Timestamp time.Time `json:"timestamp"`
}

func main() {
    logger, _ := zap.NewProduction()
    defer logger.Sync() // 确保所有日志都被 flush

    entry := LogEntry{
        UserID:   123,
        Username: "JohnDoe",
        Email:    "[email protected]",
        Message:  "User logged in",
        Timestamp: time.Now(),
    }

    logger.Info("User action", zap.Any("entry", entry))
}

在这个例子中，LogEntry 结构体被用来创建一个包含用户操作信息的日志条目。通过使用 zap.Any 将结构体作为任意类型的数据添加到日志中，这允许日志保留其结构格式。

2. 日志级别

Zap 提供不同的日志级别，用于控制日志的详细程度。例如：

import "go.uber.org/zap"

func main() {
    logger, _ := zap.NewDevelopment()
    defer logger.Sync()

    logger.Debug("This is a debug message") // 仅在开发环境下可见
    logger.Info("This is an info message")  // 通常用于生产环境
    logger.Warn("This is a warning message") // 表示可能的问题
    logger.Error("This is an error message") // 表示错误
    logger.Panic("This is a panic message")  // 表示严重错误
}

通过设置不同的日志级别，你可以控制哪些消息应该被记录和注意，这对于不同环境（如开发、测试、生产）中的日志管理非常有用。

3. 日志格式化和输出

Zap 允许你自定义日志的格式化和输出方式。例如，可以将日志以 JSON 格式输出：

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

func main() {
    config := zap.NewProductionConfig()
    config.Encoding = "json"
    logger, _ := config.Build()
    defer logger.Sync()

    logger.Info("Hello, Zap!", zap.String("key", "value"))
}

在这个例子中，日志条目将以 JSON 格式输出，这是通过设置 config.Encoding 为 "json" 实现的。这使得日志具有更好的结构化和可读性，便于日志解析和分析工具处理。

通过这些高级功能，go.uber.org/zap 提供了强大而灵活的日志记录解决方案，适用于各种规模和复杂度的 Go 语言项目。

总之，“go.uber.org/zap” 是一个更高级的日志库，它基于 “go.uber.org/zap/zapcore” 提供了更多的功能。