当前位置：首页 > news >正文

在Gin框架中实现Token令牌认证

news 来源：原创 2024/9/25 16:59:01

什么是token

用户登录成功后，后续操作若需要用户的账号之类的信息一直让前端传递数据这种操作是不安全的，这个时候只需要用户登陆成功之后后端返回一串加密的字符串（token），由前端配置在Header中，这样又安全还能完美的解决问题。下面是生成token，验证token的步骤。

"github.com/dgrijalva/jwt-go" 使用的库

一、定义一个Token结构体

作者的项目token里包含了用户的账号密码及角色，大家按需来定义

// Claims Token结构体
type Claims struct {Username string `json:"username"`//账号Password string `json:"password"`//密码Role     string `json:"role"`//角色jwt.StandardClaims          //内置结构体，包含token令牌本身的信息
}

二、定义密钥＋生成密钥

我定义的密钥长度为七

// 定义密钥
var JwtKey = []byte("xlszxjm") //首字母大写，另一个文件中验证方法可以调用

// ReleaseToken 生成密钥
func ReleaseToken(username, password, role string) (string, error) {expirationTime := time.Now().Add(7 * 24 * time.Hour) //token的有效期是七天claims := &Claims{Username: username,Password: password,Role:     role,StandardClaims: jwt.StandardClaims{ExpiresAt: expirationTime.Unix(), //token的有效期IssuedAt:  time.Now().Unix(),     //token发放的时间Issuer:    "xxx",                 //作者（可修改）Subject:   "user token",          //主题},}token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)tokenString, err := token.SignedString(JwtKey) //根据前面自定义的Jwt秘钥生成tokentokenString = "Bearer " + tokenStringif err != nil {//返回生成的错误return "", err}//返回成功生成的字符换return tokenString, nil
}

三、解析token

// ParseToken 解析从前端获取到的token值
func ParseToken(tokenString string) (*jwt.Token, *Claims, error) {claims := &Claims{}token, err := jwt.ParseWithClaims(tokenString, &Claims{}, func(token *jwt.Token) (interface{}, error) {return JwtKey, nil})return token, claims, err
}

四、验证token是否合法的中间件

func AuthMiddleware() gin.HandlerFunc {return func(c *gin.Context) {// 获取前端传过来的信息tokenString := c.GetHeader("token")//验证前端传过来的token格式，不为空，开头为Bearerif tokenString == "" || !strings.HasPrefix(tokenString, "Bearer ") {response.ResponseError(c, 400)c.Abort()return}//验证通过，提取有效部分（除去Bearer)tokenString = tokenString[7:] //截取字符//解析tokentoken, _, err := ParseToken(tokenString)//使用解析token的方法//解析失败||解析后的token无效if err != nil || !token.Valid {response.ResponseError(c, 400)c.Abort()return}c.Next()}
}

五、通过token获取用户信息

// GetUsername 通过token获取username
func GetUsername(tokenString string) (string, error) {tokenString = tokenString[7:]token, _, err := ParseToken(tokenString)if err != nil {fmt.Println("GetUsername  ParseToken() err:", err.Error())return "", err}if claims, ok := token.Claims.(*Claims); ok {return claims.Username, nil}return "", nil
}// GetRole 通过token获取role
func GetRole(tokenString string) (string, error) {tokenString = tokenString[7:]token, _, err := ParseToken(tokenString)if err != nil {fmt.Println("GetRole ParseToken() err:", err)return "", err}if claims, ok := token.Claims.(*Claims); ok {return claims.Role, nil}return "", err
}

最后，只需要在用户登录的接口调用生成token的方法，将生成的token返回给前端并配置在Header中，把中间件添加在需要使用到c.GetHeader("token")方法的接口前以防止前端因配置失败出现错误。