Documentation
¶
Overview ¶
Package gin_middle 提供 Gin 的 CORS、panic 恢复和 JWT 鉴权中间件。
通过 Engine.Use 或路由组 Use 注册 Cors、Recovery、JWTAuth[T]。 使用 Recovery 前初始化 xxlog，使用 JWTAuth 前在启动阶段调用 xxjwt.Init。 JWTAuth 的用户标识类型 T 必须与签发 Token 时保持一致。
JWTAuth 默认从 Token 请求头读取原始令牌，鉴权成功后将用户标识写入 gin.Context 的 userID 键；JWTAuthOptions 可修改这两个键名。 鉴权失败时中间件已响应并终止后续处理。 使用自定义请求头时，需同步检查 CORS 放行的请求头配置。
Index ¶
Constants ¶
View Source
const ( // DefaultTokenHeaderKey 默认的 Token 请求头键名，需与 Cors 放行的头保持一致。 DefaultTokenHeaderKey = "Token" // DefaultUserIDContextKey 默认写入 gin.Context 的用户标识键名。 DefaultUserIDContextKey = "userID" )
Variables ¶
This section is empty.
Functions ¶
func JWTAuth ¶ added in v0.2.77
func JWTAuth[T any](opts ...JWTAuthOptions) gin.HandlerFunc
JWTAuth JWT 认证中间件，T 为用户标识类型，需与签发 Token 时保持一致。 认证通过后把用户标识写入 gin.Context，供 Controller 取用。
Types ¶
type JWTAuthOptions ¶ added in v0.2.77
type JWTAuthOptions struct {
// HeaderKey 读取 Token 的请求头键名，为空时取 DefaultTokenHeaderKey。
HeaderKey string
// ContextKey 写入 gin.Context 的用户标识键名，为空时取 DefaultUserIDContextKey。
ContextKey string
}
JWTAuthOptions JWT 认证中间件的可选项，零值等价于使用默认键名。
Source Files
Click to show internal directories.
Click to hide internal directories.