Zap / Logrus 用于 Go：完整指南及示例

Go 日志记录入门：Zap 和 Logrus

日志记录是任何严肃应用程序的关键组件。它允许您跟踪程序状态、记录错误、分析性能并在生产环境中调试代码。Go 标准库中有一个 log 包，但其功能有限：没有日志级别（除了基本级别）、没有结构化输出、没有灵活的格式。为了解决这些问题，出现了两个强大的库：Zap（来自 Uber）和 Logrus（最早的流行日志记录器之一）。

在本文中，我们将详细讨论这两个库、它们的方法、使用示例和最佳实践。您将学习如何设置结构化日志记录、如何使用日志级别、如何添加上下文字段以及如何避免常见错误。

什么是 Zap？

Zap 是 Uber 公司开发的一个高性能结构化日志记录库。它专注于速度和最小化内存分配。Zap 支持两种工作模式：SugaredLogger（方便但稍慢）和 Logger（最高性能）。

什么是 Logrus？

Logrus 是 Go 中最早且最流行的日志记录库之一。它提供了简单的 API、支持日志级别、格式化器（JSON、Text）以及用于与外部系统（例如 Sentry、Slack）集成的钩子（hooks）。Logrus 更易于学习，但在性能上不如 Zap。

安装

两个库的安装都通过标准的 go get 命令完成：

// 安装 Zapgo get -u go.uber.org/zap

// 安装 Logrusgo get -u github.com/sirupsen/logrus

安装后，您可以将它们导入到您的项目中：

import (    "go.uber.org/zap"    "github.com/sirupsen/logrus")

快速入门及代码示例

Zap 示例

package main

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

func main() {    // 创建生产环境日志记录器（高性能）    logger, _ := zap.NewProduction()    defer logger.Sync() // 退出前刷新缓冲区

    // 记录带字段的消息    logger.Info("应用程序已启动",        zap.String("version", "1.0.0"),        zap.Int("port", 8080),    )

    // 使用 SugaredLogger 以方便操作    sugar := logger.Sugar()    sugar.Infow("用户已登录系统",        "user", "john_doe",        "ip", "192.168.1.1",    )}

Logrus 示例

package main

import (    "github.com/sirupsen/logrus")

func main() {    // 设置输出格式（JSON）    logrus.SetFormatter(&logrus.JSONFormatter{})

    // 设置日志级别    logrus.SetLevel(logrus.InfoLevel)

    // 记录带字段的消息    logrus.WithFields(logrus.Fields{        "version": "1.0.0",        "port":    8080,    }).Info("应用程序已启动")

    // 记录错误    logrus.WithFields(logrus.Fields{        "user": "john_doe",        "ip":   "192.168.1.1",    }).Warn("尝试使用错误密码登录")}

主要方法和函数

1. Zap: NewProduction() / NewDevelopment()

功能： 创建预配置的日志记录器，用于生产环境或开发环境。生产环境日志记录器使用 JSON 格式并针对速度进行了优化。开发环境日志记录器使用彩色文本输出并包含堆栈跟踪。

参数： 无（返回 *zap.Logger 和一个错误）。

示例：

prodLogger, _ := zap.NewProduction()devLogger, _ := zap.NewDevelopment()

2. Zap: Logger.Info(),

图书馆中也有

Kotlin CLI框架：Clikt、kotlinx-cli、picocli——概述与比较 C# (.NET) 中的数据验证：库与方法 Carthage for Swift：完整指南与示例 Swagger-PHP 用于 PHP：完整指南及示例 Java中ZIP归档操作：java.util.zip完全指南