gin框架中使用JWT的定義需求及解析

import (
	"github.com/dgrijalva/jwt-go"
)
// MyClaims 自定義宣告結構體並內嵌jwt.StandardClaims
// jwt包自帶的jwt.StandardClaims只包含了官方欄位
// 我們這裡需要額外記錄一個username欄位，所以要自定義結構體
// 如果想要儲存更多資訊，都可以新增到這個結構體中
type MyClaims struct {
	Username string `json:"username"`
	jwt.StandardClaims
}

const TokenExpireDuration = time.Hour * 2

var MySecret = []byte("夏天夏天悄悄過去")

// GenToken 生成JWT
func GenToken(username string) (string, error) {
	// 建立一個我們自己的宣告
	c := MyClaims{
		"username", // 自定義欄位
		jwt.StandardClaims{
			ExpiresAt: time.Now().Add(TokenExpireDuration).Unix(), // 過期時間
			Issuer:    "my-project",                               // 簽發人
		},
	}
	// 使用指定的簽名方法建立簽名物件
	token := jwt.NewWithClaims(jwt.SigningMethodHS256, c)
	// 使用指定的secret簽名並獲得完整的編碼後的字串token
	return token.SignedString(MySecret)
}

// 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")
}

r.POST("/auth", authHandler)

func authHandler(c *gin.Context) {
	// 使用者傳送使用者名稱和密碼過來
	var user UserInfo
	err := c.ShouldBind(&user)
	if err != nil {
		c.JSON(http.StatusOK, gin.H{
			"code": 2001,
			"msg":  "無效的引數",
		})
		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":  "鑑權失敗",
	})
	return
}

// JWTAuthMiddleware 基於JWT的認證中介軟體
func JWTAuthMiddleware() func(c *gin.Context) {
	return func(c *gin.Context) {
		// 使用者端攜帶Token有三種方式 1.放在請求頭 2.放在請求體 3.放在URI
		// 這裡假設Token放在Header的Authorization中，並使用Bearer開頭
		// 這裡的具體實現方式要依據你的實際業務情況決定
		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的函數來解析它
		mc, err := ParseToken(parts[1])
		if err != nil {
			c.JSON(http.StatusOK, gin.H{
				"code": 2005,
				"msg":  "無效的Token",
			})
			c.Abort()
			return
		}
		// 將當前請求的username資訊儲存到請求的上下文c上
		c.Set("username", mc.Username)
		c.Next() // 後續的處理常式可以用過c.Get("username")來獲取當前請求的使用者資訊
	}
}

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},
	})
}