Skip to content

Commit

Permalink
Merge pull request #14 from goflyfox/dev-tmp
Browse files Browse the repository at this point in the history 
merge group middleware function
  • Loading branch information
@zcool321
zcool321 committed Nov 29, 2020
2 parents 82dff30 + 0bd9b41 commit 99b5b49
Show file tree
Hide file tree
Showing 22 changed files with 1,114 additions and 314 deletions.
4 changes: 4 additions & 0 deletions ChangeLog.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
Change Log 更新说明
------------------------------
## 2020-11-29 v1.4.0
1. 加入Group Middleware实现，契合官网推荐方式；
2. 完美兼容历史Global Middleware版本；

## 2020-11-27
1. gf升级为V1.14.5

Expand Down
170 changes: 137 additions & 33 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,48 +1,125 @@
# gtoken

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

1. 支持单机gcache和集群gredis模式；
* github地址：https://github.com/goflyfox/gtoken
* gitee地址：https://gitee.com/goflyfox/gtoken

## gtoken优势
1. gtoken支撑单点应用使用内存存储，也支持集群使用redis存储；完全适用于企业生产级使用；
2. 有效的避免了jwt服务端无法退出问题；
3. 解决jwt无法作废已颁布的令牌，只能等到令牌过期问题；
4. 通过用户扩展信息存储在服务端，有效规避了jwt携带大量用户扩展信息导致降低传输效率问题；
5. 有效避免jwt需要客户端实现续签功能，增加客户端复杂度；支持服务端自动续期，客户端不需要关心续签逻辑；

## 特性说明

1. 支持token认证，不强依赖于session和cookie，适用jwt和session认证所有场景；
2. 支持单机gcache和集群gredis模式；
```
# 配置文件
# 缓存模式 1 gcache 2 gredis
cache-mode = 2
CacheMode = 2
```

2. 支持简单token认证
3. 加入缓存自动续期功能
2. 支持服务端缓存自动续期功能
```
// 注：通过MaxRefresh，默认当用户第五天访问时，自动再进行五天续期
// 注：通过MaxRefresh，默认当用户第五天访问时，自动续期
// 超时时间 默认10天
Timeout int
// 缓存刷新时间 默认为超时时间的一半
MaxRefresh int
```
4. 支持全局拦截或者深度路径拦截，便于根据个人需求定制拦截器
4. 支持分组拦截、全局拦截、深度路径拦截，便于根据个人需求定制拦截器；**建议使用分组拦截方式；**
5. 框架使用简单，只需要设置登录验证方法以及登录、登出路径即可；
6. 在`gtoken v1.4.0`版本开始支持分组中间件方式实现，但依然兼容全局和深度中间件实现方式；

## 安装教程

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

## 分组中间件实现

GoFrame官方推荐使用Group方式实现路由和中间件；

### 使用说明

推荐使用分组方式实现

```bash
// 启动gtoken
gfToken := &gtoken.GfToken{
LoginPath: "/login",
LoginBeforeFunc: loginFunc,
LogoutPath: "/user/logout",
}
s.Group("/", func(group *ghttp.RouterGroup) {
group.Middleware(CORS)
gfToken.Middleware(group)

group.ALL("/system/user", func(r *ghttp.Request) {
r.Response.WriteJson(gtoken.Succ("system user"))
})
………………
})
```
// 是否是全局认证
GlobalMiddleware bool

登录方法实现，通过username返回空或者r.ExitAll()\r.Exit()处理认证失败；

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

// TODO 进行登录校验
if username == "" || passwd == "" {
r.Response.WriteJson(gtoken.Fail("账号或密码错误."))
r.ExitAll()
}

