Starter

README

go-jwt

go-jwt

Documentation

Index

• Variables
• type CustomClaims
• type JWT
  • func NewJwt(signKey string) *JWT
  • func (j *JWT) CreateToken(claims CustomClaims) (string, error)
  • func (j *JWT) ParseToken(tokenString string) (*CustomClaims, error)
  • func (j *JWT) RefreshToken(tokenString string) (string, error)

Variables

var (
	// token错误信息的定义
	// 是否过期的token err
	TokenExpired error = errors.New("Token过期")
	// 是否为激活的token
	TokenNotValidYet error = errors.New("Token不存在")
	// 是否是正确格式的token
	TokenMalformed error = errors.New("Token格式有误")
	// 是否有效的token
	TokenInvalid error = errors.New("不是有效的token")
)

一些常量

Types

type CustomClaims

type CustomClaims struct {
	ID       int    `json:"userId"`   // 用户id
	Mobile   string `json:"mobile"`   // 手机号
	Avatar   string `json:"avatar"`   // 头像
	NickName string `json:"nickname"` // 昵称
	Openid   string `json:"openid"`   // openid
	jwt.StandardClaims
}

* @Author yNsLuHan * @Description:载荷，可以加一些自己需要的信息 用户token中科院提取用户信息之类

type JWT

type JWT struct {
	SigningKey []byte
}

*

• @Author yNsLuHan
• @Description: JWT 签名结构

func NewJwt

func NewJwt(signKey string) *JWT

*

• @Author yNsLuHan
• @Description: 新建一个jwt实例, 整个Jwt创建入口
• @Time 2021-06-22 11:13:09
• @return *JWT

func (*JWT) CreateToken

func (j *JWT) CreateToken(claims CustomClaims) (string, error)

*

• @Author yNsLuHan
• @Description: 生成一个token
• @Time 2021-06-22 11:14:07
• @receiver j
• @param claims
• @return string
• @return error

func (*JWT) ParseToken

func (j *JWT) ParseToken(tokenString string) (*CustomClaims, error)

*

• @Author yNsLuHan
• @Description: 解析token
• @Time 2021-06-22 11:14:32
• @receiver j
• @param tokenString
• @return *CustomClaims
• @return error

func (*JWT) RefreshToken

func (j *JWT) RefreshToken(tokenString string) (string, error)

*

• @Author yNsLuHan
• @Description: 更新token
• @Time 2021-06-22 11:14:40
• @receiver j
• @param tokenString
• @return string
• @return error