更新说明：
1. 为安全性考虑，去除EncryptKey打印
2. 将中间件错误码参数改为返回函数，可以更自由的设计认证失败返回效果
3. 优化ReadMe文档
gtoken v2.X.X 架构全面升级，不再兼容 v1.X.X，升级需谨慎
gtoken
介绍
基于 GoFrame 框架的 token 插件，通过服务端验证方式实现 token 认证；已完全可以支撑线上 token 认证，通过 Redis 支持集群模式；使用简单，大家可以放心使用；
gtoken 优势
- gtoken 支撑单点应用测试使用内存存储，支持个人小项目文件存储，也支持企业集群使用 redis 存储；完全适用于企业生产级使用；
- 有效的避免了 jwt 服务端无法退出问题；
- 解决 jwt 无法作废已颁布的令牌，只能等到令牌过期问题；
- 通过用户扩展信息存储在服务端，有效规避了 jwt 携带大量用户扩展信息导致降低传输效率问题；
- 有效避免 jwt 需要客户端实现续签功能，增加客户端复杂度；支持服务端自动续期，客户端不需要关心续签逻辑；
特性说明
- 支持 token 认证，不强依赖于 session 和 cookie，适用 jwt 和 session 认证所有场景；
- 支持单机 gcache 和集群 gredis 模式；
# 缓存模式 1 gcache 2 gredis 3 fileCache
CacheMode = 2
- 支持服务端缓存自动续期功能
// 注：通过MaxRefresh，默认当用户第五天访问时，自动续期
// 超时时间 默认10天
Timeout int
// 缓存刷新时间 默认为超时时间的一半
MaxRefresh int
- 框架使用简单，只需要认证拦截器注册、登录 Token 生成、登出 Token 销毁即可；
安装教程
获取最新版本: go get -u -v github.com/goflyfox/gtoken/v2
使用说明
- 初始化配置 gtoken.Options {}, 并创建 gtoken 对象 (
gtoken.NewDefaultToken)；参数详情见《配置项说明》部分
- 注册认证中间件
gtoken.NewDefaultMiddleware(gfToken).Auth
- 登陆认证成功后，生成 Token（
gfToken.Generate）并返回给客户端
- 登出时销毁 Token (
gfToken.Destroy)
- 建议：由于中间件采用洋葱模型，注册MiddlewareAuth认证中间件，放在在MiddlewareCORS后，用户权限MiddlewareUserPermissions认证和Response处理MiddlewareHandlerResponse之前
// 创建gtoken对象
gftoken := gtoken.NewDefaultToken(gtoken.Options{})
s.Group("/", func(group *ghttp.RouterGroup) {
group.Middleware(CORS)
// 注册GfToken中间件
group.Middleware(gtoken.NewDefaultMiddleware(gfToken).Auth)
group.ALL("/system/data", func(r *ghttp.Request) {
// 获取登陆信息
_, data, err := gfToken.Get(r.Context(), r.GetCtxVar(gtoken.KeyUserKey).String())
if err != nil {
r.Response.WriteJson(RespError(err))
}
r.Response.WriteJson(RespSuccess(data))
})
group.ALL("/user/logout", func(r *ghttp.Request) {
// 登出销毁Token
_ = gfToken.Destroy(ctx, r.GetCtxVar(gtoken.KeyUserKey).String())
r.Response.WriteJson(RespSuccess("user logout"))
})
})
s.BindHandler("/login", func(r *ghttp.Request) {
// 认证成功调用Generate生成Token
token, err := gfToken.Generate(ctx, username, "1")
if err != nil {
r.Response.WriteJson(RespError(err))
r.ExitAll()
}
r.Response.WriteJson(RespSuccess(g.Map{
gtoken.KeyUserKey: username,
gtoken.KeyToken: token,
}))
})
配置项说明
具体可参考 GfToken 结构体，字段解释如下：
| 名称 |
配置字段 |
说明 |
| 缓存模式 |
CacheMode |
1 gcache 2 gredis 3 fileCache 默认 1 |
| 缓存 key |
CachePreKey |
默认缓存前缀 GToken: |
| 超时时间 |
Timeout |
默认 10 天（毫秒） |
| 缓存刷新时间 |
MaxRefresh |
默认为超时时间的一半（毫秒） |
| Token 分隔符 |
TokenDelimiter |
默认_ |
| Token 加密 key |
EncryptKey |
默认 12345678912345678912345678912345 |
| 是否支持多端登录 |
MultiLogin |
默认 false |
| 拦截排除地址 |
AuthExcludePaths |
拦截器参数：此路径列表不进行认证 |
| 拦截返回函数 |
ResFun |
拦截器参数：认证失败返回函数，默认返回Code：300 |
示例
使用示例，请先参考 gtoken/example/sample/test/backend/server.go 文件
感谢
- gf 框架 https://github.com/gogf/gf
- 历史文档 v1：https://goframe.org/pages/viewpage.action?pageId=1115974
