Gin框架中间件：日志重复？终极排查指南！

Gin框架中间件日志重复记录并非中间件代码缺陷，而是由重复请求引起。本文分析了Gin框架中间件日志重复记录的原因，并提供了详细的排查方法。 可能的原因包括客户端重复提交请求、服务器端请求转发以及浏览器缓存等。 排查步骤包括检查客户端代码、服务器端日志、使用网络抓包工具分析请求，以及模拟请求和简化中间件等，最终帮助开发者有效定位并解决Gin框架中间件日志重复记录问题。

Gin框架中间件日志重复记录问题分析及排查

本文分析Gin框架中间件日志重复记录的原因，并提供排查方法。 如下图所示，日志重复记录并非源于中间件代码本身的缺陷，而是由于重复请求导致。

以下代码片段展示了一个自定义的Gin中间件LogerMiddleware，用于将日志写入文件。该中间件使用logrus和rotatelogs库进行日志管理，实现日志文件的轮转。

// 日志记录到文件
func LogerMiddleware() gin.HandlerFunc {
    dir := file.GetPwd()
    logFilePath := fmt.Sprintf("%s/%s%s", dir, setting.AppSetting.RuntimeRootPath, setting.AppSetting.LogSavePath)
    logFileName := "gin"

    // 日志文件路径
    fileName := path.Join(logFilePath, logFileName)
    fmt.Println("LogerMiddleware: " + fileName)

    // 打开日志文件
    src, err := os.OpenFile(fileName, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0777)
    if err != nil {
        fmt.Println("err", err)
    }
    // 初始化logrus
    logger := logrus.New()
    logger.SetLevel(logrus.DebugLevel)
    logger.Out = src

    // 配置rotatelogs
    logWriter, err := rotatelogs.New(
        fileName+".%Y-%m-%d.log",
        rotatelogs.WithLinkName(fileName),
        rotatelogs.WithMaxAge(7*24*time.Hour),
        rotatelogs.WithRotationTime(24*time.Hour),
    )
    if err != nil {
        fmt.Println("rotatelogs err:", err)
        return func(c *gin.Context) {} // 返回空HandlerFunc防止panic
    }

    writeMap := lfshook.WriterMap{
        logrus.InfoLevel:  logWriter,
        logrus.FatalLevel: logWriter,
        logrus.DebugLevel: logWriter,
        logrus.WarnLevel:  logWriter,
        logrus.ErrorLevel: logWriter,
        logrus.PanicLevel: logWriter,
    }

    logger.AddHook(lfshook.NewHook(writeMap, &logrus.TextFormatter{
        TimestampFormat: "15:04:05",
    }))

    return func(c *gin.Context) {
        startTime := time.Now()
        c.Next()
        endTime := time.Now()
        logger.Infof("%3d | %8v | %13s | %s | %s | %s | %s | %s |",
            c.Writer.Status(),
            endTime.Sub(startTime),
            c.ClientIP(),
            c.Request.Method,
            c.Request.RequestURI,
            c.Request.Proto,
            c.Request.UserAgent(),
            c.Request.Referer(),
        )
    }
}

日志显示重复记录，但时间戳不同，表明是两个独立的请求。 因此，问题不在于中间件代码本身，而是请求源头：

• 客户端重复提交: 检查客户端代码，是否存在意外的重复提交请求，例如用户多次点击提交按钮，或者JavaScript代码中存在缺陷。
• 服务器端请求转发: 检查服务器端是否存在意外的请求转发机制，例如负载均衡器或反向代理服务器的配置问题，导致同一个请求被转发多次。
• 浏览器缓存: 浏览器可能缓存了之前的请求，导致再次请求时日志重复记录。可以通过清除浏览器缓存来验证。

排查步骤:

1. 检查客户端代码: 仔细检查客户端代码，确保没有重复提交请求的逻辑。
2. 检查服务器端日志: 查看服务器端其他日志，例如Nginx或负载均衡器的日志，看看是否有多个相同的请求被记录。
3. 使用网络抓包工具: 使用例如Wireshark或Fiddler等工具抓取网络数据包，分析请求的来源和次数。
4. 模拟请求: 使用工具如Postman模拟请求，观察日志是否重复记录。
5. 简化中间件: 暂时移除或简化LogerMiddleware，观察问题是否仍然存在。这可以帮助确定问题是否与中间件有关。

通过以上步骤，可以有效地定位并解决Gin框架中间件日志重复记录的问题。 记住，日志重复通常不是中间件本身的问题，而是请求处理流程中的重复请求导致的。

今天关于《Gin框架中间件：日志重复？终极排查指南！》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！