kongxinchi / cacheya

Golang 缓存封装，支持Context、内存、Redis多种缓存适配，实现便捷的 Cache-Aside 操作

cacheya

介绍

Golang 缓存封装，支持Context、内存、Redis多种缓存适配，实现便捷的 Cache-Aside 操作

基本使用

type TestObject struct {
    Id   string
    A    float32
    B    uint32
}


ctx := context.Background()

// 初始化：Redis缓存
opt := &redis.Options{
    Addr:     "127.0.0.1:6379",
}
client := redis.NewClient(opt)

adapter := goredis.NewRedisCache(client)
manager := NewCacheManager[TestObject, string]("TEST_OBJECT", adapter)   // 范型中第一个指定缓存的对象，第二个指定id的类型

// 初始化：内存缓存
client, _ := ristretto.NewCache(
    &ristretto.Config{
        NumCounters: 1e7,  // number of keys to track frequency of (10M).
        MaxCost:     10e7, // maximum cost of cache (100M).
        BufferItems: 64,   // number of keys per Get buf
    },
)
adapter := memory.NewRistrettoCache(client)
manager := NewCacheManager[TestObject, string]("TEST_OBJECT", adapter)

// 初始化：Context缓存
// 注意，使用时需要在服务内ctx生命周期开始时（比如grpc的中间件中），使用WithCtxCache对ctx开启缓存，否则无效
adapter := ctxcache.NewContextCache()
manager := NewCacheManager[TestObject, string]("TEST_OBJECT", adapter)

// 单数据操作
r, c, err := manager.Get(ctx, "1")                 // Get
err = manager.Set(ctx, "2", &TestObject{Id: "2"})  // Set
err = manager.Del(ctx, "1")                        // Del
r, err = manager.Load(                             // Cache-Aside
    ctx, "1", func(k string) (*TestObject, error) {
        // 这里实现回源的代码
    },
)

r, err = manager.Loadv(                            // Cache-Aside，与Load的区别是，这个回源和最终返回都是值，适用于缓存基本类型string、bool的这种场景
    ctx, "1", func(k string) (TestObject, error) {
    // 这里实现回源的代码
    },
)


// 批量操作
r, err := manager.MGet(ctx, []string{"1", "2"})    // MGet
err = manager.MSet(ctx, kv)                        // MSet
err = manager.MDel(ctx, []string{"1", "2"})        // MDel
r, err = manager.MLoad(                            // Multi Cache-Aside
    ctx, []string{"1", "2"}, func(ks []string) (map[string]*TestObject, error) {
        // 这里实现回源的代码
    },
)

r, err = manager.MLoadv(                            // Multi Cache-Aside，与MLoad的区别是，这个回源和最终返回都是值，适用于缓存基本类型string、bool的这种场景
    ctx, []string{"1", "2"}, func(ks []string) (map[string]TestObject, error) {
    // 这里实现回源的代码
    },
)