mirror of
https://gitee.com/johng/gf
synced 2026-06-06 16:21:40 +08:00
330 lines
8.3 KiB
Go
330 lines
8.3 KiB
Go
// Copyright 2017 gf Author(https://github.com/gogf/gf). All Rights Reserved.
|
||
//
|
||
// This Source Code Form is subject to the terms of the MIT License.
|
||
// If a copy of the MIT was not distributed with this file,
|
||
// You can obtain one at https://github.com/gogf/gf.
|
||
|
||
package ghttp
|
||
|
||
import (
|
||
"encoding/json"
|
||
"strconv"
|
||
"strings"
|
||
"time"
|
||
|
||
"github.com/gogf/gf/container/gmap"
|
||
"github.com/gogf/gf/container/gvar"
|
||
"github.com/gogf/gf/os/gtime"
|
||
"github.com/gogf/gf/util/gconv"
|
||
"github.com/gogf/gf/util/grand"
|
||
)
|
||
|
||
// SESSION对象，并发安全
|
||
type Session struct {
|
||
id string // SessionId
|
||
data *gmap.StrAnyMap // Session数据
|
||
dirty bool // 数据是否被修改
|
||
server *Server // 所属Server
|
||
request *Request // 关联的请求
|
||
}
|
||
|
||
// 生成一个唯一的SessionId字符串，长度18位。
|
||
func makeSessionId() string {
|
||
return strings.ToUpper(strconv.FormatInt(gtime.Nanosecond(), 36) + grand.Str(6))
|
||
}
|
||
|
||
// 获取或者生成一个session对象(延迟初始化)
|
||
func GetSession(r *Request) *Session {
|
||
if r.Session != nil {
|
||
return r.Session
|
||
}
|
||
return &Session{
|
||
request: r,
|
||
}
|
||
}
|
||
|
||
// UpdateSession updates the session with custom map.
|
||
func (s *Server) UpdateSession(id string, data map[string]interface{}) {
|
||
v := s.sessions.GetOrSetFuncLock(id, func() interface{} {
|
||
return gmap.NewStrAnyMap(true)
|
||
}, s.GetSessionMaxAge()*1000)
|
||
v.(*gmap.StrAnyMap).Sets(data)
|
||
}
|
||
|
||
// 延迟初始化
|
||
func (s *Session) init() {
|
||
if len(s.id) == 0 {
|
||
s.server = s.request.Server
|
||
if id := s.request.GetSessionId(); id != "" {
|
||
if v := s.server.sessions.Get(id); v != nil {
|
||
// 纯内存查询
|
||
s.id = id
|
||
s.data = v.(*gmap.StrAnyMap)
|
||
return
|
||
} else {
|
||
// 持久化恢复
|
||
data := s.server.sessionStorage.Get([]byte(id))
|
||
if data != nil {
|
||
s.id = id
|
||
s.data = gmap.NewStrAnyMap(true)
|
||
s.Restore(data)
|
||
return
|
||
}
|
||
}
|
||
}
|
||
// 否则执行初始化创建
|
||
s.id = s.request.MakeSessionId()
|
||
s.data = gmap.NewStrAnyMap(true)
|
||
s.server.sessions.Set(s.id, s.data, s.server.GetSessionMaxAge()*1000)
|
||
s.dirty = true
|
||
}
|
||
}
|
||
|
||
// 获取/创建SessionId
|
||
func (s *Session) Id() string {
|
||
s.init()
|
||
return s.id
|
||
}
|
||
|
||
// 获取当前session所有数据，注意是值拷贝
|
||
func (s *Session) Map() map[string]interface{} {
|
||
if len(s.id) > 0 || s.request.GetSessionId() != "" {
|
||
s.init()
|
||
return s.data.Map()
|
||
}
|
||
return nil
|
||
}
|
||
|
||
// 获得session map大小
|
||
func (s *Session) Size() int {
|
||
if len(s.id) > 0 || s.request.GetSessionId() != "" {
|
||
s.init()
|
||
return s.data.Size()
|
||
}
|
||
return 0
|
||
}
|
||
|
||
// 设置session
|
||
func (s *Session) Set(key string, value interface{}) {
|
||
s.init()
|
||
s.data.Set(key, value)
|
||
s.dirty = true
|
||
}
|
||
|
||
// 批量设置
|
||
func (s *Session) Sets(m map[string]interface{}) {
|
||
s.init()
|
||
s.data.Sets(m)
|
||
s.dirty = true
|
||
}
|
||
|
||
// 判断键名是否存在
|
||
func (s *Session) Contains(key string) bool {
|
||
if len(s.id) > 0 || s.request.GetSessionId() != "" {
|
||
s.init()
|
||
return s.data.Contains(key)
|
||
}
|
||
return false
|
||
}
|
||
|
||
// 判断session是否有修改(包括新创建)
|
||
func (s *Session) IsDirty() bool {
|
||
return s.dirty
|
||
}
|
||
|
||
// 删除指定session键值对
|
||
func (s *Session) Remove(key string) {
|
||
if len(s.id) > 0 || s.request.GetSessionId() != "" {
|
||
s.init()
|
||
s.data.Remove(key)
|
||
s.dirty = true
|
||
}
|
||
}
|
||
|
||
// 将session数据导出为[]byte数据(目前使用json进行序列化)
|
||
func (s *Session) Export() (data []byte, err error) {
|
||
if s.Size() > 0 {
|
||
data, err = json.Marshal(s.data)
|
||
}
|
||
return
|
||
}
|
||
|
||
// 从[]byte中恢复session数据(目前使用json进行序列化)
|
||
func (s *Session) Restore(data []byte) (err error) {
|
||
if len(data) == 0 {
|
||
return nil
|
||
}
|
||
if len(s.id) > 0 || s.request.GetSessionId() != "" {
|
||
s.init()
|
||
s.data.LockFunc(func(m map[string]interface{}) {
|
||
err = json.Unmarshal(data, &m)
|
||
})
|
||
}
|
||
return
|
||
}
|
||
|
||
// 清空session
|
||
func (s *Session) Clear() {
|
||
if len(s.id) > 0 || s.request.GetSessionId() != "" {
|
||
s.init()
|
||
s.data.Clear()
|
||
s.dirty = true
|
||
}
|
||
}
|
||
|
||
// 更新过期时间(如果用在守护进程中长期使用，需要手动调用进行更新，防止超时被清除)
|
||
func (s *Session) UpdateExpire() {
|
||
if len(s.id) > 0 && s.data.Size() > 0 {
|
||
// 优先持久化存储
|
||
if s.dirty {
|
||
data, _ := s.Export()
|
||
s.server.sessionStorage.Set(
|
||
[]byte(s.id),
|
||
data,
|
||
time.Duration(s.server.GetSessionMaxAge())*time.Second,
|
||
)
|
||
}
|
||
// 其次更新内存TTL
|
||
s.server.sessions.Set(s.id, s.data, s.server.GetSessionMaxAge()*1000)
|
||
}
|
||
}
|
||
|
||
// 获取SESSION变量
|
||
func (s *Session) Get(key string, def ...interface{}) interface{} {
|
||
if len(s.id) > 0 || s.request.GetSessionId() != "" {
|
||
s.init()
|
||
if v := s.data.Get(key); v != nil {
|
||
return v
|
||
}
|
||
}
|
||
if len(def) > 0 {
|
||
return def[0]
|
||
}
|
||
return nil
|
||
}
|
||
|
||
// 获取SESSION，建议都用该方法获取参数
|
||
func (s *Session) GetVar(key string, def ...interface{}) *gvar.Var {
|
||
return gvar.New(s.Get(key, def...), true)
|
||
}
|
||
|
||
func (s *Session) GetString(key string, def ...interface{}) string {
|
||
return gconv.String(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetBool(key string, def ...interface{}) bool {
|
||
return gconv.Bool(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetInt(key string, def ...interface{}) int {
|
||
return gconv.Int(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetInt8(key string, def ...interface{}) int8 {
|
||
return gconv.Int8(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetInt16(key string, def ...interface{}) int16 {
|
||
return gconv.Int16(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetInt32(key string, def ...interface{}) int32 {
|
||
return gconv.Int32(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetInt64(key string, def ...interface{}) int64 {
|
||
return gconv.Int64(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetUint(key string, def ...interface{}) uint {
|
||
return gconv.Uint(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetUint8(key string, def ...interface{}) uint8 {
|
||
return gconv.Uint8(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetUint16(key string, def ...interface{}) uint16 {
|
||
return gconv.Uint16(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetUint32(key string, def ...interface{}) uint32 {
|
||
return gconv.Uint32(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetUint64(key string, def ...interface{}) uint64 {
|
||
return gconv.Uint64(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetFloat32(key string, def ...interface{}) float32 {
|
||
return gconv.Float32(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetFloat64(key string, def ...interface{}) float64 {
|
||
return gconv.Float64(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetBytes(key string, def ...interface{}) []byte {
|
||
return gconv.Bytes(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetInts(key string, def ...interface{}) []int {
|
||
return gconv.Ints(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetFloats(key string, def ...interface{}) []float64 {
|
||
return gconv.Floats(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetStrings(key string, def ...interface{}) []string {
|
||
return gconv.Strings(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetInterfaces(key string, def ...interface{}) []interface{} {
|
||
return gconv.Interfaces(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetTime(key string, format ...string) time.Time {
|
||
return gconv.Time(s.Get(key), format...)
|
||
}
|
||
|
||
func (s *Session) GetGTime(key string, format ...string) *gtime.Time {
|
||
return gconv.GTime(s.Get(key), format...)
|
||
}
|
||
|
||
func (s *Session) GetDuration(key string, def ...interface{}) time.Duration {
|
||
return gconv.Duration(s.Get(key, def...))
|
||
}
|
||
|
||
func (s *Session) GetMap(value interface{}, tags ...string) map[string]interface{} {
|
||
return gconv.Map(value, tags...)
|
||
}
|
||
|
||
func (s *Session) GetMapDeep(value interface{}, tags ...string) map[string]interface{} {
|
||
return gconv.MapDeep(value, tags...)
|
||
}
|
||
|
||
func (s *Session) GetMaps(value interface{}, tags ...string) []map[string]interface{} {
|
||
return gconv.Maps(value, tags...)
|
||
}
|
||
|
||
func (s *Session) GetMapsDeep(value interface{}, tags ...string) []map[string]interface{} {
|
||
return gconv.MapsDeep(value, tags...)
|
||
}
|
||
|
||
func (s *Session) GetStruct(key string, pointer interface{}, mapping ...map[string]string) error {
|
||
return gconv.Struct(s.Get(key), pointer, mapping...)
|
||
}
|
||
|
||
func (s *Session) GetStructDeep(key string, pointer interface{}, mapping ...map[string]string) error {
|
||
return gconv.StructDeep(s.Get(key), pointer, mapping...)
|
||
}
|
||
|
||
func (s *Session) GetStructs(key string, pointer interface{}, mapping ...map[string]string) error {
|
||
return gconv.Structs(s.Get(key), pointer, mapping...)
|
||
}
|
||
|
||
func (s *Session) GetStructsDeep(key string, pointer interface{}, mapping ...map[string]string) error {
|
||
return gconv.StructsDeep(s.Get(key), pointer, mapping...)
|
||
}
|