golang-cookbook

Appearance

在使用 Gin 框架开发 Go 应用时，日志记录是一个非常重要的部分。Gin 本身提供了内置的日志功能，但你也可以使用第三方日志库（如 logrus, zap, zerolog 等）来增强日志记录功能。下面我将展示如何在 Gin 中集成日志记录，既可以使用 Gin 内置日志器，也可以使用流行的第三方日志库。

1. Gin 自带的 Logger 中间件 ​

Gin 自带了一个简单的日志中间件 gin.Logger()，它会记录每个 HTTP 请求的访问日志（如请求方法、路径、响应状态等）。这对于大多数基础应用是足够的。

使用示例： ​

go
package main

import (
	"github.com/gin-gonic/gin"
)

func main() {
	// 创建一个默认的 Gin 引擎
	r := gin.Default()

	// 使用内置的日志中间件
	r.Use(gin.Logger())

	// 设置一个简单的路由
	r.GET("/ping", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "pong",
		})
	})

	// 启动服务器
	r.Run(":8080")
}

在这种情况下，Gin 会默认记录每个请求的日志，包括：

  • 请求方法（GET, POST 等）
  • 请求路径
  • 请求的响应时间
  • HTTP 状态码

例如：

[GIN] 2024/12/24 - 15:30:23 | 200 |     123.45µs |  localhost:8080 | GET     /ping

2. 自定义日志格式 ​

如果你希望定制日志格式或增加更多信息，Gin 允许你通过自定义日志格式来满足需求。你可以使用 logrus, zap 或其他日志库来替代 Gin 默认的日志功能。

3. 集成 Logrus 到 Gin ​

logrus 是 Go 语言中常用的日志库，它提供了结构化的日志记录、日志级别等功能。以下是如何在 Gin 中集成 logrus。

安装 Logrus： ​

bash
go get github.com/sirupsen/logrus

使用 Logrus 进行日志记录： ​

go
package main

import (
	"github.com/gin-gonic/gin"
	"github.com/sirupsen/logrus"
	"os"
)

func main() {
	// 创建一个 logrus 实例
	logger := logrus.New()

	// 设置日志输出到文件
	file, err := os.OpenFile("gin.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
	if err == nil {
		logger.Out = file
	} else {
		logger.Info("Failed to log to file, using default stderr")
	}

	// 设置日志格式
	logger.SetFormatter(&logrus.JSONFormatter{})

	// 创建 Gin 引擎
	r := gin.New()

	// 使用自定义日志中间件
	r.Use(func(c *gin.Context) {
		// 在请求处理之前记录日志
		logger.WithFields(logrus.Fields{
			"method": c.Request.Method,
			"path":   c.Request.URL.Path,
			"ip":     c.ClientIP(),
		}).Info("Request received")

		// 处理请求
		c.Next()

		// 在请求处理后记录响应信息
		logger.WithFields(logrus.Fields{
			"method": c.Request.Method,
			"path":   c.Request.URL.Path,
			"status": c.Writer.Status(),
		}).Info("Response sent")
	})

	// 设置一个简单的路由
	r.GET("/ping", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "pong",
		})
	})

	// 启动服务器
	r.Run(":8080")
}

在这个例子中，我们创建了一个自定义的日志中间件，它将每次请求的详细信息（如请求方法、路径、客户端 IP 和响应状态）记录到日志文件 gin.log 中。logrus 会将日志以 JSON 格式输出，方便后续分析和处理。

4. 集成 Zap 到 Gin ​

zap 是 Uber 开发的高性能日志库，它适用于高并发应用，尤其是在生产环境下表现优异。以下是如何在 Gin 中集成 zap。

安装 Zap： ​

bash
go get go.uber.org/zap

使用 Zap 进行日志记录： ​

go
package main

import (
	"go.uber.org/zap"
	"github.com/gin-gonic/gin"
)

func main() {
	// 创建一个 zap logger 实例
	logger, _ := zap.NewProduction()
	defer logger.Sync() // 确保日志被刷新到输出

	// 创建 Gin 引擎
	r := gin.New()

	// 使用自定义日志中间件
	r.Use(func(c *gin.Context) {
		// 在请求开始时记录日志
		logger.Info("Request received", zap.String("method", c.Request.Method), zap.String("path", c.Request.URL.Path))

		// 处理请求
		c.Next()

		// 在请求结束时记录日志
		logger.Info("Response sent", zap.String("method", c.Request.Method), zap.String("path", c.Request.URL.Path), zap.Int("status", c.Writer.Status()))
	})

	// 设置一个简单的路由
	r.GET("/ping", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "pong",
		})
	})

	// 启动服务器
	r.Run(":8080")
}

在这个例子中，我们使用 zap.NewProduction() 创建了一个生产环境的日志记录器。和 logrus 类似，zap 也可以记录请求的详细信息，并且支持高效的结构化日志记录。

5. 集成 Zerolog 到 Gin ​

zerolog 是一个高性能的 JSON 日志库，它特别适合在高并发环境下使用。以下是如何在 Gin 中集成 zerolog。

安装 Zerolog： ​

bash
go get github.com/rs/zerolog

使用 Zerolog 进行日志记录： ​

go
package main

import (
	"github.com/gin-gonic/gin"
	"github.com/rs/zerolog"
	"os"
)

func main() {
	// 创建一个 zerolog 实例
	logger := zerolog.New(os.Stdout).With().Timestamp().Logger()

	// 创建 Gin 引擎
	r := gin.New()

	// 使用自定义日志中间件
	r.Use(func(c *gin.Context) {
		// 在请求开始时记录日志
		logger.Info().Str("method", c.Request.Method).Str("path", c.Request.URL.Path).Msg("Request received")

		// 处理请求
		c.Next()

		// 在请求结束时记录日志
		logger.Info().Str("method", c.Request.Method).Str("path", c.Request.URL.Path).Int("status", c.Writer.Status()).Msg("Response sent")
	})

	// 设置一个简单的路由
	r.GET("/ping", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "pong",
		})
	})

	// 启动服务器
	r.Run(":8080")
}

zerolog 与 logrus 和 zap 类似，也支持结构化日志输出，但它专注于高性能和低开销。通过 zerolog，你可以轻松地记录 JSON 格式的日志数据。

6. 总结 ​

在 Gin 中集成日志库是非常灵活的。你可以使用 Gin 提供的默认日志功能，也可以通过集成流行的日志库（如 logrus, zap, zerolog）来增强日志记录的能力：

  • logrus：功能强大的日志库，支持多种日志输出格式（如 JSON 和文本）。
  • zap：高性能、结构化的日志库，特别适合生产环境。
  • zerolog：高效的 JSON 格式日志库，适用于高并发应用。

根据项目需求选择适合的日志库，并通过自定义日志中间件来记录应用的请求和响应日志，有助于调试、监控和性能分析。