gin-jwt对API进行权限控制
前言
之前文章简单介绍了如何运行gin+vue的前后端分离开源项目,该项目是学习了Gin实践教程后结合vue-element-admin写的,该教程讲得很详细,适合入门Gin。本篇文章将介绍gin+vue的前后端分离开源项目中如何使用gin-jwt对API进行权限验证。
安装gin-jwt
在GOPATH目录下运行
go get github.com/appleboy/gin-jwt
初始化jwt中间件
gin-jwt已经帮我们封装成中间件了,我们只需要设置并实例化它就可以直接用了。
现在来看看项目中middleware/myjwt/gin_jwt.go文件:
总的就是调用jwt.New
函数来实例化一个jwt.GinJWTMiddleware
然后我们看下jwt.GinJWTMiddleware
中定义的属性和方法
-
TokenLookup
:token检索模式,用于提取token,默认值为header:Authorization
。 -
SigningAlgorithm
:签名算法,默认值为HS256
-
Timeout
:token过期时间,默认值为time.Hour
-
TimeFunc
:测试或服务器在其他时区可设置该属性,默认值为time.Now
-
TokenHeadName
:token在请求头时的名称,默认值为Bearer
-
IdentityKey
:身份验证的key值,默认值为identity
-
Realm
:可以理解成该中间件的名称,用于展示,默认值为gin jwt
-
CookieName
:Cookie名称,默认值为jwt
-
privKey
:私钥 -
pubKey
:公钥 -
Authenticator
函数:根据登录信息对用户进行身份验证的回调函数 -
PayloadFunc
函数:登录期间的回调的函数 -
IdentityHandler
函数:解析并设置用户身份信息 -
Authorizator
函数:接收用户信息并编写授权规则,本项目的API权限控制就是通过该函数编写授权规则的 -
Unauthorized
函数:处理不进行授权的逻辑 -
LoginResponse
函数:完成登录后返回的信息,用户可自定义返回数据,默认返回
{
"code": http.StatusOK,
"token": token,
"expire": expire.Format(time.RFC3339)
}
-
RefreshResponse
函数:刷新token后返回的信息,用户可自定义返回数据,默认返回
{
"code": http.StatusOK,
"token": token,
"expire": expire.Format(time.RFC3339)
}
到这里我们应该就知道如何使用这个中间件了。
使用中间件
实例化中间件后,直接在路由组中使用该中间件就可以了