在Go Echo框架中自定义请求关联日志的高效实现方案咨询

需求回顾 #

你期望日志输出包含请求特定元数据，格式示例：

2024-06-22T19:36:48+01:00 INFO [request_id=14fbf2eb-0793-4efb-ab05-7cd1ebd203ef][appName=test][method=GET][path=/test] Test log

当前方案每个请求创建新的log.Logger实例，确实会带来不必要的内存分配和初始化开销，高并发场景下影响更明显。以下是几种更高效的实现方式，无需依赖注入：

方案1：复用全局基础Logger + 上下文存元数据 + 封装日志方法 #

核心思路：初始化一个全局基础Logger，在中间件里生成并存储请求元数据，通过封装的日志方法从上下文取元数据拼接后输出。

步骤1：初始化全局基础Logger

package main

import (
    "github.com/labstack/echo/v4"
    "github.com/labstack/gommon/log"
    "github.com/google/uuid"
    "net/http"
    "fmt"
)

// 全局基础Logger，仅初始化一次
var baseLogger *log.Logger

func init() {
    baseLogger = log.New("")
    // 设置基础日志头（时间、级别）
    baseLogger.SetHeader("${time_rfc3339} ${level}")
}

步骤2：编写中间件存储请求元数据

func RequestMetadataMiddleware(next echo.HandlerFunc) echo.HandlerFunc {
    return func(c echo.Context) error {
        // 生成请求ID
        reqID, err := uuid.NewRandom()
        if err != nil {
            return err
        }
        // 预拼接日志前缀，存入上下文（只生成一次，避免重复计算）
        logPrefix := fmt.Sprintf("[request_id=%s][appName=%s][method=%s][path=%s] ",
            reqID.String(),
            msConfig.GetConfig().Info.App.Name,
            c.Request().Method,
            c.Request().RequestURI)
        c.Set("log_prefix", logPrefix)
        return next(c)
    }
}

步骤3：封装日志方法供业务使用

// LogInfo 从上下文获取预生成的前缀，拼接日志内容后输出
func LogInfo(c echo.Context, msg string) {
    prefix := c.Get("log_prefix").(string)
    baseLogger.Info(prefix + msg)
}

步骤4：路由中使用

func main() {
    e := echo.New()
    // 注册中间件
    e.Use(RequestMetadataMiddleware)
    
    e.GET("/test", func(c echo.Context) error {
        LogInfo(c, "Test log")
        return c.String(http.StatusOK, "Hello, World!")
    })
    
    e.Start(":8080")
}

方案2：自定义轻量Logger绑定上下文（兼容c.Logger()调用） #

如果想保留c.Logger().Info()的调用习惯，可以自定义一个轻量的Logger结构体，持有上下文和全局基础Logger，避免创建完整的log.Logger实例。

步骤1：自定义Logger实现

// ctxLogger 轻量包装结构体，持有请求上下文和基础Logger
type ctxLogger struct {
    ctx  echo.Context
    base *log.Logger
}

// Info 实现echo.Logger接口的Info方法，自动拼接请求元数据
func (l *ctxLogger) Info(i ...interface{}) {
    prefix := l.ctx.Get("log_prefix").(string)
    l.base.Info(prefix + fmt.Sprint(i...))
}

// 按需实现其他日志级别方法（Warn、Error等）
func (l *ctxLogger) Warn(i ...interface{}) {
    prefix := l.ctx.Get("log_prefix").(string)
    l.base.Warn(prefix + fmt.Sprint(i...))
}

步骤2：中间件中绑定自定义Logger

func RequestLoggerMiddleware(next echo.HandlerFunc) echo.HandlerFunc {
    return func(c echo.Context) error {
        reqID, err := uuid.NewRandom()
        if err != nil {
            return err
        }
        logPrefix := fmt.Sprintf("[request_id=%s][appName=%s][method=%s][path=%s] ",
            reqID.String(),
            msConfig.GetConfig().Info.App.Name,
            c.Request().Method,
            c.Request().RequestURI)
        c.Set("log_prefix", logPrefix)
        
        // 绑定轻量Logger到上下文，仅分配一个小结构体
        c.SetLogger(&ctxLogger{
            ctx:  c,
            base: baseLogger,
        })
        return next(c)
    }
}

步骤3：业务中直接调用

e.GET("/test", func(c echo.Context) error {
    c.Logger().Info("Test log") // 保持原有调用方式
    return c.String(http.StatusOK, "Hello, World!")
})

方案优势 #

• 复用全局基础Logger，避免重复初始化日志组件的开销
• 请求元数据仅在中间件中生成一次，无需每次日志都重新拼接
• 自定义Logger仅为轻量结构体，内存分配远小于完整的log.Logger实例
• 两种方案都无需依赖注入，保持代码简洁

内容的提问来源于stack exchange，提问作者João Calhau