- Notifications
You must be signed in to change notification settings - Fork204
☔️ A complete Go cache library that brings you multiple ways of managing your caches
License
eko/gocache
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Guess what is Gocache? a Go cache library.This is an extendable cache library that brings you a lot of features for caching data.
Here is what it brings in detail:
- ✅ Multiple cache stores: actually in memory, redis, or your own custom store
- ✅ A chain cache: use multiple cache with a priority order (memory then fallback to a redis shared cache for instance)
- ✅ A loadable cache: allow you to call a callback function to put your data back in cache
- ✅ A metric cache to let you store metrics about your caches usage (hits, miss, set success, set error, ...)
- ✅ A marshaler to automatically marshal/unmarshal your cache values as a struct
- ✅ Define default values in stores and override them when setting data
- ✅ Cache invalidation by expiration time and/or using tags
- ✅ Use of Generics
- Memory (bigcache) (allegro/bigcache)
- Memory (ristretto) (dgraph-io/ristretto)
- Memory (go-cache) (patrickmn/go-cache)
- Memcache (bradfitz/memcache)
- Redis (go-redis/redis)
- Redis (rueidis) (redis/rueidis)
- Freecache (coocood/freecache)
- Pegasus (apache/incubator-pegasus)benchmark
- Hazelcast (hazelcast-go-client/hazelcast)
- More to come soon
To begin working with the latest version of gocache, you can import the library in your project:
gogetgithub.com/eko/gocache/lib/v4
and then, import the store(s) you want to use between all available ones:
gogetgithub.com/eko/gocache/store/bigcache/v4gogetgithub.com/eko/gocache/store/freecache/v4gogetgithub.com/eko/gocache/store/go_cache/v4gogetgithub.com/eko/gocache/store/hazelcast/v4gogetgithub.com/eko/gocache/store/memcache/v4gogetgithub.com/eko/gocache/store/pegasus/v4gogetgithub.com/eko/gocache/store/redis/v4gogetgithub.com/eko/gocache/store/rediscluster/v4gogetgithub.com/eko/gocache/store/rueidis/v4gogetgithub.com/eko/gocache/store/ristretto/v4
Then, simply use the following import statements:
import ("github.com/eko/gocache/lib/v4/cache""github.com/eko/gocache/store/redis/v4")
If you run into any errors, please be sure to rungo mod tidy to clean your go.mod file.
Here is a simple cache instantiation with Redis but you can also look at other available stores:
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),// Override default value of 10 seconds defined in the store)iferr!=nil {panic(err)}value:=cacheManager.Get(ctx,"my-key")cacheManager.Delete(ctx,"my-key")cacheManager.Clear(ctx)// Clears the entire cache, in case you want to flush all cache
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"))iferr!=nil {panic(err)}value:=cacheManager.Get(ctx,"my-key")
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,})iferr!=nil {panic(err)}ristrettoStore:=ristretto_store.NewRistretto(ristrettoCache)cacheManager:= cache.New[string](ristrettoStore)err:=cacheManager.Set(ctx,"my-key","my-value",store.WithCost(2))iferr!=nil {panic(err)}value:=cacheManager.Get(ctx,"my-key")cacheManager.Delete(ctx,"my-key")
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"))iferr!=nil {panic(err)}value,err:=cacheManager.Get(ctx,"my-key")iferr!=nil {panic(err)}fmt.Printf("%s",value)
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))iferr!=nil {panic(err)}value,err:=cacheManager.Get(ctx,"my-key")switcherr {casenil:fmt.Printf("Get the key '%s' from the redis cache. Result: %s","my-key",value)caseredis.Nil:fmt.Printf("Failed to find the key '%s' from the redis cache.","my-key")default:fmt.Printf("Failed to get the value from the redis cache with key '%s': %v","my-key",err)}
Redis Client-Side Caching (using rueidis)
client,err:=rueidis.NewClient(rueidis.ClientOption{InitAddress: []string{"127.0.0.1:6379"}})iferr!=nil {panic(err)}cacheManager:= cache.New[string](rueidis_store.NewRueidis(client,store.WithExpiration(15*time.Second),store.WithClientSideCaching(15*time.Second)),)iferr=cacheManager.Set(ctx,"my-key","my-value");err!=nil {panic(err)}value,err:=cacheManager.Get(ctx,"my-key")iferr!=nil {log.Fatalf("Failed to get the value from the redis cache with key '%s': %v","my-key",err)}log.Printf("Get the key '%s' from the redis cache. Result: %s","my-key",value)
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)iferr!=nil {panic(err)}value:=cacheManager.Get(ctx,"my-key")
pegasusStore,err:=pegasus_store.NewPegasus(&store.OptionsPegasus{MetaServers: []string{"127.0.0.1:34601","127.0.0.1:34602","127.0.0.1:34603"},})iferr!=nil {fmt.Println(err)return}cacheManager:= cache.New[string](pegasusStore)err=cacheManager.Set(ctx,"my-key","my-value",store.WithExpiration(10*time.Second))iferr!=nil {panic(err)}value,_:=cacheManager.Get(ctx,"my-key")
hzClient,err:=hazelcast.StartNewClient(ctx)iferr!=nil {log.Fatalf("Failed to start client: %v",err)}hzMap,err:=hzClient.GetMap(ctx,"gocache")iferr!=nil {b.Fatalf("Failed to get map: %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))iferr!=nil {panic(err)}value,err:=cacheManager.Get(ctx,"my-key")iferr!=nil {panic(err)}fmt.Printf("Get the key '%s' from the hazelcast cache. Result: %s","my-key",value)
Here, we will chain caches in the following order: first in memory with Ristretto store, then in Redis (as a fallback):
// Initialize Ristretto cache and Redis clientristrettoCache,err:=ristretto.NewCache(&ristretto.Config{NumCounters:1000,MaxCost:100,BufferItems:64})iferr!=nil {panic(err)}redisClient:=redis.NewClient(&redis.Options{Addr:"127.0.0.1:6379"})// Initialize storesristrettoStore:=ristretto_store.NewRistretto(ristrettoCache)redisStore:=redis_store.NewRedis(redisClient,store.WithExpiration(5*time.Second))// Initialize chained cachecacheManager:=cache.NewChain[any]( cache.New[any](ristrettoStore), cache.New[any](redisStore),)// ... Then, do what you want with your cache
Chain cache also put data back in previous caches when it's found so in this case, if ristretto doesn't have the data in its cache but redis have, data will also get setted back into ristretto (memory) cache.
This cache will provide a load function that acts as a callable function and will set your data back in your cache in case they are not available:
typeBookstruct {IDstringNamestring}// Initialize Redis client and storeredisClient:=redis.NewClient(&redis.Options{Addr:"127.0.0.1:6379"})redisStore:=redis_store.NewRedis(redisClient)// Initialize a load function that loads your data from a custom sourceloadFunction:=func(ctx context.Context,keyany) (*Book,error) {// ... retrieve value from available sourcereturn&Book{ID:1,Name:"My test amazing book"},nil}// Initialize loadable cachecacheManager:=cache.NewLoadable[*Book](loadFunction,cache.New[*Book](redisStore),)// ... Then, you can get your data and your function will automatically put them in cache(s)
Of course, you can also pass aChain cache into theLoadable one so if your data is not available in all caches, it will bring it back in all caches.
This cache will record metrics depending on the metric provider you pass to it. Here we give a Prometheus provider:
// Initialize Redis client and storeredisClient:=redis.NewClient(&redis.Options{Addr:"127.0.0.1:6379"})redisStore:=redis_store.NewRedis(redisClient)// Initializes Prometheus metrics servicepromMetrics:=metrics.NewPrometheus("my-test-app")// Initialize metric cachecacheManager:=cache.NewMetric[any](promMetrics,cache.New[any](redisStore),)// ... Then, you can get your data and metrics will be observed by Prometheus
Some caches like Redis stores and returns the value as a string so you have to marshal/unmarshal your structs if you want to cache an object. That's why we bring a marshaler service that wraps your cache and make the work for you:
// Initialize Redis client and storeredisClient:=redis.NewClient(&redis.Options{Addr:"127.0.0.1:6379"})redisStore:=redis_store.NewRedis(redisClient)// Initialize chained cachecacheManager:=cache.NewMetric[any](promMetrics,cache.New[any](redisStore),)// Initializes marshalermarshal:=marshaler.New(cacheManager)key:=BookQuery{Slug:"my-test-amazing-book"}value:=Book{ID:1,Name:"My test amazing book",Slug:"my-test-amazing-book"}err=marshal.Set(ctx,key,value)iferr!=nil {panic(err)}returnedValue,err:=marshal.Get(ctx,key,new(Book))iferr!=nil {panic(err)}// Then, do what you want with the valuemarshal.Delete(ctx,"my-key")
The only thing you have to do is to specify the struct in which you want your value to be un-marshalled as a second argument when calling the.Get() method.
You can attach some tags to items you create so you can easily invalidate some of them later.
Tags are stored using the same storage you choose for your cache.
Here is an example on how to use it:
// Initialize Redis client and storeredisClient:=redis.NewClient(&redis.Options{Addr:"127.0.0.1:6379"})redisStore:=redis_store.NewRedis(redisClient)// Initialize chained cachecacheManager:=cache.NewMetric[*Book](promMetrics,cache.New[*Book](redisStore),)// Initializes marshalermarshal:=marshaler.New(cacheManager)key:=BookQuery{Slug:"my-test-amazing-book"}value:=&Book{ID:1,Name:"My test amazing book",Slug:"my-test-amazing-book"}// Set an item in the cache and attach it a "book" tagerr=marshal.Set(ctx,key,value,store.WithTags([]string{"book"}))iferr!=nil {panic(err)}// Remove all items that have the "book" tagerr:=marshal.Invalidate(ctx,store.WithInvalidateTags([]string{"book"}))iferr!=nil {panic(err)}returnedValue,err:=marshal.Get(ctx,key,new(Book))iferr!=nil {// Should be triggered because item has been deleted so it cannot be found.panic(err)}
Mix this with expiration times on your caches to have a fine-tuned control on how your data are cached.
package mainimport ("fmt""log""time""github.com/eko/gocache/lib/v4/cache""github.com/eko/gocache/lib/v4/store""github.com/redis/go-redis/v9")funcmain() {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))iferr!=nil {panic(err)}key:="my-key"value,err:=cacheManager.Get(ctx,key)iferr!=nil {log.Fatalf("unable to get cache key '%s' from the cache: %v",key,err)}fmt.Printf("%#+v\n",value)}
Cache respect the following interface so you can write your own (proprietary?) cache logic if needed by implementing the following interface:
typeCacheInterface[Tany]interface {Get(ctx context.Context,keyany) (T,error)Set(ctx context.Context,keyany,objectT,options...store.Option)errorDelete(ctx context.Context,keyany)errorInvalidate(ctx context.Context,options...store.InvalidateOption)errorClear(ctx context.Context)errorGetType()string}
Or, in case you use a setter cache, also implement theGetCodec() method:
typeSetterCacheInterface[Tany]interface {CacheInterface[T]GetWithTTL(ctx context.Context,keyany) (T, time.Duration,error)GetCodec() codec.CodecInterface}
As all caches available in this library implementCacheInterface, you will be able to mix your own caches with your own.
You also have the ability to write your own custom store by implementing the following interface:
typeStoreInterfaceinterface {Get(ctx context.Context,keyany) (any,error)GetWithTTL(ctx context.Context,keyany) (any, time.Duration,error)Set(ctx context.Context,keyany,valueany,options...Option)errorDelete(ctx context.Context,keyany)errorInvalidate(ctx context.Context,options...InvalidateOption)errorClear(ctx context.Context)errorGetType()string}
Of course, I suggest you to have a look at current caches or stores to implement your own.
You can implement the following interface in order to generate a custom cache key:
typeCacheKeyGeneratorinterface {GetCacheKey()string}
To generate mocks using mockgen library, run:
$ make mocks
Test suite can be run with:
$ maketest# run unit test
Please feel free to contribute on this library and do not hesitate to open an issue if you want to discuss about a feature.
About
☔️ A complete Go cache library that brings you multiple ways of managing your caches