/
gsession_storage_redis.go
176 lines (157 loc) · 5.88 KB
/
gsession_storage_redis.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
// Copyright GoFrame Author(https://goframe.org). 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 gsession
import (
"context"
"time"
"github.com/gogf/gf/v2/container/gmap"
"github.com/gogf/gf/v2/database/gredis"
"github.com/gogf/gf/v2/internal/intlog"
"github.com/gogf/gf/v2/internal/json"
"github.com/gogf/gf/v2/os/gtimer"
)
// StorageRedis implements the Session Storage interface with redis.
type StorageRedis struct {
redis *gredis.Redis // Redis client for session storage.
prefix string // Redis key prefix for session id.
updatingIdMap *gmap.StrIntMap // Updating TTL set for session id.
}
const (
// DefaultStorageRedisLoopInterval is the interval updating TTL for session ids
// in last duration.
DefaultStorageRedisLoopInterval = 10 * time.Second
)
// NewStorageRedis creates and returns a redis storage object for session.
func NewStorageRedis(redis *gredis.Redis, prefix ...string) *StorageRedis {
if redis == nil {
panic("redis instance for storage cannot be empty")
return nil
}
s := &StorageRedis{
redis: redis,
updatingIdMap: gmap.NewStrIntMap(true),
}
if len(prefix) > 0 && prefix[0] != "" {
s.prefix = prefix[0]
}
// Batch updates the TTL for session ids timely.
gtimer.AddSingleton(context.Background(), DefaultStorageRedisLoopInterval, func(ctx context.Context) {
intlog.Print(context.TODO(), "StorageRedis.timer start")
var (
id string
err error
ttlSeconds int
)
for {
if id, ttlSeconds = s.updatingIdMap.Pop(); id == "" {
break
} else {
if err = s.doUpdateTTL(context.TODO(), id, ttlSeconds); err != nil {
intlog.Errorf(context.TODO(), `%+v`, err)
}
}
}
intlog.Print(context.TODO(), "StorageRedis.timer end")
})
return s
}
// New creates a session id.
// This function can be used for custom session creation.
func (s *StorageRedis) New(ctx context.Context, ttl time.Duration) (id string, err error) {
return "", ErrorDisabled
}
// Get retrieves session value with given key.
// It returns nil if the key does not exist in the session.
func (s *StorageRedis) Get(ctx context.Context, id string, key string) (value interface{}, err error) {
return nil, ErrorDisabled
}
// Data retrieves all key-value pairs as map from storage.
func (s *StorageRedis) Data(ctx context.Context, id string) (data map[string]interface{}, err error) {
return nil, ErrorDisabled
}
// GetSize retrieves the size of key-value pairs from storage.
func (s *StorageRedis) GetSize(ctx context.Context, id string) (size int, err error) {
return -1, ErrorDisabled
}
// Set sets key-value session pair to the storage.
// The parameter `ttl` specifies the TTL for the session id (not for the key-value pair).
func (s *StorageRedis) Set(ctx context.Context, id string, key string, value interface{}, ttl time.Duration) error {
return ErrorDisabled
}
// SetMap batch sets key-value session pairs with map to the storage.
// The parameter `ttl` specifies the TTL for the session id(not for the key-value pair).
func (s *StorageRedis) SetMap(ctx context.Context, id string, data map[string]interface{}, ttl time.Duration) error {
return ErrorDisabled
}
// Remove deletes key with its value from storage.
func (s *StorageRedis) Remove(ctx context.Context, id string, key string) error {
return ErrorDisabled
}
// RemoveAll deletes all key-value pairs from storage.
func (s *StorageRedis) RemoveAll(ctx context.Context, id string) error {
return ErrorDisabled
}
// GetSession returns the session data as *gmap.StrAnyMap for given session id from storage.
//
// The parameter `ttl` specifies the TTL for this session, and it returns nil if the TTL is exceeded.
// The parameter `data` is the current old session data stored in memory,
// and for some storage it might be nil if memory storage is disabled.
//
// This function is called ever when session starts.
func (s *StorageRedis) GetSession(ctx context.Context, id string, ttl time.Duration, data *gmap.StrAnyMap) (*gmap.StrAnyMap, error) {
intlog.Printf(ctx, "StorageRedis.GetSession: %s, %v", id, ttl)
r, err := s.redis.Do(ctx, "GET", s.key(id))
if err != nil {
return nil, err
}
content := r.Bytes()
if len(content) == 0 {
return nil, nil
}
var m map[string]interface{}
if err = json.UnmarshalUseNumber(content, &m); err != nil {
return nil, err
}
if m == nil {
return nil, nil
}
if data == nil {
return gmap.NewStrAnyMapFrom(m, true), nil
}
data.Replace(m)
return data, nil
}
// SetSession updates the data map for specified session id.
// This function is called ever after session, which is changed dirty, is closed.
// This copy all session data map from memory to storage.
func (s *StorageRedis) SetSession(ctx context.Context, id string, data *gmap.StrAnyMap, ttl time.Duration) error {
intlog.Printf(ctx, "StorageRedis.SetSession: %s, %v, %v", id, data, ttl)
content, err := json.Marshal(data)
if err != nil {
return err
}
_, err = s.redis.Do(ctx, "SETEX", s.key(id), int64(ttl.Seconds()), content)
return err
}
// UpdateTTL updates the TTL for specified session id.
// This function is called ever after session, which is not dirty, is closed.
// It just adds the session id to the async handling queue.
func (s *StorageRedis) UpdateTTL(ctx context.Context, id string, ttl time.Duration) error {
intlog.Printf(ctx, "StorageRedis.UpdateTTL: %s, %v", id, ttl)
if ttl >= DefaultStorageRedisLoopInterval {
s.updatingIdMap.Set(id, int(ttl.Seconds()))
}
return nil
}
// doUpdateTTL updates the TTL for session id.
func (s *StorageRedis) doUpdateTTL(ctx context.Context, id string, ttlSeconds int) error {
intlog.Printf(ctx, "StorageRedis.doUpdateTTL: %s, %d", id, ttlSeconds)
_, err := s.redis.Do(ctx, "EXPIRE", s.key(id), ttlSeconds)
return err
}
func (s *StorageRedis) key(id string) string {
return s.prefix + id
}