gin 内部重定向时 middleware 不可用异常

axios 请求时出现 cors error

在使用 axios 请求后端时，遇到 cors 跨域问题，虽然已经在 gin 中添加了 cors 的 middleware

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
func cors() gin.HandlerFunc {
	return func(c *gin.Context) {
		method := c.Request.Method
		origin := "*"
		if method != "" {
			c.Header("Access-Control-Allow-Origin", origin) // 可将将 * 替换为指定的域名
			c.Header("Access-Control-Allow-Methods", "POST, GET, OPTIONS, PUT, DELETE, UPDATE")
			c.Header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept, Authorization,X-Token")
			c.Header("Access-Control-Expose-Headers", "Content-Length, Access-Control-Allow-Origin, Access-Control-Allow-Headers, Cache-Control, Content-Language, Content-Type")
			c.Header("Access-Control-Allow-Credentials", "true")
		}
		if method == "OPTIONS" {
			c.AbortWithStatus(http.StatusNoContent)
		}
	}
}

问题原因

gin Middleware 是 gin https://github.com/gin-gonic/gin/ 中的一个概念

https://github.com/gin-gonic/gin/#using-middleware

在使用的时候小心 gin 针对地址尾部的 / 的处理时丢失 middleware 逻辑的问题。

例如，定义了一个路由 /k8sailor/v0/deployments

1
2
3
4
5
6
7
8
func DeploymentRouterGroup(base *gin.RouterGroup) {
	// 创建 dep 路由组
	dep := base.Group("/deployments")
	{
		// 针对 所有 deployment 操作
		dep.GET("", handlerListDeployments)
	}
}

在请求的时候，访问 /k8sailor/v0/deployments/ ，那么 gin 将自动 301 重定向到 /k8sailor/v0/deployments

内部 301 日志如下

该重定向不是常规的给客户端返回 301和 Location 再由客户端发起的。而是直接在 gin 内部就完成了。

从 network 瀑布 可以看到，客户端只向服务端发送了一次请求。

该重定向不会携带 gin middlware 逻辑。

到目前为止（gin v1.7.4) 暂内部无解决方法，只能通过添加 nginx 代理 删除 / 或者，祈祷客户端不要请求错误地址。

https://github.com/gin-gonic/gin/issues/568
https://github.com/gin-gonic/gin/issues/1985
https://github.com/gin-gonic/gin/issues/1985

常规 301

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
dep := base.Group("/deployments")
{

  // 主动 301 
  dep.GET("/", func(c *gin.Context) {
    // 删除尾部的 / ， 在重组地址
    _url := strings.TrimRight(c.Request.URL.Path, "/") + "?" + c.Request.URL.RawQuery
    c.Redirect(301, _url)
  })

  // 针对 所有 deployment 操作
  dep.GET("", handlerListDeployments)
}