在 Gin 框架中，Request ID 是用于标识每个请求的唯一标识符。它通常用于追踪日志、请求链路、监控、错误跟踪等场景，确保在分布式系统中对请求的追踪更加清晰。每个请求都有一个唯一的 Request ID，它可以帮助我们在日志中追溯整个请求的处理流程，尤其是在微服务架构中，当请求跨越多个服务时，Request ID 的存在能够帮助我们轻松关联各个服务间的日志。
我们可以通过创建一个 Gin 中间件，自动为每个请求生成一个唯一的 Request ID，并将其附加到请求上下文（Context）中。在后续处理过程中，我们可以通过 c.Request.Context() 获取该 Request ID，并在日志或其他地方使用它。
可以使用以下几种方法来生成 Request ID：
在这里，我们采用 UUID 来实现 Request ID。
首先需要安装 github.com/google/uuid 库来生成 UUID：
Life is like a journey
go get github.com/google/uuid
package main
import (
"fmt"
"github.com/gin-gonic/gin"
"github.com/google/uuid"
"log"
"net/http"
)
// RequestIDMiddleware 用于生成并附加 Request ID 到每个请求
func RequestIDMiddleware() gin.HandlerFunc {
return func(c *gin.Context) {
// 检查请求中是否已经包含 Request ID (例如来自客户端传递的)
requestID := c.GetHeader("X-Request-Id")
if requestID == "" {
// 如果请求头中没有 Request ID，则生成一个新的 UUID
requestID = uuid.New().String()
}
// 将 Request ID 添加到请求的 Context 中
c.Set("RequestID", requestID)
// 在响应头中添加 X-Request-Id，以便客户端获取
c.Header("X-Request-Id", requestID)
// 在日志中输出 Request ID
log.Printf("Request ID: %s, Method: %s, Path: %s", requestID, c.Request.Method, c.Request.URL.Path)
// 继续处理请求
c.Next()
}
}
func main() {
r := gin.Default()
// 使用 Request ID 中间件
r.Use(RequestIDMiddleware())
// 示例路由
r.GET("/ping", func(c *gin.Context) {
// 从请求上下文中获取 Request ID
requestID, _ := c.Get("RequestID")
c.JSON(http.StatusOK, gin.H{
"message": "pong",
"requestId": requestID,
})
})
// 启动服务器
r.Run(":8080")
}
X-Request-Id 头是否已经包含一个 Request ID，如果有就使用它。uuid.New().String() 来生成一个新的全局唯一的标识符。c.Set("RequestID", requestID)），后续处理可以通过 c.Get("RequestID") 获取。X-Request-Id，这样客户端可以看到并使用该 Request ID。/ping 路由中，我们从上下文中获取 Request ID，并将其作为响应的一部分返回给客户端。启动服务器后，访问 http://localhost:8080/ping。你会看到类似以下的响应：
{
"message": "pong",
"requestId": "a90a4f4e-8d2f-49e6-b2d1-8c15d92217e9"
}
你还可以在服务器日志中看到类似以下的输出：
Request ID: a90a4f4e-8d2f-49e6-b2d1-8c15d92217e9, Method: GET, Path: /ping
如果客户端已经提供了一个 X-Request-Id 请求头，Gin 中间件会使用它，并且这个 Request ID 会传递到后续的日志和响应中。这使得你可以在多个微服务之间传递 Request ID，从而实现跨服务的日志追踪。
X-Request-Id，使得跨服务调用时，Request ID 可以传递到下游服务。使用 Request ID 是一种良好的实践，尤其在微服务架构和分布式系统中，能够显著提升系统的可观测性和问题定位能力。