将http HandlerFunc中间件改写为gin HandlerFunc遇问题求助

我原本有一个基于http.Handler编写的认证中间件，切换到gin-gonic框架后改写的版本未达到预期效果。

原http.Handler中间件代码 #

func AuthMiddlewarex(h http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        auth := r.Header.Get("Authorization")

        if auth == "" {
            h.ServeHTTP(w, r)
            return
        }

        bearer := "Bearer "
        auth = auth[len(bearer):]

        validate, err := utils.JwtValidate(context.Background(), auth)
        if err != nil || !validate.Valid {
            http.Error(w, "Invalid token", http.StatusForbidden)
            return
        }

        customClaim, _ := validate.Claims.(*utils.JwtCustomClaim)

        ctx := context.WithValue(r.Context(), authString("auth"), customClaim)

        r = r.WithContext(ctx)
        h.ServeHTTP(w, r)
    })
}

改写后的Gin中间件代码 #

func AuthMiddlewareq() gin.HandlerFunc {
    return func(c *gin.Context) {
        auth := c.Request.Header.Get("Authorization")

        if auth == "" {
            c.Next()
            // next.ServeHTTP(w, r)
            return
        }

        bearer := "Bearer "
        auth = auth[len(bearer):]

        validate, err := utils.JwtValidate(context.Background(), auth)
        if err != nil || !validate.Valid {
            http.Error(c.Writer, "Invalid token", http.StatusForbidden)
            // http.Error(w, "Invalid token", http.StatusForbidden)
            return
        }

        customClaim, _ := validate.Claims.(*utils.JwtCustomClaim)

        ctx := context.WithValue(c.Request.Context(), authString("auth"), customClaim)
        c.Request = c.Request.WithContext(ctx)

        c.Next()
        // next.ServeHTTP(w, r)
    }
}

问题分析与修正方案 #

改写后的代码存在几个关键问题，导致未达预期：

1. 请求链未正确终止 #

当token无效时，使用http.Error写入响应后直接return，但Gin的请求链不会自动终止，后续的handler或中间件仍会执行，可能导致重复响应或不符合预期的处理逻辑。应使用Gin提供的Abort系列方法终止请求链并返回标准响应。

2. 未校验Bearer前缀 #

直接截取auth[len(bearer):]会在Authorization头格式错误（不以"Bearer "开头）时触发字符串越界panic，必须先校验格式。

3. 类型断言忽略失败场景 #

忽略validate.Claims.(*utils.JwtCustomClaim)的断言失败结果，可能导致后续使用customClaim时出现nil指针panic。

4. 上下文存储不符合Gin习惯 #

虽然通过Request Context存储claim是可行的，但Gin提供了更便捷的c.Set()方法，后续handler可直接通过c.Get()获取，更符合框架使用规范。

修正后的Gin中间件代码 #

import (
    "strings"
    "net/http"
    "context"
    "github.com/gin-gonic/gin"
    // 导入你的utils包
)

func AuthMiddleware() gin.HandlerFunc {
    return func(c *gin.Context) {
        auth := c.GetHeader("Authorization")

        if auth == "" {
            c.Next()
            return
        }

        bearerPrefix := "Bearer "
        // 校验Authorization头格式
        if !strings.HasPrefix(auth, bearerPrefix) {
            c.AbortWithStatusJSON(http.StatusForbidden, gin.H{"error": "无效的认证格式"})
            return
        }

        token := auth[len(bearerPrefix):]

        validate, err := utils.JwtValidate(context.Background(), token)
        if err != nil || !validate.Valid {
            c.AbortWithStatusJSON(http.StatusForbidden, gin.H{"error": "无效的token"})
            return
        }

        customClaim, ok := validate.Claims.(*utils.JwtCustomClaim)
        if !ok {
            c.AbortWithStatusJSON(http.StatusForbidden, gin.H{"error": "无效的token声明"})
            return
        }

        // 使用Gin上下文存储自定义声明，方便后续handler获取
        c.Set("auth", customClaim)
        
        // 若需兼容原有Request Context的用法，可保留以下代码
        // ctx := context.WithValue(c.Request.Context(), authString("auth"), customClaim)
        // c.Request = c.Request.WithContext(ctx)

        c.Next()
    }
}

内容的提问来源于stack exchange，提问作者King