自拍偷在线精品自拍偷,亚洲欧美中文日韩v在线观看不卡

通過(guò)閱讀源碼解決項(xiàng)目難題:GToken替換JWT實(shí)現(xiàn)SSO單點(diǎn)登錄

開發(fā) 后端
今天和大家分享一下使用GoFrame的gtoken替換jwt實(shí)現(xiàn)sso登錄的經(jīng)驗(yàn)。期間我也踩了一些坑,最終是通過(guò)閱讀源碼解決了項(xiàng)目中遇到的問題。

覺得這個(gè)經(jīng)歷比較有意思,整理一篇文章分享給大家。

圖片

jwt的問題

首先說(shuō)明一個(gè)jwt存在的問題,也就是要替換jwt的原因:

jwt無(wú)法在服務(wù)端主動(dòng)退出的問題

jwt無(wú)法作廢已頒布的令牌,只能等到令牌過(guò)期問題

jwt攜帶大量用戶擴(kuò)展信息導(dǎo)致降低傳輸效率問題

jwt的請(qǐng)求流程圖

圖片

gtoken的優(yōu)勢(shì)

gtoken的請(qǐng)求流程和jwt的基本一致。

gtoken的優(yōu)勢(shì)就是能幫助我們解決jwt的問題,另外還提供好用的特性,比如:

  • gtoken支持單點(diǎn)應(yīng)用使用內(nèi)存存儲(chǔ),支持個(gè)人項(xiàng)目文件存儲(chǔ),也支持企業(yè)集群使用redis存儲(chǔ),完全適用于個(gè)人和企業(yè)生產(chǎn)級(jí)使用;
  • 有效避免了jwt服務(wù)端無(wú)法退出問題;
  • 解決jwt無(wú)法作廢已頒布的令牌,只能等到令牌過(guò)期問題;
  • 通過(guò)用戶擴(kuò)展信息存儲(chǔ)在服務(wù)端,有效規(guī)避了jwt攜帶大量用戶擴(kuò)展信息導(dǎo)致降低傳輸效率問題;
  • 有效避免jwt需要客戶端實(shí)現(xiàn)續(xù)簽功能,增加客戶端復(fù)雜度;支持服務(wù)端自動(dòng)續(xù)期,客戶端不需要關(guān)心續(xù)簽邏輯;

注意問題

支持服務(wù)端緩存自動(dòng)續(xù)期功能,不需要通過(guò)refresh_token刷新token,簡(jiǎn)化了客戶端的操作

版本問題千萬(wàn)注意:在gtoken v1.5.0全面適配GoFrame v2.0.0 ; GoFrame v1.X.X 請(qǐng)使用GfToken v1.4.X相關(guān)版本

TIPS:下面我的演示demo和源碼閱讀都是基于v1.4.x版本的。

后面會(huì)更新視頻教程,帶大家完成最新版goframe和gtoken的教程,有需要的小伙伴可以關(guān)注我一下。

演示demo

下面的演示demo可以復(fù)制到本地main.go文件中執(zhí)行,更新依賴包的時(shí)候千萬(wàn)注意版本。

重點(diǎn)說(shuō)一下踩的坑,Login方法會(huì)要求我們返回兩個(gè)值:

第一個(gè)值對(duì)應(yīng)userKey,后續(xù)我們可以根據(jù)userKey獲得token

第二個(gè)值對(duì)應(yīng)data,是interface{}類型,我們可以在這里定義例如userid、username等數(shù)據(jù)。

先有這個(gè)概念即可,為了讓大家更好理解,文章最后會(huì)帶大家讀源碼。

入門示例

代碼段的關(guān)鍵邏輯,已經(jīng)添加了注釋。

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

/*
統(tǒng)一路由注冊(cè)
*/
func initRouter(s *ghttp.Server) {
// 不認(rèn)證接口
s.Group("/", func(group *ghttp.RouterGroup) {
group.Middleware(CORS)

// 調(diào)試路由
group.ALL("/hello", func(r *ghttp.Request) {
r.Response.WriteJson(gtoken.Succ("hello"))
})
})

// 認(rèn)證接口
loginFunc := Login
// 啟動(dòng)gtoken
gfToken := &gtoken.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"))
})
})

