GoFly框架登录Token使用

token是验证请求接口用户身份的标识，框架建议开发者在识别用户身份时使用token尽量不要明文传用户标识数据。 

一、生成用户登录token

通过routeuse.GenerateToken生成登录token，方法返回生成的token字符串和err错误提示，其中routeuse.UserClaims是您要token记录用户信息，ID是登录的用户ID（必填），其他参数下面有说明，其他参数根据需要选择添加。

//生成token方式一
token, err := routeuse.GenerateToken(&routeuse.UserClaims{
    ID:         res["id"].Int64(),
    Accountid:  res["accountID"].Int64(),
    BusinessID: res["businessID"].Int64(),
})
//生成token方式二（2.2.6版本）参数：gf.Map{"ID": 1,"Accountid": 1,"BusinessID": 1}参数个数更加业务需求添加
token, err := gf.CreateToken(gf.Map{"ID": user_id})
if err != nil {
    gf.Failed().SetMsg(err.Error()).Regin(c)
} else {
    gf.Success().SetMsg("登录成功返回token！").SetData(token).Regin(c)
}

当前token用户存储的用户信息如下：

ID         int64  `json:"id"`         //用户数据id
Accountid  int64  `json:"accountid"`  //A端主账号id
BusinessID int64  `json:"businessID"` //B端主账号id

二、刷新Token

如果请求头中有token则在 gf.Success().SetMsg("请求成功返回").Regin(c)  返回中我们统一封装返回最新Token，如果需要手动刷新token则用下面方法刷新。

token := c.Request.Header.Get("Authorization")
newtoken, err := routeuse.Refresh(token)
if err != nil {
    gf.Failed().SetMsg(err.Error()).Regin(c)
} else {
    gf.Success().SetMsg("刷新token").SetData(newtoken).Regin(c)
}

三、退出登录

退出登录自己处理token失效，jwt是把token信息都存储在加密字符串，不存储数据，无法提供token字符串过期处理，社区建议退出登录把前端token清空即可，在项目开发中一般设计来说用不到token销毁，用户退出登录后前端后清除token，接口不会再传token，而且token也会过期。特殊情况自己选择判断退出登录方式，为了性能框架不做退出登录销毁操作，我们框架不强制使用Redis，所以无法指定Redis来做验证记录存储，内置缓存不可滥用，可能会导致内存消耗增大。如果项目特殊要求必须销毁，可使用缓存存储和数据库来记录已经销毁的token。

//退出登录
func (api *Index) Logout(c *gf.GinCtx) {
    user, err := gf.ParseTokenNoValid(c) //当前用户
    if err == nil {
    //把用户信息登录状态loginstatus修改为已退出登录
        gf.Model("business_account").Where("id", user.ID).Data(gf.Map{"loginstatus": 0}).Update()
    }
    gf.Success().SetMsg("退出登录").SetData(true).Regin(c)
}

四、解析token获取用户信息

获取用户信息分两种情况，一是请求接口需要token验证，另一种是请求接口不需要token验证的。

1.需要token验证

需要验证接口在请求时gin框架中间件就开始验证用户token信息，通过验证的我们把解析好的用户信息放在请求上下文，通过 gf.GetUserInfo(c)获取用户信息，代码如下：

//1.方法一(推荐) 
//框架版本>=2.2.0
//请求中间件拦截验证，失败直接返回验证失败提示（验证失败直接返回错误，验证通过才往下执行，并直接获取用户id 或者token更多信息）
getuser, _ := c.Get("user") //当前用户
user := getuser.(gf.UserObj)//把获取数据转成User用户对象就可user.ID获取用户的id了，同样user.AccountID， user.BusinessID获取账号的accountID和businessID
//或者只获取用户id
user_id, _ := c.Get("userID") //当前用户ID
accountID, _ := c.Get("accountID") //当前添加当前用户的账号（也就是添加本账号数据的用户userID）
businessID, _ := c.Get("businessID") //当前用户businessID(saas账号ID)
//2.方法二 
//不返回错误提示
user, exists := gf.GetUserInfo(c) //当前用户
if !exists {
    gf.Failed().SetMsg("登录失效").Regin(c)
    return
}
//3.方法三（2.2.1后拦截时直接返回错误提示）
//返回错误信息
user, err := gf.GetUserInfoErr(c) //当前用户
if err!=nil {
    gf.Failed().SetMsg(err.Error()).Regin(c)
    return
}
// user.ID 就获取用户的
// user.AccountID 就获取business_accounta用户表对应用户数据的account_id
// user.BusinessID 就获取business_accounta用户表对应用户数据的business_id

2.不需要token验证的接口

因为需要token验证，请求时候gin框架路由中间件基于不会拦截做token验证，所以请求头就不存在用户信息，只能通过请求传过来的token字符串直接解析获取用户信息。用 gf.ParseTokenGetInfo(c)返回获取用户信息。

user, err := gf.ParseTokenGetInfo(c)
if err != nil {
    gf.Failed().SetMsg("登录失效请重新登录！").SetData(err).Regin(c)
}
// user.ID 就获取用户的id

或者你自己调用jwt中的方法解析

token := c.Request.Header.Get("Authorization")
user, err = routeuse.ParseToken(token)
// user.ID 就获取用户的id

Token的应用就这些没如果还有不明白可咨询gofly技术支持客服微信。

3.仅获取token信息-不需验证

    data, err := gf.ParseTokenNoValid(c)
    if err != nil {
        gf.Failed().SetMsg("获取token信息失败").SetData(err.Error()).SetExdata(data).Regin(c)
    } else {
        gf.Success().SetMsg("获取token信息成功").SetData(data).Regin(c)
    }

五、前端请求接口传递token

前端调用后端api接口时，如果接口是需要token信息的，那么我们在接口请求头添加 Authorization 字段来传递token内容字符串，如下：

headers={Authorization:token字符串内容""}

其中token通过您登录接口返回即可。