Gocache

猜猜Gocache是什么？一个Go缓存库。这是一个可扩展的缓存库，为您提供了许多缓存数据的功能。

概述

以下是它具体提供的功能：

✅ 多种缓存存储：实际上包括内存、redis或您自己的自定义存储
✅ 链式缓存：按优先顺序使用多个缓存（例如先使用内存，然后回退到redis共享缓存）
✅ 可加载缓存：允许您调用回调函数将数据重新放入缓存
✅ 指标缓存，让您存储有关缓存使用情况的指标（命中、未命中、设置成功、设置错误等）
✅ 自动对缓存值进行结构体的编组/解组的编组器
✅ 在存储中定义默认值，并在设置数据时覆盖它们
✅ 通过过期时间和/或使用标签进行缓存失效
✅ 使用泛型

内置存储

内存 (bigcache) (allegro/bigcache)
内存 (ristretto) (dgraph-io/ristretto)
内存 (go-cache) (patrickmn/go-cache)
Memcache (bradfitz/memcache)
Redis (go-redis/redis)
Redis (rueidis) (redis/rueidis)
Freecache (coocood/freecache)
Pegasus (apache/incubator-pegasus) 基准测试
Hazelcast (hazelcast-go-client/hazelcast)
更多即将推出

内置指标提供者

Prometheus

安装

要开始使用最新版本的gocache，您可以在项目中导入该库：

go get github.com/eko/gocache/lib/v4

然后，在所有可用的存储中导入您想要使用的存储：

go get github.com/eko/gocache/store/bigcache/v4
go get github.com/eko/gocache/store/freecache/v4
go get github.com/eko/gocache/store/go_cache/v4
go get github.com/eko/gocache/store/hazelcast/v4
go get github.com/eko/gocache/store/memcache/v4
go get github.com/eko/gocache/store/pegasus/v4
go get github.com/eko/gocache/store/redis/v4
go get github.com/eko/gocache/store/rediscluster/v4
go get github.com/eko/gocache/store/rueidis/v4
go get github.com/eko/gocache/store/ristretto/v4

然后，简单地使用以下导入语句：

import (
	"github.com/eko/gocache/lib/v4/cache"
	"github.com/eko/gocache/store/redis/v4"
)

如果遇到任何错误，请确保运行go mod tidy来清理您的go.mod文件。

详细的可用缓存功能

简单缓存

这里是使用Redis的简单缓存实例化，但您也可以查看其他可用的存储：

Memcache

memcacheStore := memcache_store.NewMemcache(
	memcache.New("10.0.0.1:11211", "10.0.0.2:11211", "10.0.0.3:11212"),
	store.WithExpiration(10*time.Second),
)

cacheManager := cache.New[[]byte](memcacheStore)
err := cacheManager.Set(ctx, "my-key", []byte("my-value"),
	store.WithExpiration(15*time.Second), // 覆盖存储中定义的10秒默认值
)
if err != nil {
    panic(err)
}

value := cacheManager.Get(ctx, "my-key")

cacheManager.Delete(ctx, "my-key")

cacheManager.Clear(ctx) // 清除整个缓存，以防您想刷新所有缓存

内存 (使用 Bigcache)

bigcacheClient, _ := bigcache.NewBigCache(bigcache.DefaultConfig(5 * time.Minute))
bigcacheStore := bigcache_store.NewBigcache(bigcacheClient)

cacheManager := cache.New[[]byte](bigcacheStore)
err := cacheManager.Set(ctx, "my-key", []byte("my-value"))
if err != nil {
    panic(err)
}

value := cacheManager.Get(ctx, "my-key")

内存 (使用 Ristretto)

import (
	"github.com/dgraph-io/ristretto"
	"github.com/eko/gocache/lib/v4/cache"
	"github.com/eko/gocache/lib/v4/store"
	ristretto_store "github.com/eko/gocache/store/ristretto/v4"
)
ristrettoCache, err := ristretto.NewCache(&ristretto.Config{
	NumCounters: 1000,
	MaxCost: 100,
	BufferItems: 64,
})
if err != nil {
    panic(err)
}
ristrettoStore := ristretto_store.NewRistretto(ristrettoCache)

cacheManager := cache.New[string](ristrettoStore)
err := cacheManager.Set(ctx, "my-key", "my-value", store.WithCost(2))
if err != nil {
    panic(err)
}

