GO 自定义Cache

DEMO

package main

import (
	"fmt"
	"sync"
	"time"
)

// 缓存对象
type CacheItem struct {
	Value     interface{}   // 实际缓存的对象
	TTL       time.Duration // 存活时间
	CreatedAt time.Time     // 创建时间，和 TTL 一起决定是否过期
}

// 缓存是否过期
func (c *CacheItem) Expired() bool {
	return time.Now().Sub(c.CreatedAt) > c.TTL
}

// 本地缓存实现类
type LocalCache struct {
	sync.RWMutex                       // 继承读写锁，用于并发控制
	Items        map[string]*CacheItem // K-V存储
	GCDuration   time.Duration         // 惰性删除， 后台运行时间间隔
}

// 新建本地缓存
func NewLocalCache(gcDuration time.Duration) *LocalCache {
	localCache := &LocalCache{Items: map[string]*CacheItem{}, GCDuration: gcDuration}

	// 启动协程，定期扫描过期键，进行删除
	go localCache.GC()

	return localCache
}

// 存入对象
func (lc *LocalCache) Set(key string, value interface{}, ttl time.Duration) {
	lc.Lock()
	defer lc.Unlock()

	lc.Items[key] = &CacheItem{
		Value:     value,
		TTL:       ttl,
		CreatedAt: time.Now(),
	}
}

// 查询对象 key不存在或过期返回: nil 正常返回: 实际存储的对象 CacheItem.Value
func (lc *LocalCache) Get(key string) interface{} {
	lc.RLock()
	defer lc.RUnlock()

	if item, ok := lc.Items[key]; ok {
		if !item.Expired() {
			return item.Value
		} else {
			// 键已过期, 直接删除
			// 需要注意的是，这里不能调用lc.Del()方法，因为go的读写锁是不支持锁升级的
			delete(lc.Items, key)
		}
	}

	return nil
}

// 删除缓存
func (lc *LocalCache) Del(key string) {
	lc.Lock()
	defer lc.Unlock()

	if _, ok := lc.Items[key]; ok {
		delete(lc.Items, key)
	}
}

// 异步执行，扫描过期键并删除
func (lc *LocalCache) GC() {
	for {
		select {
		case <-time.After(lc.GCDuration):
			keysToExpire := []string{}

			lc.RLock()
			for key, item := range lc.Items {
				if item.Expired() {
					keysToExpire = append(keysToExpire, key)
				}
			}
			lc.RUnlock()

			for _, k := range keysToExpire {
				lc.Del(k)
			}
		}
	}
}

func main() {
	// 创建一个每 10 秒钟惰性清理过期对象的 cache
	cache := NewLocalCache(10 * time.Second)

	// 获取一个不存在的 key
	get, _ := cache.Get("todo").(string)
	fmt.Printf("get = %v\n", get)

	// 设置 过期时间为 5秒 的 k-v
	cache.Set("todo", "something", 5*time.Second)

	// 获取存在且未过期的 k-v
	get2, _ := cache.Get("todo").(string)
	fmt.Printf("get2 = %v\n", get2)

	// 获取过期的 k-v, 并查看是否被清理
	time.Sleep(5 * time.Second)
	get3, _ := cache.Get("todo").(string)
	fmt.Printf("get3 = %v\n", get3)
	fmt.Printf("cache = %v\n", cache)

	// ----------------------------

	// 设置一个5秒过期的 k-v 等待惰性回收时间后 查看是否被清理
	cache.Set("test", "hello", 5*time.Second)
	get4, _ := cache.Get("test").(string)
	fmt.Printf("get4 = %v\n", get4)
	fmt.Printf("cache = %v\n", cache)

	time.Sleep(10*time.Second)
	fmt.Printf("等待10s后cache = %v\n", cache)
}