mirror of
https://github.com/truewhile/MeBox.git
synced 2026-09-29 03:26:37 +08:00
truewhile
618 lines
16 KiB
Go
618 lines
16 KiB
Go
package service
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"reflect"
|
|
"strings"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/redis/go-redis/v9"
|
|
"go.uber.org/zap"
|
|
|
|
"github.com/truewhile/MeBox/internal/config"
|
|
)
|
|
|
|
const (
|
|
defaultRuntimeCacheEntryLimit = 2048
|
|
runtimeCacheEntryOverheadBytes = 96
|
|
runtimeCacheMapEntryOverheadBytes = 64
|
|
runtimeCacheStringHeaderBytes = 16
|
|
runtimeCacheEstimateMaxDepth = 64
|
|
)
|
|
|
|
type RuntimeCacheService struct {
|
|
log *zap.Logger
|
|
client *redis.Client
|
|
// redisGet is separated from client so cache ordering can be tested without
|
|
// requiring a live Redis instance.
|
|
redisGet func(ctx context.Context, key string) ([]byte, error)
|
|
prefix string
|
|
|
|
mu sync.RWMutex
|
|
memory map[string]runtimeCacheItem
|
|
obj map[string]runtimeObjectItem
|
|
limit int
|
|
maxBytes int64
|
|
bytesUsed int64
|
|
}
|
|
|
|
type runtimeCacheItem struct {
|
|
raw []byte
|
|
expiresAt time.Time
|
|
staleUntil time.Time
|
|
lastUsed time.Time
|
|
size int64
|
|
}
|
|
|
|
// runtimeObjectItem 直存 Go 对象，跳过 JSON 编解码。热点路径（整库行、
|
|
// 分组结果）每次请求都要完整反序列化，字节缓存避免了 SQL 却没避免解码；
|
|
// 对象缓存命中时零解码零分配。存储的值视为不可变：读取方如需修改必须
|
|
// 自行浅拷贝。仅进程内生效（Redis 只支持字节），多实例部署退化为各实例
|
|
// 独立缓存，与现有内存 L1 语义一致。
|
|
type runtimeObjectItem struct {
|
|
value any
|
|
expiresAt time.Time
|
|
lastUsed time.Time
|
|
size int64
|
|
}
|
|
|
|
func NewRuntimeCacheService(cfg *config.Config, log *zap.Logger) *RuntimeCacheService {
|
|
maxBytes := int64(config.DefaultCacheMemoryMaxSizeMB) * 1024 * 1024
|
|
if cfg != nil && cfg.Cache.MemoryMaxSizeMB > 0 {
|
|
maxBytes = int64(cfg.Cache.MemoryMaxSizeMB) * 1024 * 1024
|
|
}
|
|
c := &RuntimeCacheService{
|
|
log: log,
|
|
memory: map[string]runtimeCacheItem{},
|
|
obj: map[string]runtimeObjectItem{},
|
|
limit: defaultRuntimeCacheEntryLimit,
|
|
maxBytes: maxBytes,
|
|
}
|
|
if cfg == nil {
|
|
return c
|
|
}
|
|
c.prefix = strings.Trim(strings.TrimSpace(cfg.Cache.RedisPrefix), ":")
|
|
if c.prefix == "" {
|
|
c.prefix = "mebox"
|
|
}
|
|
rawURL := strings.TrimSpace(cfg.Cache.RedisURL)
|
|
if rawURL == "" {
|
|
return c
|
|
}
|
|
opts, err := redis.ParseURL(rawURL)
|
|
if err != nil {
|
|
if log != nil {
|
|
log.Warn("redis cache disabled: invalid redis url", zap.Error(err))
|
|
}
|
|
return c
|
|
}
|
|
client := redis.NewClient(opts)
|
|
pingCtx, cancel := context.WithTimeout(context.Background(), 1200*time.Millisecond)
|
|
defer cancel()
|
|
if err := client.Ping(pingCtx).Err(); err != nil {
|
|
if log != nil {
|
|
log.Warn("redis cache unavailable; using in-process cache", zap.Error(err))
|
|
}
|
|
_ = client.Close()
|
|
return c
|
|
}
|
|
c.client = client
|
|
c.redisGet = func(ctx context.Context, key string) ([]byte, error) {
|
|
return client.Get(ctx, key).Bytes()
|
|
}
|
|
if log != nil {
|
|
log.Info("redis runtime cache enabled with in-process L1", zap.String("addr", opts.Addr), zap.String("prefix", c.prefix))
|
|
}
|
|
return c
|
|
}
|
|
|
|
func (c *RuntimeCacheService) Enabled() bool {
|
|
return c != nil
|
|
}
|
|
|
|
func (c *RuntimeCacheService) Close() error {
|
|
if c == nil || c.client == nil {
|
|
return nil
|
|
}
|
|
return c.client.Close()
|
|
}
|
|
|
|
func (c *RuntimeCacheService) GetJSON(ctx context.Context, key string, out any) bool {
|
|
if !c.Enabled() || strings.TrimSpace(key) == "" || out == nil {
|
|
return false
|
|
}
|
|
fullKey := c.key(key)
|
|
if raw, ok := c.getMemory(fullKey); ok {
|
|
return json.Unmarshal(raw, out) == nil
|
|
}
|
|
if c.redisGet != nil {
|
|
raw, err := c.redisGet(ctx, fullKey)
|
|
if err == nil {
|
|
if json.Unmarshal(raw, out) != nil {
|
|
return false
|
|
}
|
|
c.setMemoryOwned(fullKey, raw, 2*time.Second)
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// GetJSONStale returns a fresh value when available and otherwise a retained
|
|
// stale value stored with SetJSONWithStale. The stale flag lets
|
|
// callers serve immediately while refreshing in the background.
|
|
func (c *RuntimeCacheService) GetJSONStale(ctx context.Context, key string, out any) (found bool, stale bool) {
|
|
if !c.Enabled() || strings.TrimSpace(key) == "" || out == nil {
|
|
return false, false
|
|
}
|
|
fullKey := c.key(key)
|
|
raw, ok, isStale := c.getMemoryWithStale(fullKey)
|
|
if ok && !isStale {
|
|
return json.Unmarshal(raw, out) == nil, false
|
|
}
|
|
// A stale L1 entry must not hide a newer value written by another
|
|
// instance. Prefer Redis whenever the local copy is stale, then fall back
|
|
// to it only when Redis is unavailable or its fresh value has expired.
|
|
if c.redisGet != nil {
|
|
redisRaw, err := c.redisGet(ctx, fullKey)
|
|
if err == nil {
|
|
if json.Unmarshal(redisRaw, out) == nil {
|
|
c.setMemoryOwned(fullKey, redisRaw, 2*time.Second)
|
|
return true, false
|
|
}
|
|
}
|
|
}
|
|
if ok {
|
|
return json.Unmarshal(raw, out) == nil, isStale
|
|
}
|
|
return false, false
|
|
}
|
|
|
|
func (c *RuntimeCacheService) SetJSON(ctx context.Context, key string, value any, ttl time.Duration) {
|
|
if !c.Enabled() || strings.TrimSpace(key) == "" || value == nil || ttl <= 0 {
|
|
return
|
|
}
|
|
raw, err := json.Marshal(value)
|
|
if err != nil {
|
|
return
|
|
}
|
|
fullKey := c.key(key)
|
|
c.setMemoryOwned(fullKey, raw, ttl)
|
|
if c.client != nil {
|
|
_ = c.client.Set(ctx, fullKey, raw, ttl).Err()
|
|
}
|
|
}
|
|
|
|
// SetJSONWithStale stores a fresh value for freshTTL and keeps an in-process
|
|
// stale copy for staleTTL. Redis keeps only the fresh window so multi-instance
|
|
// deployments retain the existing consistency semantics.
|
|
func (c *RuntimeCacheService) SetJSONWithStale(ctx context.Context, key string, value any, freshTTL, staleTTL time.Duration) {
|
|
if !c.Enabled() || strings.TrimSpace(key) == "" || value == nil || freshTTL <= 0 {
|
|
return
|
|
}
|
|
if staleTTL < freshTTL {
|
|
staleTTL = freshTTL
|
|
}
|
|
raw, err := json.Marshal(value)
|
|
if err != nil {
|
|
return
|
|
}
|
|
fullKey := c.key(key)
|
|
c.setMemoryBytesWithStale(fullKey, raw, freshTTL, staleTTL, true)
|
|
if c.client != nil {
|
|
_ = c.client.Set(ctx, fullKey, raw, freshTTL).Err()
|
|
}
|
|
}
|
|
|
|
// GetObject 返回缓存中的对象。返回值不可变：调用方需要修改时必须先自行拷贝。
|
|
func (c *RuntimeCacheService) GetObject(key string) (any, bool) {
|
|
if !c.Enabled() || strings.TrimSpace(key) == "" {
|
|
return nil, false
|
|
}
|
|
fullKey := c.key(key)
|
|
now := time.Now()
|
|
c.mu.Lock()
|
|
item, ok := c.obj[fullKey]
|
|
if !ok {
|
|
c.mu.Unlock()
|
|
return nil, false
|
|
}
|
|
if !now.Before(item.expiresAt) {
|
|
c.removeObjectLocked(fullKey)
|
|
c.mu.Unlock()
|
|
return nil, false
|
|
}
|
|
item.lastUsed = now
|
|
c.obj[fullKey] = item
|
|
c.mu.Unlock()
|
|
return item.value, true
|
|
}
|
|
|
|
// SetObject 存入一个此后视为不可变的对象。对象会按估算内存计入进程内缓存
|
|
// 总预算；单个对象超过预算时不会进入缓存，避免一次大列表请求再次打爆内存。
|
|
func (c *RuntimeCacheService) SetObject(key string, value any, ttl time.Duration) {
|
|
if !c.Enabled() || strings.TrimSpace(key) == "" || value == nil || ttl <= 0 {
|
|
return
|
|
}
|
|
fullKey := c.key(key)
|
|
size := estimateRuntimeCacheObjectSize(fullKey, value)
|
|
now := time.Now()
|
|
c.mu.Lock()
|
|
defer c.mu.Unlock()
|
|
if size <= 0 || size > c.maxBytes {
|
|
return
|
|
}
|
|
c.removeObjectLocked(fullKey)
|
|
if !c.makeRoomLocked(now, size) {
|
|
return
|
|
}
|
|
c.obj[fullKey] = runtimeObjectItem{
|
|
value: value,
|
|
expiresAt: now.Add(ttl),
|
|
lastUsed: now,
|
|
size: size,
|
|
}
|
|
c.bytesUsed += size
|
|
}
|
|
|
|
// SetMaxSizeMB 热更新进程内缓存总预算。降低上限时会立即淘汰最久未使用的
|
|
// 条目；传 0 或负数时恢复默认预算。
|
|
func (c *RuntimeCacheService) SetMaxSizeMB(maxMB int) {
|
|
if c == nil {
|
|
return
|
|
}
|
|
if maxMB <= 0 {
|
|
maxMB = config.DefaultCacheMemoryMaxSizeMB
|
|
}
|
|
maxBytes := int64(maxMB) * 1024 * 1024
|
|
now := time.Now()
|
|
c.mu.Lock()
|
|
defer c.mu.Unlock()
|
|
c.maxBytes = maxBytes
|
|
c.evictExpiredLocked(now)
|
|
for c.bytesUsed > c.maxBytes {
|
|
if !c.evictOldestLocked() {
|
|
break
|
|
}
|
|
}
|
|
}
|
|
|
|
func (c *RuntimeCacheService) DeletePrefix(ctx context.Context, prefix string) {
|
|
if !c.Enabled() || strings.TrimSpace(prefix) == "" {
|
|
return
|
|
}
|
|
fullPrefix := c.key(prefix)
|
|
c.deleteMemoryPrefix(fullPrefix)
|
|
if c.client != nil {
|
|
pattern := fullPrefix + "*"
|
|
var cursor uint64
|
|
for {
|
|
keys, next, err := c.client.Scan(ctx, cursor, pattern, 200).Result()
|
|
if err != nil {
|
|
return
|
|
}
|
|
if len(keys) > 0 {
|
|
_ = c.client.Del(ctx, keys...).Err()
|
|
}
|
|
cursor = next
|
|
if cursor == 0 {
|
|
return
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func (c *RuntimeCacheService) key(key string) string {
|
|
key = strings.TrimLeft(strings.TrimSpace(key), ":")
|
|
if c.prefix == "" {
|
|
return key
|
|
}
|
|
return c.prefix + ":" + key
|
|
}
|
|
|
|
func (c *RuntimeCacheService) getMemory(key string) ([]byte, bool) {
|
|
raw, ok, stale := c.getMemoryWithStale(key)
|
|
return raw, ok && !stale
|
|
}
|
|
|
|
func (c *RuntimeCacheService) getMemoryWithStale(key string) ([]byte, bool, bool) {
|
|
now := time.Now()
|
|
c.mu.Lock()
|
|
defer c.mu.Unlock()
|
|
item, ok := c.memory[key]
|
|
if !ok {
|
|
return nil, false, false
|
|
}
|
|
staleUntil := item.staleUntil
|
|
if staleUntil.IsZero() {
|
|
staleUntil = item.expiresAt
|
|
}
|
|
if !now.Before(staleUntil) {
|
|
c.removeMemoryLocked(key)
|
|
return nil, false, false
|
|
}
|
|
item.lastUsed = now
|
|
c.memory[key] = item
|
|
return item.raw, true, !now.Before(item.expiresAt)
|
|
}
|
|
|
|
func (c *RuntimeCacheService) setMemory(key string, raw []byte, ttl time.Duration) {
|
|
c.setMemoryBytes(key, raw, ttl, false)
|
|
}
|
|
|
|
func (c *RuntimeCacheService) setMemoryOwned(key string, raw []byte, ttl time.Duration) {
|
|
c.setMemoryBytes(key, raw, ttl, true)
|
|
}
|
|
|
|
func (c *RuntimeCacheService) setMemoryBytes(key string, raw []byte, ttl time.Duration, owned bool) {
|
|
c.setMemoryBytesWithStale(key, raw, ttl, ttl, owned)
|
|
}
|
|
|
|
func (c *RuntimeCacheService) setMemoryBytesWithStale(key string, raw []byte, freshTTL, staleTTL time.Duration, owned bool) {
|
|
if freshTTL <= 0 || len(raw) == 0 {
|
|
return
|
|
}
|
|
if staleTTL < freshTTL {
|
|
staleTTL = freshTTL
|
|
}
|
|
size := int64(len(key)+len(raw)) + runtimeCacheEntryOverheadBytes
|
|
now := time.Now()
|
|
c.mu.Lock()
|
|
defer c.mu.Unlock()
|
|
if size <= 0 || size > c.maxBytes {
|
|
return
|
|
}
|
|
c.removeMemoryLocked(key)
|
|
if !c.makeRoomLocked(now, size) {
|
|
return
|
|
}
|
|
if !owned {
|
|
raw = append([]byte(nil), raw...)
|
|
}
|
|
c.memory[key] = runtimeCacheItem{
|
|
raw: raw,
|
|
expiresAt: now.Add(freshTTL),
|
|
staleUntil: now.Add(staleTTL),
|
|
lastUsed: now,
|
|
size: size,
|
|
}
|
|
c.bytesUsed += size
|
|
}
|
|
|
|
func (c *RuntimeCacheService) makeRoomLocked(now time.Time, incoming int64) bool {
|
|
if incoming <= 0 {
|
|
incoming = 1
|
|
}
|
|
if c.limit <= 0 {
|
|
c.limit = defaultRuntimeCacheEntryLimit
|
|
}
|
|
if c.maxBytes <= 0 {
|
|
c.maxBytes = int64(config.DefaultCacheMemoryMaxSizeMB) * 1024 * 1024
|
|
}
|
|
if incoming > c.maxBytes {
|
|
return false
|
|
}
|
|
c.evictExpiredLocked(now)
|
|
for c.entryCountLocked() >= c.limit || c.bytesUsed+incoming > c.maxBytes {
|
|
if !c.evictOldestLocked() {
|
|
return false
|
|
}
|
|
}
|
|
return true
|
|
}
|
|
|
|
func (c *RuntimeCacheService) entryCountLocked() int {
|
|
return len(c.memory) + len(c.obj)
|
|
}
|
|
|
|
func (c *RuntimeCacheService) evictExpiredLocked(now time.Time) {
|
|
for key, item := range c.memory {
|
|
staleUntil := item.staleUntil
|
|
if staleUntil.IsZero() {
|
|
staleUntil = item.expiresAt
|
|
}
|
|
if !now.Before(staleUntil) {
|
|
c.removeMemoryLocked(key)
|
|
}
|
|
}
|
|
for key, item := range c.obj {
|
|
if !now.Before(item.expiresAt) {
|
|
c.removeObjectLocked(key)
|
|
}
|
|
}
|
|
}
|
|
|
|
func (c *RuntimeCacheService) evictOldestLocked() bool {
|
|
var (
|
|
oldestKey string
|
|
oldestKind byte
|
|
oldestAt time.Time
|
|
)
|
|
for key, item := range c.memory {
|
|
if oldestKind == 0 || item.lastUsed.Before(oldestAt) {
|
|
oldestKey, oldestKind, oldestAt = key, 'm', item.lastUsed
|
|
}
|
|
}
|
|
for key, item := range c.obj {
|
|
if oldestKind == 0 || item.lastUsed.Before(oldestAt) {
|
|
oldestKey, oldestKind, oldestAt = key, 'o', item.lastUsed
|
|
}
|
|
}
|
|
switch oldestKind {
|
|
case 'm':
|
|
c.removeMemoryLocked(oldestKey)
|
|
return true
|
|
case 'o':
|
|
c.removeObjectLocked(oldestKey)
|
|
return true
|
|
default:
|
|
return false
|
|
}
|
|
}
|
|
|
|
func (c *RuntimeCacheService) removeMemoryLocked(key string) {
|
|
item, ok := c.memory[key]
|
|
if !ok {
|
|
return
|
|
}
|
|
delete(c.memory, key)
|
|
c.bytesUsed -= item.size
|
|
if c.bytesUsed < 0 {
|
|
c.bytesUsed = 0
|
|
}
|
|
}
|
|
|
|
func (c *RuntimeCacheService) removeObjectLocked(key string) {
|
|
item, ok := c.obj[key]
|
|
if !ok {
|
|
return
|
|
}
|
|
delete(c.obj, key)
|
|
c.bytesUsed -= item.size
|
|
if c.bytesUsed < 0 {
|
|
c.bytesUsed = 0
|
|
}
|
|
}
|
|
|
|
func (c *RuntimeCacheService) deleteMemoryPrefix(prefix string) {
|
|
c.mu.Lock()
|
|
defer c.mu.Unlock()
|
|
for key := range c.memory {
|
|
if strings.HasPrefix(key, prefix) {
|
|
c.removeMemoryLocked(key)
|
|
}
|
|
}
|
|
for key := range c.obj {
|
|
if strings.HasPrefix(key, prefix) {
|
|
c.removeObjectLocked(key)
|
|
}
|
|
}
|
|
}
|
|
|
|
type runtimeCacheVisit struct {
|
|
kind reflect.Kind
|
|
ptr uintptr
|
|
}
|
|
|
|
func estimateRuntimeCacheObjectSize(key string, value any) int64 {
|
|
seen := make(map[runtimeCacheVisit]struct{})
|
|
size := int64(len(key)) + runtimeCacheEntryOverheadBytes
|
|
size += estimateRuntimeCacheReflectSize(reflect.ValueOf(value), seen, 0)
|
|
return size
|
|
}
|
|
|
|
func estimateRuntimeCacheReflectSize(v reflect.Value, seen map[runtimeCacheVisit]struct{}, depth int) int64 {
|
|
if !v.IsValid() || depth > runtimeCacheEstimateMaxDepth {
|
|
return 0
|
|
}
|
|
switch v.Kind() {
|
|
case reflect.Interface:
|
|
if v.IsNil() {
|
|
return 0
|
|
}
|
|
return estimateRuntimeCacheReflectSize(v.Elem(), seen, depth+1)
|
|
case reflect.Pointer:
|
|
if v.IsNil() || markRuntimeCacheVisit(v, seen) {
|
|
return 0
|
|
}
|
|
return int64(v.Type().Elem().Size()) + estimateRuntimeCacheNestedSize(v.Elem(), seen, depth+1)
|
|
case reflect.String:
|
|
return int64(len(v.String())) + runtimeCacheStringHeaderBytes
|
|
case reflect.Slice:
|
|
if v.IsNil() || markRuntimeCacheVisit(v, seen) {
|
|
return 0
|
|
}
|
|
total := int64(v.Type().Size()) + int64(v.Cap())*int64(v.Type().Elem().Size())
|
|
for i := 0; i < v.Len(); i++ {
|
|
total += estimateRuntimeCacheNestedSize(v.Index(i), seen, depth+1)
|
|
}
|
|
return total
|
|
case reflect.Map:
|
|
if v.IsNil() || markRuntimeCacheVisit(v, seen) {
|
|
return 0
|
|
}
|
|
total := int64(v.Type().Size()) + int64(v.Len())*runtimeCacheMapEntryOverheadBytes
|
|
iter := v.MapRange()
|
|
for iter.Next() {
|
|
total += estimateRuntimeCacheNestedSize(iter.Key(), seen, depth+1)
|
|
total += estimateRuntimeCacheNestedSize(iter.Value(), seen, depth+1)
|
|
}
|
|
return total
|
|
case reflect.Struct:
|
|
total := int64(v.Type().Size())
|
|
for i := 0; i < v.NumField(); i++ {
|
|
total += estimateRuntimeCacheNestedSize(v.Field(i), seen, depth+1)
|
|
}
|
|
return total
|
|
case reflect.Array:
|
|
total := int64(v.Type().Size())
|
|
for i := 0; i < v.Len(); i++ {
|
|
total += estimateRuntimeCacheNestedSize(v.Index(i), seen, depth+1)
|
|
}
|
|
return total
|
|
default:
|
|
return int64(v.Type().Size())
|
|
}
|
|
}
|
|
|
|
func estimateRuntimeCacheNestedSize(v reflect.Value, seen map[runtimeCacheVisit]struct{}, depth int) int64 {
|
|
if !v.IsValid() || depth > runtimeCacheEstimateMaxDepth {
|
|
return 0
|
|
}
|
|
switch v.Kind() {
|
|
case reflect.Interface, reflect.Pointer:
|
|
return estimateRuntimeCacheReflectSize(v, seen, depth+1)
|
|
case reflect.String:
|
|
return int64(len(v.String()))
|
|
case reflect.Slice:
|
|
if v.IsNil() || markRuntimeCacheVisit(v, seen) {
|
|
return 0
|
|
}
|
|
total := int64(v.Cap()) * int64(v.Type().Elem().Size())
|
|
for i := 0; i < v.Len(); i++ {
|
|
total += estimateRuntimeCacheNestedSize(v.Index(i), seen, depth+1)
|
|
}
|
|
return total
|
|
case reflect.Map:
|
|
if v.IsNil() || markRuntimeCacheVisit(v, seen) {
|
|
return 0
|
|
}
|
|
total := int64(v.Len()) * runtimeCacheMapEntryOverheadBytes
|
|
iter := v.MapRange()
|
|
for iter.Next() {
|
|
total += estimateRuntimeCacheNestedSize(iter.Key(), seen, depth+1)
|
|
total += estimateRuntimeCacheNestedSize(iter.Value(), seen, depth+1)
|
|
}
|
|
return total
|
|
case reflect.Struct:
|
|
total := int64(0)
|
|
for i := 0; i < v.NumField(); i++ {
|
|
total += estimateRuntimeCacheNestedSize(v.Field(i), seen, depth+1)
|
|
}
|
|
return total
|
|
case reflect.Array:
|
|
total := int64(0)
|
|
for i := 0; i < v.Len(); i++ {
|
|
total += estimateRuntimeCacheNestedSize(v.Index(i), seen, depth+1)
|
|
}
|
|
return total
|
|
default:
|
|
return 0
|
|
}
|
|
}
|
|
|
|
func markRuntimeCacheVisit(v reflect.Value, seen map[runtimeCacheVisit]struct{}) bool {
|
|
ptr := v.Pointer()
|
|
if ptr == 0 {
|
|
return false
|
|
}
|
|
visit := runtimeCacheVisit{kind: v.Kind(), ptr: ptr}
|
|
if _, ok := seen[visit]; ok {
|
|
return true
|
|
}
|
|
seen[visit] = struct{}{}
|
|
return false
|
|
}
|