// 啟動(dòng)gtoken
gfAdminToken := &gtoken.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("賬號(hào)或密碼錯(cuò)誤."))
r.ExitAll()
}

return username, "1"
/**
返回的第一個(gè)參數(shù)對(duì)應(yīng):userKey
返回的第二個(gè)參數(shù)對(duì)應(yīng):data
{
"code": 0,
"msg": "success",
"data": {
"createTime": 1652838582190,
"data": "1",
"refreshTime": 1653270582190,
"userKey": "王中陽(yáng)",
"uuid": "ac75676efeb906f9959cf35f779a1d38"
}
}
*/
}

// 跨域
func CORS(r *ghttp.Request) {
r.Response.CORSDefault()
r.Middleware.Next()
}

運(yùn)行效果

啟動(dòng)項(xiàng)目:

圖片

訪問不認(rèn)證接口:返回成功

圖片

未登錄時(shí)訪問認(rèn)證接口:返回錯(cuò)誤提示

圖片

請(qǐng)求登錄接口:返回token

圖片

攜帶token再次訪問認(rèn)證接口:返回成功

圖片

以上就跑通了主體流程,就是這么簡(jiǎn)單。

分析源碼

下面帶大家分析一下源碼,學(xué)習(xí)一下作者是如何設(shè)計(jì)的。

刷新token

首先我認(rèn)為gtoken很好的設(shè)計(jì)思想是不使用refresh_token來(lái)刷新token,而是服務(wù)端主動(dòng)刷新。

在源碼的getToken方法中做了更新refreshTime和createTime的處理。

更新createTime為當(dāng)前時(shí)間,refreshTime為當(dāng)前時(shí)間+自定義的刷新時(shí)間。

圖片

如下圖所示,getToken方法在每次執(zhí)行validToken校驗(yàn)token的時(shí)候都會(huì)調(diào)用,即每次校驗(yàn)token有效性時(shí),如果符合刷新token有效期的條件,就會(huì)進(jìn)行刷新操作(刷新token的過(guò)期時(shí)間,token值不變)

圖片

這樣就實(shí)現(xiàn)了無(wú)感刷新token。

GfToken結(jié)構(gòu)體

我們?cè)賮?lái)看一下GfToken的結(jié)構(gòu)體,更好的理解一下作者的設(shè)計(jì)思路:

因?yàn)镃acheMode支持redis,也就意味著支持集群模式。

我們?cè)趩?dòng)gtoken的時(shí)候,只需要設(shè)置登錄和登出路徑,另外登錄和登出都提供了BeforeFunc和AfterFunc,讓我們能清晰界定使用場(chǎng)景。

// GfToken gtoken結(jié)構(gòu)體
type GfToken struct {
// GoFrame server name
ServerName string
// 緩存模式 1 gcache 2 gredis 默認(rèn)1
CacheMode int8
// 緩存key
CacheKey string
// 超時(shí)時(shí)間 默認(rèn)10天(毫秒)
Timeout int
// 緩存刷新時(shí)間 默認(rèn)為超時(shí)時(shí)間的一半(毫秒)
MaxRefresh int
// Token分隔符
TokenDelimiter string
// Token加密key
EncryptKey []byte
// 認(rèn)證失敗中文提示
AuthFailMsg string
// 是否支持多端登錄,默認(rèn)false
MultiLogin bool
// 是否是全局認(rèn)證,兼容歷史版本,已廢棄
GlobalMiddleware bool
// 中間件類型 1 GroupMiddleware 2 BindMiddleware 3 GlobalMiddleware
MiddlewareType uint

// 登錄路徑
LoginPath string
// 登錄驗(yàn)證方法 return userKey 用戶標(biāo)識(shí) 如果userKey為空,結(jié)束執(zhí)行
LoginBeforeFunc func(r *ghttp.Request) (string, interface{})
// 登錄返回方法
LoginAfterFunc func(r *ghttp.Request, respData Resp)
// 登出地址
LogoutPath string
// 登出驗(yàn)證方法 return true 繼續(xù)執(zhí)行,否則結(jié)束執(zhí)行
LogoutBeforeFunc func(r *ghttp.Request) bool
// 登出返回方法
LogoutAfterFunc func(r *ghttp.Request, respData Resp)

// 攔截地址
AuthPaths g.SliceStr
// 攔截排除地址
AuthExcludePaths g.SliceStr
// 認(rèn)證驗(yàn)證方法 return true 繼續(xù)執(zhí)行,否則結(jié)束執(zhí)行
AuthBeforeFunc func(r *ghttp.Request) bool
// 認(rèn)證返回方法
AuthAfterFunc func(r *ghttp.Request, respData Resp)
}