value := cacheManager.Get(ctx, "my-key")

cacheManager.Delete(ctx, "my-key")

内存 (使用 Go-cache)

gocacheClient := gocache.New(5*time.Minute, 10*time.Minute)
gocacheStore := gocache_store.NewGoCache(gocacheClient)

cacheManager := cache.New[[]byte](gocacheStore)
err := cacheManager.Set(ctx, "my-key", []byte("my-value"))
if err != nil {
	panic(err)
}

value, err := cacheManager.Get(ctx, "my-key")
if err != nil {
	panic(err)
}
fmt.Printf("%s", value)

Redis

redisStore := redis_store.NewRedis(redis.NewClient(&redis.Options{
	Addr: "127.0.0.1:6379",
}))

cacheManager := cache.New[string](redisStore)
err := cacheManager.Set(ctx, "my-key", "my-value", store.WithExpiration(15*time.Second))
if err != nil {
    panic(err)
}

value, err := cacheManager.Get(ctx, "my-key")
switch err {
	case nil:
		fmt.Printf("从redis缓存中获取键'%s'。结果：%s", "my-key", value)
	case redis.Nil:
		fmt.Printf("未能从redis缓存中找到键'%s'。", "my-key")
	default:
	    fmt.Printf("未能从redis缓存中获取键'%s'的值：%v", "my-key", err)
}

Redis客户端侧缓存 (使用 rueidis)

client, err := rueidis.NewClient(rueidis.ClientOption{InitAddress: []string{"127.0.0.1:6379"}})
if err != nil {
    panic(err)
}

cacheManager := cache.New[string](rueidis_store.NewRueidis(
    client,
    store.WithExpiration(15*time.Second),
    store.WithClientSideCaching(15*time.Second)),
)

if err = cacheManager.Set(ctx, "my-key", "my-value"); err != nil {
    panic(err)
}

value, err := cacheManager.Get(ctx, "my-key")
if err != nil {
    log.Fatalf("未能从redis缓存中获取键'%s'的值：%v", "my-key", err)
}
log.Printf("从redis缓存中获取键'%s'。结果：%s", "my-key", value)

Freecache

freecacheStore := freecache_store.NewFreecache(freecache.NewCache(1000), store.WithExpiration(10 * time.Second))

cacheManager := cache.New[[]byte](freecacheStore)
err := cacheManager.Set(ctx, "by-key", []byte("my-value"), opts)
if err != nil {
    panic(err)
}

value := cacheManager.Get(ctx, "my-key")

Pegasus

pegasusStore, err := pegasus_store.NewPegasus(&store.OptionsPegasus{
    MetaServers: []string{"127.0.0.1:34601", "127.0.0.1:34602", "127.0.0.1:34603"},
})

if err != nil {
    fmt.Println(err)
    return
}

cacheManager := cache.New[string](pegasusStore)
err = cacheManager.Set(ctx, "my-key", "my-value", store.WithExpiration(10 * time.Second))
if err != nil {
    panic(err)
}

value, _ := cacheManager.Get(ctx, "my-key")

Hazelcast

hzClient, err := hazelcast.StartNewClient(ctx)
if err != nil {
    log.Fatalf("启动客户端失败：%v", err)
}

hzMap, err := hzClient.GetMap(ctx, "gocache")
if err != nil {
    b.Fatalf("获取地图失败：%v", err)
}

hazelcastStore := hazelcast_store.NewHazelcast(hzMap)

cacheManager := cache.New[string](hazelcastStore)
err := cacheManager.Set(ctx, "my-key", "my-value", store.WithExpiration(15*time.Second))
if err != nil {
    panic(err)
}

value, err := cacheManager.Get(ctx, "my-key")
if err != nil {
    panic(err)
}
fmt.Printf("从hazelcast缓存中获取键'%s'。结果：%s", "my-key", value)

链式缓存

在这里，我们将按以下顺序链接缓存：首先使用Ristretto存储在内存中，然后使用Redis（作为后备）：

// 初始化Ristretto缓存和Redis客户端
ristrettoCache, err := ristretto.NewCache(&ristretto.Config{NumCounters: 1000, MaxCost: 100, BufferItems: 64})
if err != nil {
    panic(err)
}

redisClient := redis.NewClient(&redis.Options{Addr: "127.0.0.1:6379"})

