9 Unstar Star 38 Fork 8

goflyfox / gtoken

Create your Gitee Account
Explore and code with more than 5 million developers,Free private repositories !:)
Sign up
Clone or download
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README.md

gtoken

介绍

基于gf框架的token插件,通过服务端验证方式实现token认证;已完全可以支撑线上token认证,并支持集群模式;使用简单,大家可以放心使用;

  1. 支持单机gcache和集群gredis模式;
# 配置文件
# 缓存模式 1 gcache 2 gredis
cache-mode = 2
  1. 支持简单token认证
  2. 加入缓存自动续期功能
// 注:通过MaxRefresh,默认当用户第五天访问时,自动再进行五天续期
// 超时时间 默认10天
Timeout int
// 缓存刷新时间 默认为超时时间的一半
MaxRefresh int
  1. 支持全局拦截或者深度路径拦截,便于根据个人需求定制拦截器
// 是否是全局认证
GlobalMiddleware bool
  1. 框架使用简单,只需要设置登录验证方法以及登录、登出、拦截路径即可;

gtoken优势

  1. 有效的避免了jwt服务端无法退出问题;
  2. 可以解决jwt无法作废已颁布的令牌;
  3. 用户扩展信息仍存储在服务端,可有效的减少传输空间;
  4. gtoken支撑单点应用使用内存存储,也支持集群使用redis存储;
  5. 支持缓存自动续期,并且不需要客户端进行实现;

安装教程

  • gopath模式: go get github.com/goflyfox/gtoken
  • 或者 使用go.mod添加 :require github.com/goflyfox/gtoken latest

使用说明

只需要配置登录路径、登出路径、拦截路径以及登录校验实现即可

	// 启动gtoken
	gtoken := &gtoken.GfToken{
		LoginPath:       "/login",
		LoginBeforeFunc: loginFunc,
		LogoutPath:      "/user/logout",
		AuthPaths:        g.SliceStr{"/user", "/system"}, // 这里是按照前缀拦截,拦截/user /user/list /user/add ...
		GlobalMiddleware: true,                           // 开启全局拦截,默认关闭
	}
	gtoken.Start()

登录方法实现

func Login(r *ghttp.Request) (string, interface{}) {
	username := r.GetPostString("username")
	passwd := r.GetPostString("passwd")

	// TODO 进行登录校验

	return username, ""
}

路径拦截规则

    AuthPaths:        g.SliceStr{"/user", "/system"},             // 这里是按照前缀拦截,拦截/user /user/list /user/add ...
    AuthExcludePaths: g.SliceStr{"/user/info", "/system/user/*"}, // 不拦截路径  /user/info,/system/user/info,/system/user,
    GlobalMiddleware: true,                           // 开启全局拦截,默认关闭
  1. GlobalMiddleware:true全局拦截的是通过GF的BindMiddleware方法创建拦截/*
  2. GlobalMiddleware:false路径拦截的是通过GF的BindMiddleware方法创建拦截/user*和/system/*
  3. 按照中间件优先级路径拦截优先级很高;如果先实现部分中间件在认证前处理需要切换成全局拦截器,严格按照注册顺序即可;
  4. 程序先处理认证路径,如果满足;再排除不拦截路径;
  5. 如果只想用排除路径功能,将拦截路径设置为/*即可;

逻辑测试

可运行api_test.go进行测试并查看结果;验证逻辑说明:

  1. 访问用户信息,提示未携带token
  2. 登录后,携带token访问正常
  3. 登出成功
  4. 携带之前token访问,提示未登录
--- PASS: TestSystemUser (0.00s)
    api_test.go:43: 1. not login and visit user
    api_test.go:50: {"code":-1,"data":"","msg":"query token fail"}
    api_test.go:63: 2. execute login and visit user
    api_test.go:66: {"code":0,"msg":"success","data":"system user"}
    api_test.go:72: 3. execute logout
    api_test.go:75: {"code":0,"msg":"success","data":"logout success"}
    api_test.go:81: 4. visit user
    api_test.go:86: {"code":-1,"msg":"login timeout or not login","data":""}

感谢

  1. gf框架 https://github.com/gogf/gf

项目支持

jflyfox

Comments ( 4 )

Sign in for post a comment

About

基于gf框架的token插件,通过服务端验证方式实现token认证;已完全可以支撑线上token认证,并支持集群模式 spread retract
Go and 3 more languages
Apache-2.0
Cancel

Releases

No release

Gitee Metrics

Contributors

All

Activities

load more
can not load any more
Go
1
https://gitee.com/goflyfox/gtoken.git
git@gitee.com:goflyfox/gtoken.git
goflyfox
gtoken
gtoken
master

Search