// Copyright 2014 beego Author. All Rights Reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package cache import ( "context" "encoding/json" "fmt" "strings" "sync" "time" "github.com/beego/beego/v2/core/berror" ) // DefaultEvery sets a timer for how often to recycle the expired cache items in memory (in seconds) var DefaultEvery = 60 // 1 minute // MemoryItem stores memory cache item. type MemoryItem struct { val interface{} createdTime time.Time lifespan time.Duration } func (mi *MemoryItem) isExpire() bool { // 0 means forever if mi.lifespan == 0 { return false } return time.Since(mi.createdTime) > mi.lifespan } // MemoryCache is a memory cache adapter. // Contains a RW locker for safe map storage. type MemoryCache struct { sync.RWMutex dur time.Duration items map[string]*MemoryItem Every int // run an expiration check Every clock time } // NewMemoryCache returns a new MemoryCache. func NewMemoryCache() Cache { cache := MemoryCache{items: make(map[string]*MemoryItem)} return &cache } // Get returns cache from memory. // If non-existent or expired, return nil. func (bc *MemoryCache) Get(ctx context.Context, key string) (interface{}, error) { bc.RLock() defer bc.RUnlock() if itm, ok := bc.items[key]; ok { if itm.isExpire() { return nil, ErrKeyExpired } return itm.val, nil } return nil, ErrKeyNotExist } // GetMulti gets caches from memory. // If non-existent or expired, return nil. func (bc *MemoryCache) GetMulti(ctx context.Context, keys []string) ([]interface{}, error) { rc := make([]interface{}, len(keys)) keysErr := make([]string, 0) for i, ki := range keys { val, err := bc.Get(context.Background(), ki) if err != nil { keysErr = append(keysErr, fmt.Sprintf("key [%s] error: %s", ki, err.Error())) continue } rc[i] = val } if len(keysErr) == 0 { return rc, nil } return rc, berror.Error(MultiGetFailed, strings.Join(keysErr, "; ")) } // Put puts cache into memory. // If lifespan is 0, it will never overwrite this value unless restarted func (bc *MemoryCache) Put(ctx context.Context, key string, val interface{}, timeout time.Duration) error { bc.Lock() defer bc.Unlock() bc.items[key] = &MemoryItem{ val: val, createdTime: time.Now(), lifespan: timeout, } return nil } // Delete cache in memory. // If the key is not found, it will not return error func (bc *MemoryCache) Delete(ctx context.Context, key string) error { bc.Lock() defer bc.Unlock() delete(bc.items, key) return nil } // Incr increases cache counter in memory. // Supports int,int32,int64,uint,uint32,uint64. func (bc *MemoryCache) Incr(ctx context.Context, key string) error { bc.Lock() defer bc.Unlock() itm, ok := bc.items[key] if !ok { return ErrKeyNotExist } val, err := incr(itm.val) if err != nil { return err } itm.val = val return nil } // Decr decreases counter in memory. func (bc *MemoryCache) Decr(ctx context.Context, key string) error { bc.Lock() defer bc.Unlock() itm, ok := bc.items[key] if !ok { return ErrKeyNotExist } val, err := decr(itm.val) if err != nil { return err } itm.val = val return nil } // IsExist checks if cache exists in memory. func (bc *MemoryCache) IsExist(ctx context.Context, key string) (bool, error) { bc.RLock() defer bc.RUnlock() if v, ok := bc.items[key]; ok { return !v.isExpire(), nil } return false, nil } // ClearAll deletes all cache in memory. func (bc *MemoryCache) ClearAll(context.Context) error { bc.Lock() defer bc.Unlock() bc.items = make(map[string]*MemoryItem) return nil } // StartAndGC starts memory cache. Checks expiration in every clock time. func (bc *MemoryCache) StartAndGC(config string) error { var cf map[string]int if err := json.Unmarshal([]byte(config), &cf); err != nil { return berror.Wrapf(err, InvalidMemoryCacheCfg, "invalid config, please check your input: %s", config) } if _, ok := cf["interval"]; !ok { cf = make(map[string]int) cf["interval"] = DefaultEvery } dur := time.Duration(cf["interval"]) * time.Second bc.Every = cf["interval"] bc.dur = dur go bc.vacuum() return nil } // check expiration. func (bc *MemoryCache) vacuum() { bc.RLock() every := bc.Every bc.RUnlock() if every < 1 { return } for { <-time.After(bc.dur) bc.RLock() if bc.items == nil { bc.RUnlock() return } bc.RUnlock() if keys := bc.expiredKeys(); len(keys) != 0 { bc.clearItems(keys) } } } // expiredKeys returns keys list which are expired. func (bc *MemoryCache) expiredKeys() (keys []string) { bc.RLock() defer bc.RUnlock() for key, itm := range bc.items { if itm.isExpire() { keys = append(keys, key) } } return } // ClearItems removes all items who's key is in keys func (bc *MemoryCache) clearItems(keys []string) { bc.Lock() defer bc.Unlock() for _, key := range keys { delete(bc.items, key) } } func init() { Register("memory", NewMemoryCache) }