用go设计开发一个自己的轻量级登录库/框架吧

用go设计开发一个自己的轻量级登录库/框架吧

几乎每个项目都会有登录，退出等用户功能，而登录又不单仅仅是登录，我们要考虑很多东西。
token该怎么生成？生成什么样的？
是在Cookie存token还是请求头存token？读取的时候怎么读取？
允许同一个账号被多次登录吗？多次登录他们的token是一样的？还是不一样的？
登录也有可能分成管理员登录，用户登录等多种登录类型
我们要做的就是把这些东西封装到一起，然后能更方便的使用
而完成这些最难的就是如何设计架构了，其实要简单的封装一下并不难，本篇要讲的就是如何进行架构的设计了。
源码：weloe/token-go: a light login library (github.com)
Enforcer

我们可以抽象出一个供外部调用的执行器，它包括以下几个部分
token-go/enforcer.go at master · weloe/token-go (github.com)

1. type Enforcer struct {
2.     // 从配置文件读取配置需要
3.         conf         string
4.     // 登录类型
5.         loginType    string
6.         config       config.TokenConfig
7.     // 生成token的函数
8.         generateFunc model.GenerateTokenFunc
9.     // 用于存储数据
10.         adapter      persist.Adapter
11.     // 监听器
12.         watcher      persist.Watcher
13.     // web上下文
14.         webCtx       ctx.Context
15.     // 用于记录日志
16.         logger       log.Logger
17. }

复制代码

执行器的接口，包含供外部调用的方法
token-go/enforcer_interface.go at master · weloe/token-go · GitHub

1. var _ IEnforcer = &Enforcer{}
3. type IEnforcer interface {
4.    
5.         Login(id string) (string, error)
6.         LoginByModel(id string, loginModel *model.Login) (string, error)
7.         Logout() error
8.         IsLogin() (bool, error)
9.         IsLoginById(id string) (bool, error)
10.         GetLoginId() (string, error)
12.         Replaced(id string, device string) error
13.         Kickout(id string, device string) error
15.         GetRequestToken() string
17.         SetType(t string)
18.         GetType() string
19.         SetContext(ctx ctx.Context)
20.         GetAdapter() persist.Adapter
21.         SetAdapter(adapter persist.Adapter)
22.         SetWatcher(watcher persist.Watcher)
23.         SetLogger(logger log.Logger)
24.         EnableLog()
25.         IsLogEnable() bool
26.         GetSession(id string) *model.Session
27.         SetSession(id string, session *model.Session, timeout int64) error
28. }

复制代码

Config

首先就是根据需求抽象出配置信息
一个是cookie的配置
token-go/cookie.go at master · weloe/token-go · GitHub

1. type CookieConfig struct {
2.         Domain   string
3.         Path     string
4.         Secure   bool
5.         HttpOnly bool
6.         SameSite string
7. }

复制代码

一个是token的配置
token-go/token.go at master · weloe/token-go · GitHub

1. type TokenConfig struct {
2.    // TokenStyle
3.    // uuid | uuid-simple | random-string32 | random-string64 | random-string128
4.    TokenStyle string
5.    
6.    TokenName   string
8.    Timeout int64
10.    // 允许多次登录
11.    IsConcurrent bool
12.    // 多次登录共享一个token
13.    IsShare bool
14.    // If (IsConcurrent == true && IsShare == false)才支持配置
15.    // If IsConcurrent == -1, 不检查登录数量
16.    MaxLoginCount int16
18.    // 读取token的方式
19.    IsReadBody   bool
20.    IsReadHeader bool
21.    IsReadCookie bool
23.    // 是否把token写入响应头
24.    IsWriteHeader bool
26.    CookieConfig *CookieConfig
27. }

复制代码

Adapter

adapter是底层用来存储数据的结构，为了兼容不同的实现(不同的存储方式)，设计成一个接口。
token-go/adapter.go at master · weloe/token-go · GitHub

1. type Adapter interface {
3.         // GetStr string operate string value
4.         GetStr(key string) string
5.         // SetStr set store value and timeout
6.         SetStr(key string, value string, timeout int64) error
7.         // UpdateStr only update value
8.         UpdateStr(key string, value string) error
9.         // DeleteStr delete string value
10.         DeleteStr(key string) error
11.         // GetStrTimeout get expire
12.         GetStrTimeout(key string) int64
13.         // UpdateStrTimeout update expire time
14.         UpdateStrTimeout(key string, timeout int64) error
16.         // Get get interface{}
17.         Get(key string) interface{}
18.         // Set store interface{}
19.         Set(key string, value interface{}, timeout int64) error
20.         // Update only update interface{} value
21.         Update(key string, value interface{}) error
22.         // Delete delete interface{} value
23.         Delete(key string) error
24.         // GetTimeout get expire
25.         GetTimeout(key string) int64
26.         // UpdateTimeout update timeout
27.         UpdateTimeout(key string, timeout int64) error
28. }

复制代码

Context

我们需要从请求读取token，可能也需要写出token，因此需要兼容不同的web上下文，我们需要设计一个Context接口
token-go/context.go at master · weloe/token-go · GitHub

1. type Context interface {
2.         Request() Request
3.         Response() Response
4.         ReqStorage() ReqStorage
5.         MatchPath(pattern string, path string) bool
6.         IsValidContext() bool
7. }

复制代码

Watcher

监听器，用于在一些事件发生的时候进行一些其他操作。
token-go/watcher.go at master · weloe/token-go · GitHub

1. // Watcher event watcher
2. type Watcher interface {
3.         // Login called after login
4.         Login(loginType string, id interface{}, tokenValue string, loginModel *model.Login)
5.         // Logout called after logout
6.         Logout(loginType string, id interface{}, tokenValue string)
7. }

复制代码

Logger

Logger，用于记录日志，方便debug等等，需要设计成可以自由开启关闭。
token-go/logger.go at master · weloe/token-go · GitHub

1. type Logger interface {
2.         persist.Watcher
4.         // Enable turn on or off
5.         Enable(bool bool)
7.         // IsEnabled return if logger is enabled
8.         IsEnabled() bool
9. }

复制代码

到此，项目的大致的结构就设计完成，下一篇会讲讲本业务的具体实现

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！