gtoken替換jwt實現sso登入的問題小結

2022-05-27 14:00:32

jwt的問題

首先說明一個jwt存在的問題，也就是要替換jwt的原因：

jwt無法在伺服器端主動退出的問題
jwt無法作廢已頒佈的令牌，只能等到令牌過期問題
jwt攜帶大量使用者擴充套件資訊導致降低傳輸效率問題

jwt的請求流程圖

gtoken的優勢

gtoken的請求流程和jwt的基本一致。

gtoken的優勢就是能幫助我們解決jwt的問題，另外還提供好用的特性，比如：

gtoken支撐單點應用測試使用記憶體儲存，支援個人專案檔案儲存，也支援企業叢集使用redis儲存；完全適用於企業生產級使用；
有效的避免了jwt伺服器端無法退出問題；
解決jwt無法作廢已頒佈的令牌，只能等到令牌過期問題；
通過使用者擴充套件資訊儲存在伺服器端，有效規避了jwt攜帶大量使用者擴充套件資訊導致降低傳輸效率問題；
有效避免jwt需要使用者端實現續簽功能，增加使用者端複雜度；支援伺服器端自動續期，使用者端不需要關心續簽邏輯；

注意問題

支援伺服器端快取自動續期功能，不需要通過refresh_token重新整理token，簡化了使用者端的操作
版本問題千萬注意：在gtoken v1.5.0全面適配GoFrame v2.0.0 ; GoFrame v1.X.X 請使用GfToken v1.4.X相關版本

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

演示demo

下面的演示demo可以複製到本地main.go檔案中執行，更新依賴的時候千萬注意版本。

重點說一下踩的坑：

Login方法會要求我們返回兩個值：

第一個值對應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 := &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"))
      })
   })
   // 啟動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("賬號或密碼錯誤."))
      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()
}

啟動專案：