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

Posted on by

今天和大傢分享一下使用gtoken替換jwt實現sso登錄的經驗，為瞭讓大傢更好的理解會帶大傢讀一下重點的源碼。

jwt的問題

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

  • jwt無法在服務端主動退出的問題
  • jwt無法作廢已頒佈的令牌，隻能等到令牌過期問題
  • jwt攜帶大量用戶擴展信息導致降低傳輸效率問題

jwt的請求流程圖

gtoken的優勢

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

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

  1. gtoken支撐單點應用測試使用內存存儲，支持個人項目文件存儲，也支持企業集群使用redis存儲；完全適用於企業生產級使用；
  2. 有效的避免瞭jwt服務端無法退出問題；
  3. 解決jwt無法作廢已頒佈的令牌，隻能等到令牌過期問題；
  4. 通過用戶擴展信息存儲在服務端，有效規避瞭jwt攜帶大量用戶擴展信息導致降低傳輸效率問題；
  5. 有效避免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()
}

啟動項目：

訪問不認證接口：返回成功

 

 

未登錄時訪問認證接口：返回錯誤

請求登錄接口：返回token

攜帶token再次訪問認證接口：返回成功

以上就跑通瞭主體流程，就是這麼簡單。

到此這篇關於gtoken替換jwt實現sso登錄的文章就介紹到這瞭,更多相關gtoken實現sso登錄內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：