// 初始化存储
ristrettoStore := ristretto_store.NewRistretto(ristrettoCache)
redisStore := redis_store.NewRedis(redisClient, store.WithExpiration(5*time.Second))

// 初始化链式缓存
cacheManager := cache.NewChain[any](
    cache.New[any](ristrettoStore),
    cache.New[any](redisStore),
)

// ... 然后，用你的缓存做你想做的事

Chain缓存在找到数据时也会将数据放回之前的缓存中，所以在这种情况下，如果ristretto在其缓存中没有数据但redis有，数据也会被设置回ristretto（内存）缓存中。

可加载缓存

这个缓存将提供一个加载函数，作为可调用函数，在数据不可用时将数据重新设置到缓存中：

type Book struct {
	ID string
	Name string
}
// 初始化 Redis 客户端和存储
redisClient := redis.NewClient(&redis.Options{Addr: "127.0.0.1:6379"})
redisStore := redis_store.NewRedis(redisClient)

// 初始化一个从自定义源加载数据的函数
loadFunction := func(ctx context.Context, key any) (*Book, error) {
    // ... 从可用源检索值
    return &Book{ID: 1, Name: "我的测试精彩图书"}, nil
}

// 初始化可加载缓存
cacheManager := cache.NewLoadable[*Book](
	loadFunction,
	cache.New[*Book](redisStore),
)

// ... 然后，你可以获取你的数据，你的函数将自动将它们放入缓存中

当然，你也可以将Chain缓存传递给Loadable缓存，这样如果你的数据在所有缓存中都不可用，它会将数据带回所有缓存中。

用于检索缓存统计信息的度量缓存

这个缓存将根据你传递给它的度量提供者记录度量。这里我们给出一个Prometheus提供者：

// 初始化 Redis 客户端和存储
redisClient := redis.NewClient(&redis.Options{Addr: "127.0.0.1:6379"})
redisStore := redis_store.NewRedis(redisClient)

// 初始化Prometheus度量服务
promMetrics := metrics.NewPrometheus("my-test-app")

// 初始化度量缓存
cacheManager := cache.NewMetric[any](
	promMetrics,
	cache.New[any](redisStore),
)

// ... 然后，你可以获取你的数据，度量将被Prometheus观察

一个编组器包装器

一些缓存如Redis存储和返回值为字符串，所以如果你想缓存一个对象，你必须编组/解组你的结构体。这就是为什么我们提供了一个编组器服务，它包装你的缓存并为你完成这项工作：

// 初始化 Redis 客户端和存储
redisClient := redis.NewClient(&redis.Options{Addr: "127.0.0.1:6379"})
redisStore := redis_store.NewRedis(redisClient)

// 初始化链式缓存
cacheManager := cache.NewMetric[any](
	promMetrics,
	cache.New[any](redisStore),
)

// 初始化编组器
marshal := marshaler.New(cacheManager)

key := BookQuery{Slug: "my-test-amazing-book"}
value := Book{ID: 1, Name: "我的测试精彩图书", Slug: "my-test-amazing-book"}

err = marshal.Set(ctx, key, value)
if err != nil {
    panic(err)
}

returnedValue, err := marshal.Get(ctx, key, new(Book))
if err != nil {
    panic(err)
}

// 然后，对返回的值进行你想要的操作

marshal.Delete(ctx, "my-key")

你唯一需要做的是在调用.Get()方法时指定你想要将值解组到的结构体作为第二个参数。

使用标签进行缓存失效

你可以为创建的项目附加一些标签，以便以后轻松地使其失效。

标签使用与你为缓存选择的相同存储进行存储。

以下是如何使用它的示例：

// 初始化 Redis 客户端和存储
redisClient := redis.NewClient(&redis.Options{Addr: "127.0.0.1:6379"})
redisStore := redis_store.NewRedis(redisClient)

// 初始化链式缓存
cacheManager := cache.NewMetric[*Book](
	promMetrics,
	cache.New[*Book](redisStore),
)

// 初始化编组器
marshal := marshaler.New(cacheManager)

key := BookQuery{Slug: "my-test-amazing-book"}
value := &Book{ID: 1, Name: "我的测试精彩图书", Slug: "my-test-amazing-book"}

// 在缓存中设置一个项目并附加一个"book"标签
err = marshal.Set(ctx, key, value, store.WithTags([]string{"book"}))
if err != nil {
    panic(err)
}