思考題

我有N個(gè)子系統(tǒng)如何用gtoken實(shí)現(xiàn)sso登錄呢?即實(shí)現(xiàn)一個(gè)子系統(tǒng)登錄,其他各個(gè)子系統(tǒng)都自動(dòng)登錄,而無(wú)需二次登錄呢?

想一想

.

.

.

我想到的解決方案是配合cookie實(shí)現(xiàn):各個(gè)子系統(tǒng)二級(jí)域名不一致,但是主域名一致。

我在登錄之后把token寫入主域名的cookie中進(jìn)行共享,前端網(wǎng)站通過(guò)cookie獲得token請(qǐng)求服務(wù)接口。

同時(shí)在刷新token之后,也要刷新cookie的有效期,避免cookie失效導(dǎo)致獲取不到token。

進(jìn)一步閱讀源碼

在經(jīng)過(guò)又一次仔細(xì)閱讀源碼之后,找到了刷新cookie有效期的合適場(chǎng)景:AuthAfterFunc,我們可以重寫這個(gè)方法,來(lái)實(shí)現(xiàn)驗(yàn)證通過(guò)后的操作:

如果token驗(yàn)證有效則刷新cookie有效期;如果驗(yàn)證無(wú)效則自定義返回信息。(往往我們自己項(xiàng)目中的code碼和gtoken定義的不一致,但是gtoken支持非常方便的重寫返回值)

圖片

總結(jié)

我們項(xiàng)目之前是使用jwt實(shí)現(xiàn)sso登錄,在剛剛拿到需求要重寫時(shí),自己也是一頭霧水。

在沒有認(rèn)真閱讀gtoken源碼之前,我已經(jīng)設(shè)計(jì)了refresh_token刷新的策略。

在仔細(xì)閱讀源碼之后,發(fā)現(xiàn)真香。

這次經(jīng)歷最大的收獲是:碰到不好解決的問題,帶著問題去閱讀源碼是非常高效的方式。

本文轉(zhuǎn)載自微信公眾號(hào)「 程序員升級(jí)打怪之旅」,作者「王中陽(yáng)Go」,可以通過(guò)以下二維碼關(guān)注。

轉(zhuǎn)載本文請(qǐng)聯(lián)系「 程序員升級(jí)打怪之旅」公眾號(hào)。

責(zé)任編輯:武曉燕 來(lái)源: 程序員升級(jí)打怪之旅
相關(guān)推薦

2024-09-27 12:13:26

GoGTokenSSO

2020-12-28 05:52:27

SSO登錄單點(diǎn)

2024-06-21 09:28:43

2021-01-18 06:21:18

登錄SSO接口

2021-10-29 13:26:54

單點(diǎn)登錄SSO

2024-08-12 08:12:38

2024-03-01 11:33:31

2020-05-15 08:07:33

JWT登錄單點(diǎn)

2022-05-12 07:37:51

單點(diǎn)登錄微服務(wù)開源

2023-11-08 14:57:41

2021-09-28 10:48:07

開源雙因素認(rèn)證單點(diǎn)登錄

2023-05-31 19:10:31

2021-06-01 06:01:35

SSO單點(diǎn)登錄

2016-12-26 18:05:00

單點(diǎn)登錄原理簡(jiǎn)單實(shí)現(xiàn)

2024-09-11 08:37:39

2023-12-11 13:05:21

2012-02-14 14:17:35

ibmdw

2021-06-24 08:52:19

單點(diǎn)登錄代碼前端

2019-07-24 15:12:08

單點(diǎn)登錄SSO密碼

2010-12-24 18:42:20

BMC業(yè)務(wù)服務(wù)管理
點(diǎn)贊
收藏

51CTO技術(shù)棧公眾號(hào)