网上学习资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。
一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人,都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!
- 第一个值对应userKey,后续我们可以根据userKey获得token
- 第二个值对应data,是interface{}类型,我们可以在这里定义例如userid、username等数据。
先有这个概念即可,为了让大家更好的理解,文章最后会带大家读源码。
入门示例
代码段的关键逻辑,已经添加了注释。
package main
import (
"github.com/goflyfox/gtoken/gtoken"
"github.com/gogf/gf/frame/g"
"github.com/gogf/gf/net/ghttp"
"github.com/gogf/gf/os/glog"
)
var TestServerName string
//var TestServerName string = "gtoken"
func main() {
glog.Info("########service start...")
g.Cfg().SetPath("example/sample")
s := g.Server(TestServerName)
initRouter(s)
glog.Info("########service finish.")
s.Run()
}
var gfToken \*gtoken.GfToken
/\*
统一路由注册
\*/
func initRouter(s \*ghttp.Server) {
// 不认证接口
s.Group("/", func(group \*ghttp.RouterGroup) {
group.Middleware(CORS)
// 调试路由
group.ALL("/hello", func(r \*ghttp.Request) {
r.Response.WriteJson(gtoken.Succ("hello"))
})
})
// 认证接口
loginFunc := Login
// 启动gtoken
gfToken := >oken.GfToken{
ServerName: TestServerName,
LoginPath: "/login",
LoginBeforeFunc: loginFunc,
LogoutPath: "/user/logout",
AuthExcludePaths: g.SliceStr{"/user/info", "/system/user/info"}, // 不拦截路径 /user/info,/system/user/info,/system/user,
MultiLogin: g.Config().GetBool("gToken.MultiLogin"),
}
s.Group("/", func(group \*ghttp.RouterGroup) {
group.Middleware(CORS)
gfToken.Middleware(group)
group.ALL("/system/user", func(r \*ghttp.Request) {
r.Response.WriteJson(gtoken.Succ("system user"))
})
group.ALL("/user/data", func(r \*ghttp.Request) {
r.Response.WriteJson(gfToken.GetTokenData(r))
})
group.ALL("/user/info", func(r \*ghttp.Request) {
r.Response.WriteJson(gtoken.Succ("user info"))
})
group.ALL("/system/user/info", func(r \*ghttp.Request) {
r.Response.WriteJson(gtoken.Succ("system user info"))
})
})
// 启动gtoken
gfAdminToken := >oken.GfToken{
ServerName: TestServerName,
//Timeout: 10 \* 1000,
LoginPath: "/login",
LoginBeforeFunc: loginFunc,
LogoutPath: "/user/logout",
AuthExcludePaths: g.SliceStr{"/admin/user/info", "/admin/system/user/info"}, // 不拦截路径 /user/info,/system/user/info,/system/user,
MultiLogin: g.Config().GetBool("gToken.MultiLogin"),
}
s.Group("/admin", func(group \*ghttp.RouterGroup) {
group.Middleware(CORS)
gfAdminToken.Middleware(group)
group.ALL("/system/user", func(r \*ghttp.Request) {
r.Response.WriteJson(gtoken.Succ("system user"))
})
group.ALL("/user/info", func(r \*ghttp.Request) {
r.Response.WriteJson(gtoken.Succ("user info"))
})
group.ALL("/system/user/info", func(r \*ghttp.Request) {
r.Response.WriteJson(gtoken.Succ("system user info"))
})
})
}
func Login(r \*ghttp.Request) (string, interface{}) {
username := r.GetString("username")
passwd := r.GetString("passwd")
if username == "" || passwd == "" {
r.Response.WriteJson(gtoken.Fail("账号或密码错误."))
r.ExitAll()
}
return username, "1"
/\*\*
返回的第一个参数对应:userKey
返回的第二个参数对应:data
{
"code": 0,
"msg": "success",
"data": {
"createTime": 1652838582190,
"data": "1",
"refreshTime": 1653270582190,
"userKey": "王中阳",
"uuid": "ac75676efeb906f9959cf35f779a1d38"
}
}
\*/
}
// 跨域
func CORS(r \*ghttp.Request) {
r.Response.CORSDefault()
r.Middleware.Next()
}
运行效果
启动项目:
访问不认证接口:返回成功
未登录时访问认证接口:返回错误提示
请求登录接口:返回token
携带token再次访问认证接口:返回成功
以上就跑通了主体流程,就是这么简单。
分析源码
下面带大家分析一下源码,学习一下作者是如何设计的。
刷新token
首先我认为gtoken很好的设计思想是不使用refresh_token来刷新token,而是服务端主动刷新。
在源码的getToken
方法中做了更新refreshTime和createTime的处理。
更新createTime为当前时间,refreshTime为当前时间+自定义的刷新时间。
如下图所示,getToken
方法在每次执行validToken
校验token的时候都会调用,即每次校验token有效性时,如果符合刷新token有效期的条件,就会进行刷新操作(刷新token的过期时间,token值不变)
这样就实现了无感刷新token。
GfToken结构体
我们再来看一下GfToken的结构体,更好的理解一下作者的设计思路:
- 因为CacheMode支持redis,也就意味着支持集群模式。
- 我们在启动gtoken的时候,只需要设置登录和登出路径,另外登录和登出都提供了
BeforeFunc
和AfterFunc
,让我们能清晰的界定使用场景。
// GfToken gtoken结构体
type GfToken struct {
// GoFrame server name
ServerName string
// 缓存模式 1 gcache 2 gredis 默认1
CacheMode int8
// 缓存key
CacheKey string
// 超时时间 默认10天(毫秒)
Timeout int
// 缓存刷新时间 默认为超时时间的一半(毫秒)
MaxRefresh int
// Token分隔符
TokenDelimiter string
// Token加密key
EncryptKey []byte
// 认证失败中文提示
AuthFailMsg string
// 是否支持多端登录,默认false
MultiLogin bool
// 是否是全局认证,兼容历史版本,已废弃
GlobalMiddleware bool
// 中间件类型 1 GroupMiddleware 2 BindMiddleware 3 GlobalMiddleware
MiddlewareType uint
// 登录路径
LoginPath string
// 登录验证方法 return userKey 用户标识 如果userKey为空,结束执行
LoginBeforeFunc func(r \*ghttp.Request) (string, interface{})
// 登录返回方法
LoginAfterFunc func(r \*ghttp.Request, respData Resp)
// 登出地址
LogoutPath string
// 登出验证方法 return true 继续执行,否则结束执行
LogoutBeforeFunc func(r \*ghttp.Request) bool
// 登出返回方法
LogoutAfterFunc func(r \*ghttp.Request, respData Resp)
// 拦截地址
AuthPaths g.SliceStr
// 拦截排除地址
![img](https://img-blog.csdnimg.cn/img_convert/506be11817b46a1ef7547ae8f9ff5e8d.png)
![img](https://img-blog.csdnimg.cn/img_convert/7ac995893d59ab0b223f0c7d9d249c7d.png)
![img](https://img-blog.csdnimg.cn/img_convert/38dd4a25807681e774278ac028d0a583.png)
**既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,涵盖了95%以上Go语言开发知识点,真正体系化!**
**由于文件比较多,这里只是将部分目录截图出来,全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频,并且后续会持续更新**
**[如果你需要这些资料,可以戳这里获取](https://bbs.csdn.net/topics/618658159)**
中...(img-bBHs06fj-1715490011042)]
[外链图片转存中...(img-KoAxpmjj-1715490011042)]
**既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,涵盖了95%以上Go语言开发知识点,真正体系化!**
**由于文件比较多,这里只是将部分目录截图出来,全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频,并且后续会持续更新**
**[如果你需要这些资料,可以戳这里获取](https://bbs.csdn.net/topics/618658159)**