sessions

README

go-sessions HTTP会话管理工具库

支持

• session 初始化
• 设置键值对
• 删除键值对
• 遍历键值对
• 清空键
• 获取内容(Get() interface{})
• 获取内容(GetString() string)
• 获取内容(GetBool() bool)
• 获取内容(GetUint64() uint64)
• 获取内容(GetInt64() int64)
• 获取内容(GetFloat64() float64)
• 获取所有(GetAll() map[string]interface{})
• 提取内容(Extract() interface{}) 获取完内容后删除键
• 提取内容(ExtractString() string) 获取完内容后删除键
• 提取内容(ExtractBool() bool) 获取完内容后删除键
• 提取内容(ExtractUint64() uint64) 获取完内容后删除键
• 提取内容(ExtractInt64() int64) 获取完内容后删除键
• 提取内容(ExtractFloat64() float64) 获取完内容后删除键

Documentation

Index

• func DisRedisMode()
• func GetRedisNamespace() string
• func IsRedisMode() bool
• func SetRedisNamespace(namespace string)
• func SetTimeout(dur time.Duration)
• func UseRedis(addr string, auth string, db int, namespace string) error
• type ForEachFunc
• type Session
  • func Get(key string) *Session
  • func (s *Session) Clean() error
  • func (s *Session) CreatedAt() time.Time
  • func (s *Session) Del(key string) error
  • func (s *Session) Extract(key string) (interface{}, bool, error)
  • func (s *Session) ExtractBool(key string, def bool) (bool, bool, error)
  • func (s *Session) ExtractFloat64(key string, def float64) (float64, bool, error)
  • func (s *Session) ExtractInt64(key string, def int64) (int64, bool, error)
  • func (s *Session) ExtractString(key, def string) (string, bool, error)
  • func (s *Session) ExtractUint64(key string, def uint64) (uint64, bool, error)
  • func (s *Session) ForEach(fun ForEachFunc)
  • func (s *Session) Get(key string) (interface{}, bool, error)
  • func (s *Session) GetAll() map[string]interface{}
  • func (s *Session) GetBool(key string, def bool) (bool, bool, error)
  • func (s *Session) GetFloat64(key string, def float64) (float64, bool, error)
  • func (s *Session) GetInt64(key string, def int64) (int64, bool, error)
  • func (s *Session) GetSN() string
  • func (s *Session) GetString(key, def string) (string, bool, error)
  • func (s *Session) GetUint64(key string, def uint64) (uint64, bool, error)
  • func (s *Session) RefreshTimeout(timeout time.Duration)
  • func (s *Session) Set(key string, val interface{}) error
  • func (s *Session) UpdatedAt() time.Time

Functions

func DisRedisMode

func DisRedisMode()

禁用redis方式

func GetRedisNamespace

func GetRedisNamespace() string

func IsRedisMode

func IsRedisMode() bool

当前是否redis模式

func SetRedisNamespace

func SetRedisNamespace(namespace string)

func SetTimeout

func SetTimeout(dur time.Duration)

func UseRedis

func UseRedis(addr string, auth string, db int, namespace string) error

Types

type ForEachFunc

type ForEachFunc func(key string, val interface{}) bool

foreach 遍历函数 key 键名 val 对应的值 return 是否继续遍历

type Session

type Session struct {
	IsNew bool
	// contains filtered or unexported fields
}

func Get

func Get(key string) *Session

func (*Session) Clean

func (s *Session) Clean() error

*

• 删除所有键
• @return error 出错

func (*Session) CreatedAt

func (s *Session) CreatedAt() time.Time

*

• 获取创建时间
• @return time.Time 创建时间

func (*Session) Del

func (s *Session) Del(key string) error

*

• 删除键
• @param string key 键名
• @return error 出错

func (*Session) Extract

func (s *Session) Extract(key string) (interface{}, bool, error)

*

• 提取内容 有效则提取后将键删除
• @param string key 键名
• @return interface{} 内容
• @return bool 是否存在
• @return error 出错

func (*Session) ExtractBool

func (s *Session) ExtractBool(key string, def bool) (bool, bool, error)

*

• 提取Bool 有效则提取后将键删除
• @param string key 键名
• @param bool def 默认值
• @return bool 内容
• @return bool 是否存在
• @return error 出错

func (*Session) ExtractFloat64

func (s *Session) ExtractFloat64(key string, def float64) (float64, bool, error)

*

• 提取Float64 有效则提取后将键删除
• @param string key 键名
• @param float64 def 默认值
• @return float64 内容
• @return bool 是否存在
• @return error 出错

func (*Session) ExtractInt64

func (s *Session) ExtractInt64(key string, def int64) (int64, bool, error)

*

• 提取Int64 有效则提取后将键删除
• @param string key 键名
• @param int64 def 默认值
• @return int64 内容
• @return bool 是否存在
• @return error 出错

func (*Session) ExtractString

func (s *Session) ExtractString(key, def string) (string, bool, error)

*

• 提取String 有效则提取后将键删除
• @param string key 键名
• @param string def 默认值
• @return string 内容
• @return bool 是否存在
• @return error 出错

func (*Session) ExtractUint64

func (s *Session) ExtractUint64(key string, def uint64) (uint64, bool, error)

*

• 提取Uint64 有效则提取后将键删除
• @param string key 键名
• @param uint64 def 默认值
• @return uint64 内容
• @return bool 是否存在
• @return error 出错

func (*Session) ForEach

func (s *Session) ForEach(fun ForEachFunc)

遍历

func (*Session) Get

func (s *Session) Get(key string) (interface{}, bool, error)

*

• 获取键内容
• @param string key 键名
• @return interface{} 内容
• @return bool 是否存在
• @return error 出错

func (*Session) GetAll

func (s *Session) GetAll() map[string]interface{}

*

• 搜索出所有会话键值对

func (*Session) GetBool

func (s *Session) GetBool(key string, def bool) (bool, bool, error)

*

• 获取键内容，指定bool
• @param string key 键名
• @param bool def 默认内容
• @return bool 内容
• @return bool 是否存在
• @return error 出错

func (*Session) GetFloat64

func (s *Session) GetFloat64(key string, def float64) (float64, bool, error)

*

• 获取键内容，指定float64
• @param string key 键名
• @param float64 def 默认内容
• @return float64 内容
• @return bool 是否存在
• @return error 出错

func (*Session) GetInt64

func (s *Session) GetInt64(key string, def int64) (int64, bool, error)

*

• 获取键内容，指定int64
• @param string key 键名
• @param int64 def 默认内容
• @return int64 内容
• @return bool 是否存在
• @return error 出错

func (*Session) GetSN

func (s *Session) GetSN() string

func (*Session) GetString

func (s *Session) GetString(key, def string) (string, bool, error)

*

• 获取键内容，指定string
• @param string key 键名
• @param string def 默认内容
• @return string 内容
• @return bool 是否存在
• @return error 出错

func (*Session) GetUint64

func (s *Session) GetUint64(key string, def uint64) (uint64, bool, error)

*

• 获取键内容，指定uint64
• @param string key 键名
• @param uint64 def 默认内容
• @return uint64 内容
• @return bool 是否存在
• @return error 出错

func (*Session) RefreshTimeout

func (s *Session) RefreshTimeout(timeout time.Duration)

重置当前session超时时间

func (*Session) Set

func (s *Session) Set(key string, val interface{}) error

*

• 设置键值对
• @param string key 键名
• @param string val 内容
• @return error 出错

func (*Session) UpdatedAt

func (s *Session) UpdatedAt() time.Time

*

• 获取更新时间
• @return time.Time 更新时间