// 删除所有具有"book"标签的项目
err := marshal.Invalidate(ctx, store.WithInvalidateTags([]string{"book"}))
if err != nil {
    panic(err)
}

returnedValue, err := marshal.Get(ctx, key, new(Book))
if err != nil {
	// 应该被触发，因为项目已被删除，所以无法找到。
    panic(err)
}

将此与缓存的过期时间结合使用，以对你的数据如何被缓存进行精细控制。

package main

import (
	"fmt"
	"log"
	"time"

	"github.com/eko/gocache/lib/v4/cache"
	"github.com/eko/gocache/lib/v4/store"
	"github.com/redis/go-redis/v9"
)

func main() {
	redisStore := redis_store.NewRedis(redis.NewClient(&redis.Options{
		Addr: "127.0.0.1:6379",
	}), nil)

	cacheManager := cache.New[string](redisStore)
	err := cacheManager.Set(ctx, "my-key", "my-value", store.WithExpiration(15*time.Second))
	if err != nil {
		panic(err)
	}

	key := "my-key"
	value, err := cacheManager.Get(ctx, key)
	if err != nil {
		log.Fatalf("无法从缓存中获取缓存键 '%s'：%v", key, err)
	}

	fmt.Printf("%#+v\n", value)
}

编写你自己的自定义缓存

缓存遵循以下接口，因此你可以通过实现以下接口来编写自己的（专有？）缓存逻辑：

type CacheInterface[T any] interface {
	Get(ctx context.Context, key any) (T, error)
	Set(ctx context.Context, key any, object T, options ...store.Option) error
	Delete(ctx context.Context, key any) error
	Invalidate(ctx context.Context, options ...store.InvalidateOption) error
	Clear(ctx context.Context) error
	GetType() string
}

或者，如果你使用setter缓存，还要实现GetCodec()方法：

type SetterCacheInterface[T any] interface {
	CacheInterface[T]
	GetWithTTL(ctx context.Context, key any) (T, time.Duration, error)

	GetCodec() codec.CodecInterface
}

由于此库中的所有缓存都实现了CacheInterface，你将能够将自己的缓存与你自己的缓存混合使用。

编写你自己的自定义存储

你还可以通过实现以下接口来编写自己的自定义存储：

type StoreInterface interface {
	Get(ctx context.Context, key any) (any, error)
	GetWithTTL(ctx context.Context, key any) (any, time.Duration, error)
	Set(ctx context.Context, key any, value any, options ...Option) error
	Delete(ctx context.Context, key any) error
	Invalidate(ctx context.Context, options ...InvalidateOption) error
	Clear(ctx context.Context) error
	GetType() string
}

当然，我建议你看看当前的缓存或存储来实现你自己的。

自定义缓存键生成器

你可以实现以下接口来生成自定义缓存键：

type CacheKeyGenerator interface {
	GetCacheKey() string
}

基准测试

运行测试

要使用mockgen库生成模拟，请运行：

$ make mocks

测试套件可以通过以下方式运行：

$ make test # 运行单元测试

社区

请随时为这个库做出贡献，如果你想讨论某个功能，请不要犹豫，直接开一个issue。

gocache

Gocache

概述

内置存储

内置指标提供者

安装

详细的可用缓存功能

简单缓存

Memcache

内存 (使用 Bigcache)

内存 (使用 Ristretto)

内存 (使用 Go-cache)

Redis

Redis客户端侧缓存 (使用 rueidis)

Freecache

Pegasus

Hazelcast

链式缓存

可加载缓存

用于检索缓存统计信息的度量缓存

一个编组器包装器

使用标签进行缓存失效

编写你自己的自定义缓存

编写你自己的自定义存储

自定义缓存键生成器

基准测试

运行测试

社区

编辑推荐精选

QoderWork

音述AI

lynote.ai

AniShort

seedancetwo2.0

nano-banana纳米香蕉中文站

扣子-AI办公

堆友

码上飞

Vora

探索AI的无限可能

推荐工具精选

TRAE编程

扣子-AI办公

码上飞

商汤小浣熊

讯飞绘文

讯飞绘镜

iTerms

AI云服务特惠

火山引擎

阿里云

腾讯云

华为云

百度智能云

AWS

关注微信公众号