return username, ""
}
```

5. 框架使用简单，只需要设置登录验证方法以及登录、登出、拦截路径即可；
通过`gtoken.GetTokenData(r)`获取登录信息

* github地址：https://github.com/goflyfox/gtoken
* gitee地址：https://gitee.com/goflyfox/gtoken
### 路径拦截规则

```go
AuthExcludePaths: g.SliceStr{"/user/info", "/system/user/*"}, // 不拦截路径 /user/info,/system/user/info,/system/user,
```

#### gtoken优势
1. 有效的避免了jwt服务端无法退出问题；
2. 可以解决jwt无法作废已颁布的令牌；
3. 用户扩展信息仍存储在服务端，可有效的减少传输空间；
4. gtoken支撑单点应用使用内存存储，也支持集群使用redis存储；
5. 支持缓存自动续期，并且不需要客户端进行实现；
1. 分组中间件实现，不需要设置`AuthPaths`认证路径，设置也没有作用，**需要认证路径为该分组下所有路由**；
2. 使用分组拦截的是通过GoFrame的`group.Middleware(authMiddleware)`方法，对该分组下的所有路由进行拦截；
3. 对登录接口路径`loginPath`做拦截认证放行；
4. 严格按照GoFrame分组中间件拦截优先级；如果使用跨域中间件，建议放在跨域中间件之后；
5. 如果配置`AuthExcludePaths`路径，会将配置的不拦截路径排除；

#### 安装教程
### 逻辑测试

* gopath模式: `go get github.com/goflyfox/gtoken`
* 或者 使用go.mod添加 :`require github.com/goflyfox/gtoken latest`
参考sample项目，先运行main.go，然后可运行api_test.go进行测试并查看结果；验证逻辑说明：

1. 访问用户信息，提示未携带token
2. 调用登录后，携带token访问正常
3. 调用登出提示成功
4. 携带之前token访问，提示未登录

```json
=== RUN TestAdminSystemUser
api_admin_test.go:22: 1. not login and visit user
api_admin_test.go:29: {"code":-401,"msg":"请求错误或登录超时","data":""}
api_admin_test.go:42: 2. execute login and visit user
api_admin_test.go:45: {"code":0,"msg":"success","data":"system user"}
api_admin_test.go:51: 3. execute logout
api_admin_test.go:54: {"code":0,"msg":"success","data":"Logout success"}
api_admin_test.go:60: 4. visit user
api_admin_test.go:65: {"code":-401,"msg":"请求错误或登录超时","data":""}
```

## 全局中间件实现

#### 使用说明
### 使用说明

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

Expand Down Expand Up @@ -77,7 +154,7 @@ func Login(r *ghttp.Request) (string, interface{}) {

通过`gtoken.GetTokenData(r)`获取登录信息

#### 路径拦截规则
### 路径拦截规则
```go
AuthPaths: g.SliceStr{"/user", "/system"}, // 这里是按照前缀拦截，拦截/user /user/list /user/add ...
AuthExcludePaths: g.SliceStr{"/user/info", "/system/user/*"}, // 不拦截路径 /user/info,/system/user/info,/system/user,
Expand All @@ -90,13 +167,13 @@ func Login(r *ghttp.Request) (string, interface{}) {
4. 程序先处理认证路径，如果满足；再排除不拦截路径；
5. 如果只想用排除路径功能，将拦截路径设置为`/*`即可；

#### 逻辑测试
### 逻辑测试

可运行api_test.go进行测试并查看结果；验证逻辑说明：
参考sample1项目，先运行main.go，然后可运行api_test.go进行测试并查看结果；验证逻辑说明：

1. 访问用户信息，提示未携带token
2. 登录后，携带token访问正常
3. 登出成功
2. 调用登录后，携带token访问正常
3. 调用登出提示成功
4. 携带之前token访问，提示未登录

```json
Expand All @@ -110,8 +187,8 @@ func Login(r *ghttp.Request) (string, interface{}) {
api_test.go:81: 4. visit user
api_test.go:86: {"code":-401,"msg":"请求错误或登录超时","data":""}
```
#### 返回码
## 返回码及配置项

1. 正常操作成功返回0
2. 未登录访问需要登录资源返回401
3. 程序异常返回-99，如编解码错误等
Expand All @@ -122,11 +199,38 @@ FAIL = -1 // 失败
ERROR = -99 // 异常
UNAUTHORIZED = -401 // 未认证
```
#### 感谢
### 配置项说明

具体可参考`GfToken`结构体，字段解释如下：

| 名称 | 配置字段 | 说明 | 分组中间件 | 全局中间件 |
| ---------------- | ---------------- | ------------------------------------------------------- | ---------- | ---------- |
| 服务名 | ServerName | 默认空即可 | 支持 | 支持 |
| 缓存模式 | CacheMode | 1 gcache 2 gredis 默认1 | 支持 | 支持 |
| 缓存key | CacheKey | 默认缓存前缀`GToken:` | 支持 | 支持 |
| 超时时间 | Timeout | 默认10天（毫秒） | 支持 | 支持 |
| 缓存刷新时间 | MaxRefresh | 默认为超时时间的一半（毫秒） | 支持 | 支持 |
| Token分隔符 | TokenDelimiter | 默认`_` | 支持 | 支持 |
| Token加密key | EncryptKey | 默认`12345678912345678912345678912345` | 支持 | 支持 |
| 认证失败提示 | AuthFailMsg | 默认`请求错误或登录超时` | 支持 | 支持 |
| 是否支持多端登录 | MultiLogin | 默认false | 支持 | 支持 |
| 中间件类型 | MiddlewareType | 1、Group 2、Bind 3 、Global；<br>使用分组模式不需要设置 | 支持 | 支持 |
| 登录路径 | LoginPath | 登录接口路径 | 支持 | 支持 |
| 登录验证方法 | LoginBeforeFunc | 登录验证需要用户实现方法 | 支持 | 支持 |
| 登录返回方法 | LoginAfterFunc | 登录完成后调用 | 支持 | 支持 |
| 登出地址 | LogoutPath | 登出接口路径 | 支持 | 支持 |
| 登出验证方法 | LogoutBeforeFunc | 登出接口前调用 | 支持 | 支持 |
| 登出返回方法 | LogoutAfterFunc | 登出接口完成后调用 | 支持 | 支持 |
| 拦截地址 | AuthPaths | 此路径列表进行认证 | 不需要 | 支持 |
| 拦截排除地址 | AuthExcludePaths | 此路径列表不进行认证 | 支持 | 支持 |
| 认证验证方法 | AuthBeforeFunc | 拦截认证前后调用 | 支持 | 支持 |
| 认证返回方法 | AuthAfterFunc | 拦截认证完成后调用 | 支持 | 支持 |

## 感谢

1. gf框架 [https://github.com/gogf/gf](https://github.com/gogf/gf)

#### 项目支持
## 项目支持

- 项目的发展，离不开大家得支持~！~

Expand Down
21 changes: 0 additions & 21 deletions example/config/config.toml
View file

This file was deleted.

Loading

0 comments on commit 99b5b49

Please sign in to comment.