gin框架中使用JWT的定義需求及解析
什么是JWT?
JWT全稱JSON Web Token是一種跨域認證解決方案,屬于一個開放的標(biāo)準(zhǔn),它規(guī)定了一種Token實現(xiàn)方式,目前多用于前后端分離項目和OAuth3.0業(yè)務(wù)場景下。
為什么需要JWT?
在之前的一些web項目中,我們通常使用的是Cookie-Session
模式實現(xiàn)用戶認證。相關(guān)流程大致如下:
- 用戶在瀏覽器端填寫用戶名和密碼,并發(fā)送給服務(wù)端
- 服務(wù)端對用戶名和密碼校驗通過后會生成一份保存當(dāng)前用戶相關(guān)信息的session數(shù)據(jù)和一個與之對應(yīng)的標(biāo)識(通常稱為session_id)
- 服務(wù)端返回響應(yīng)時將上一步的session_id寫入用戶瀏覽器的Cookie
- 后續(xù)用戶來自該瀏覽器的每次請求都會自動攜帶包含session_id的Cookie
- 服務(wù)端通過請求中的session_id就能找到之前保存的該用戶那份session數(shù)據(jù),從而獲取該用戶的相關(guān)信息。
這種方案依賴于客戶端(瀏覽器)保存Cookie,并且需要在服務(wù)端存儲用戶的session數(shù)據(jù)。
在移動互聯(lián)網(wǎng)時代,我們的用戶可能使用瀏覽器也可能使用APP來訪問我們的服務(wù),我們的web應(yīng)用可能是前后端分開部署在不同的端口,有時候我們還需要支持第三方登錄,這下Cookie-Session
的模式就有些力不從心了。
JWT就是一種基于Token的輕量級認證模式,服務(wù)端認證通過后,會生成一個JSON對象,經(jīng)過簽名后得到一個Token(令牌)再發(fā)回給用戶,用戶后續(xù)請求只需要帶上這個Token,服務(wù)端解密之后就能獲取該用戶的相關(guān)信息了。
想要連接JWT的原理,推薦大家閱讀:JWT入門教程
生成JWT和解析JWT
我們在這里直接使用jwt-go
這個庫來實現(xiàn)我們生成JWT和解析JWT的功能。
定義需求
我們需要定制自己的需求來決定JWT中保存哪些數(shù)據(jù),比如我們規(guī)定在JWT中要存儲username
信息,那么我們就定義一個MyClaims
結(jié)構(gòu)體如下:
import ( "github.com/dgrijalva/jwt-go" ) // MyClaims 自定義聲明結(jié)構(gòu)體并內(nèi)嵌jwt.StandardClaims // jwt包自帶的jwt.StandardClaims只包含了官方字段 // 我們這里需要額外記錄一個username字段,所以要自定義結(jié)構(gòu)體 // 如果想要保存更多信息,都可以添加到這個結(jié)構(gòu)體中 type MyClaims struct { Username string `json:"username"` jwt.StandardClaims }
然后我們定義JWT的過期時間,這里以2小時為例:
const TokenExpireDuration = time.Hour * 2
接下來還需要定義Secret:
var MySecret = []byte("夏天夏天悄悄過去")
生成JWT
// GenToken 生成JWT func GenToken(username string) (string, error) { // 創(chuàng)建一個我們自己的聲明 c := MyClaims{ "username", // 自定義字段 jwt.StandardClaims{ ExpiresAt: time.Now().Add(TokenExpireDuration).Unix(), // 過期時間 Issuer: "my-project", // 簽發(fā)人 }, } // 使用指定的簽名方法創(chuàng)建簽名對象 token := jwt.NewWithClaims(jwt.SigningMethodHS256, c) // 使用指定的secret簽名并獲得完整的編碼后的字符串token return token.SignedString(MySecret) }
解析JWT
// ParseToken 解析JWT func ParseToken(tokenString string) (*MyClaims, error) { // 解析token token, err := jwt.ParseWithClaims(tokenString, &MyClaims{}, func(token *jwt.Token) (i interface{}, err error) { return MySecret, nil }) if err != nil { return nil, err } if claims, ok := token.Claims.(*MyClaims); ok && token.Valid { // 校驗token return claims, nil } return nil, errors.New("invalid token") }
在gin框架中使用JWT
首先我們注冊一條路由/auth
,對外提供獲取Token的渠道:
r.POST("/auth", authHandler)
我們的authHandler
定義如下:
func authHandler(c *gin.Context) { // 用戶發(fā)送用戶名和密碼過來 var user UserInfo err := c.ShouldBind(&user) if err != nil { c.JSON(http.StatusOK, gin.H{ "code": 2001, "msg": "無效的參數(shù)", }) return } // 校驗用戶名和密碼是否正確 if user.Username == "q1mi" && user.Password == "q1mi123" { // 生成Token tokenString, _ := GenToken(user.Username) c.JSON(http.StatusOK, gin.H{ "code": 2000, "msg": "success", "data": gin.H{"token": tokenString}, }) return } c.JSON(http.StatusOK, gin.H{ "code": 2002, "msg": "鑒權(quán)失敗", }) return }
用戶通過上面的接口獲取Token之后,后續(xù)就會攜帶著Token再來請求我們的其他接口,這個時候就需要對這些請求的Token進行校驗操作了,很顯然我們應(yīng)該實現(xiàn)一個檢驗Token的中間件,具體實現(xiàn)如下:
// JWTAuthMiddleware 基于JWT的認證中間件 func JWTAuthMiddleware() func(c *gin.Context) { return func(c *gin.Context) { // 客戶端攜帶Token有三種方式 1.放在請求頭 2.放在請求體 3.放在URI // 這里假設(shè)Token放在Header的Authorization中,并使用Bearer開頭 // 這里的具體實現(xiàn)方式要依據(jù)你的實際業(yè)務(wù)情況決定 authHeader := c.Request.Header.Get("Authorization") if authHeader == "" { c.JSON(http.StatusOK, gin.H{ "code": 2003, "msg": "請求頭中auth為空", }) c.Abort() return } // 按空格分割 parts := strings.SplitN(authHeader, " ", 2) if !(len(parts) == 2 && parts[0] == "Bearer") { c.JSON(http.StatusOK, gin.H{ "code": 2004, "msg": "請求頭中auth格式有誤", }) c.Abort() return } // parts[1]是獲取到的tokenString,我們使用之前定義好的解析JWT的函數(shù)來解析它 mc, err := ParseToken(parts[1]) if err != nil { c.JSON(http.StatusOK, gin.H{ "code": 2005, "msg": "無效的Token", }) c.Abort() return } // 將當(dāng)前請求的username信息保存到請求的上下文c上 c.Set("username", mc.Username) c.Next() // 后續(xù)的處理函數(shù)可以用過c.Get("username")來獲取當(dāng)前請求的用戶信息 } }
注冊一個/home
路由,發(fā)個請求驗證一下吧。
r.GET("/home", JWTAuthMiddleware(), homeHandler) func homeHandler(c *gin.Context) { username := c.MustGet("username").(string) c.JSON(http.StatusOK, gin.H{ "code": 2000, "msg": "success", "data": gin.H{"username": username}, }) }
如果不想自己實現(xiàn)上述功能,你也可以使用Github上別人封裝好的包。
以上就是gin框架中使用JWT的定義需求及解析的詳細內(nèi)容,更多關(guān)于gin框架中使用JWT的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
Go語言高效I/O并發(fā)處理雙緩沖和Exchanger模式實例探索
這篇文章主要介紹了Go語言高效I/O并發(fā)處理雙緩沖和Exchanger模式實例探索,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2024-01-01Go 結(jié)構(gòu)體、數(shù)組、字典和 json 字符串的相互轉(zhuǎn)換方法
今天小編就為大家分享一篇Go 結(jié)構(gòu)體、數(shù)組、字典和 json 字符串的相互轉(zhuǎn)換方法,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2019-08-08