Golang實(shí)現(xiàn)多存儲(chǔ)驅(qū)動(dòng)設(shè)計(jì)SDK案例
前言:
Gocache是一個(gè)基于Go語(yǔ)言編寫(xiě)的多存儲(chǔ)驅(qū)動(dòng)
的緩存擴(kuò)展組件。它為您帶來(lái)了許多緩存數(shù)據(jù)的功能。
支持功能
多個(gè)緩存驅(qū)動(dòng)存儲(chǔ):支持內(nèi)存、redis或您自定義存儲(chǔ)驅(qū)動(dòng)。
支持如下功能:
- 鏈?zhǔn)骄彺妫?/strong>使用具有優(yōu)先級(jí)順序的多個(gè)緩存(例如,內(nèi)存然后回退到redis共享緩存)。
- 可加載緩存:允許您調(diào)用回調(diào)函數(shù)將數(shù)據(jù)放回緩存中。
- 指標(biāo)緩存,可讓您存儲(chǔ)有關(guān)緩存使用情況的指標(biāo)(命中、未命中、設(shè)置成功、設(shè)置錯(cuò)誤……)。
- 自動(dòng)編組/解組緩存值作為結(jié)構(gòu)的編組器。
- 在存儲(chǔ)中定義默認(rèn)值并在設(shè)置數(shù)據(jù)時(shí)覆蓋它們。
- 通過(guò)過(guò)期時(shí)間和/或使用標(biāo)簽緩存失效。
- 泛型的使用。
默認(rèn)情況下,Gocache支持如下幾種緩存驅(qū)動(dòng):
- 內(nèi)存 (bigcache) (allegro/bigcache)。
- 內(nèi)存 (ristretto) (dgraph-io/ristretto)。
- 內(nèi)存 (go-cache) (patrickmn/go-cache)。
- 內(nèi)存緩存(bradfitz/memcache)。
- Redis (go-redis/redis)。
- 空閑緩存(coocood/freecache)。
- Pegasus ( apache/incubator-pegasus )基準(zhǔn)測(cè)試。
開(kāi)發(fā)緣由
在作者的官網(wǎng)博客中提到這樣的幾句話(huà):
當(dāng)我開(kāi)始在 GraphQL Go 項(xiàng)目上實(shí)現(xiàn)緩存時(shí),它已經(jīng)有一個(gè)內(nèi)存緩存,它使用了一個(gè)具有簡(jiǎn)單 API 的小庫(kù),但也使用了另一個(gè)內(nèi)存緩存庫(kù)來(lái)使用具有不同庫(kù)和 API 的批處理模式加載數(shù)據(jù),做同樣的事情:緩存項(xiàng)目。后來(lái),我們還有一個(gè)需求:除了這個(gè)內(nèi)存緩存之外,我們還想使用 Redis 添加一層分布式緩存,主要是為了避免我們的新 Kubernetes pod 在將新版本的應(yīng)用程序投入生產(chǎn)時(shí)出現(xiàn)空緩存。
因此,作者想到是時(shí)候擁有一個(gè)統(tǒng)一的API來(lái)管理多個(gè)緩存存儲(chǔ):內(nèi)存、redis、memcache 或任何你想要的。
如何使用
安裝
要開(kāi)始使用最新版本的 go-cache,您可以使用以下命令:
go get github.com/eko/gocache/v3
為避免嘗試導(dǎo)入庫(kù)時(shí)出現(xiàn)任何錯(cuò)誤,請(qǐng)使用以下導(dǎo)入語(yǔ)句:
import ( "github.com/eko/gocache/v3/cache" "github.com/eko/gocache/v3/store" )
如果您遇到任何錯(cuò)誤,請(qǐng)務(wù)必運(yùn)行g(shù)o mod tidy以清理您的 go.mod 文件。
存儲(chǔ)適配器
首先,當(dāng)您要緩存項(xiàng)目時(shí),您必須選擇要緩存項(xiàng)目的位置:在內(nèi)存中?在共享的 redis 或 memcache 中?或者可能在另一個(gè)存儲(chǔ)中。
目前,Gocache 實(shí)現(xiàn)了以下存儲(chǔ):
- BigCache:內(nèi)存中的存儲(chǔ)。
- Ristretto : DGraph 提供的另一個(gè)內(nèi)存存儲(chǔ)。
- Memcache:基于 bradfitz/gomemcache 客戶(hù)端庫(kù)的 memcache 存儲(chǔ)。
- Redis:基于 go-redis/redis 客戶(hù)端庫(kù)的 redis 存儲(chǔ)。
所有這些商店都實(shí)現(xiàn)了一個(gè)非常簡(jiǎn)單的 API,它遵循以下接口:
type StoreInterface interface { Get(key interface{}) (interface{}, error) Set(key interface{}, value interface{}, options *Options) error Delete(key interface{}) error Invalidate(options InvalidateOptions) error Clear() error GetType() string }
此接口代表您可以在商店中執(zhí)行的所有操作,并且每個(gè)操作都調(diào)用客戶(hù)端庫(kù)中的必要方法。所有這些存儲(chǔ)都有不同的配置,具體取決于您要使用的客戶(hù)端庫(kù),
例如,初始化 Memcache 存儲(chǔ):
store := store.NewMemcache( memcache.New("10.0.0.1:11211", "10.0.0.2:11211", "10.0.0.3:11212"), &store.Options{ Expiration: 10*time.Second, }, )
然后,必須將初始化的存儲(chǔ)傳遞給緩存對(duì)象構(gòu)造函數(shù)。
緩存適配器
一個(gè)緩存接口來(lái)統(tǒng)治它們。
緩存接口與存儲(chǔ)接口完全相同,因?yàn)榛旧?,緩存將?duì)存儲(chǔ)執(zhí)行操作:
type CacheInterface interface { Get(key interface{}) (interface{}, error) Set(key, object interface{}, options *store.Options) error Delete(key interface{}) error Invalidate(options store.InvalidateOptions) error Clear() error GetType() string }
使用這個(gè)界面,我可以對(duì)緩存項(xiàng)執(zhí)行所有必要的操作:設(shè)置、獲取、刪除、無(wú)效數(shù)據(jù)、清除所有緩存和另一個(gè)方法 (GetType),它可以讓我知道當(dāng)前緩存項(xiàng)是什么,很有用在某些情況下。
從這個(gè)接口開(kāi)始,實(shí)現(xiàn)的緩存類(lèi)型如下:
Cache:
允許操作來(lái)自給定存儲(chǔ)的數(shù)據(jù)的基本緩存。Chain:
一個(gè)特殊的緩存適配器,允許鏈接多個(gè)緩存(可能是因?yàn)槟阌幸粋€(gè)內(nèi)存緩存,一個(gè)redis緩存等......)。Loadable:
一個(gè)特殊的緩存適配器,允許指定一種回調(diào)函數(shù),如果過(guò)期或失效,自動(dòng)將數(shù)據(jù)重新加載到緩存中。Metric:
一個(gè)特殊的緩存適配器,允許存儲(chǔ)有關(guān)緩存數(shù)據(jù)的指標(biāo):設(shè)置、獲取、失效、成功與否的項(xiàng)目數(shù)。 當(dāng)所有這些緩存都實(shí)現(xiàn)相同的接口并且可以相互包裝時(shí),美妙之處就出現(xiàn)了:一個(gè)指標(biāo)緩存可以采用一個(gè)可加載的緩存,該緩存可以采用一個(gè)可以采用多個(gè)緩存的鏈?zhǔn)骄彺妗?/li>
下面是一個(gè)簡(jiǎn)單的 Memcache 示例:
memcacheStore := store.NewMemcache( memcache.New("10.0.0.1:11211", "10.0.0.2:11211", "10.0.0.3:11212"), &store.Options{ Expiration: 10*time.Second, }, ) cacheManager := cache.New(memcacheStore) err := cacheManager.Set("my-key", []byte("my-value"), &cache.Options{ Expiration: 15*time.Second, // Override default value of 10 seconds defined in the store }) if err != nil { panic(err) } value := cacheManager.Get("my-key") cacheManager.Delete("my-key") cacheManager.Clear() // Clears the entire cache, in case you want to flush all cache
現(xiàn)在,假設(shè)您想要一個(gè)鏈?zhǔn)骄彺妫渲邪粋€(gè)內(nèi)存 Ristretto 存儲(chǔ)和一個(gè)分布式 Redis 存儲(chǔ)作為后備,
并帶有一個(gè) marshaller 和指標(biāo)作為結(jié)果:
// Initialize Ristretto cache and Redis client 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"}) // Initialize stores ristrettoStore := store.NewRistretto(ristrettoCache, nil) redisStore := store.NewRedis(redisClient, &cache.Options{Expiration: 5*time.Second}) // Initialize Prometheus metrics promMetrics := metrics.NewPrometheus("my-amazing-app") // Initialize chained cache cacheManager := cache.NewMetric(promMetrics, cache.NewChain( cache.New(ristrettoStore), cache.New(redisStore), )) // Initializes a marshaler marshal := 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 the value in cache using given key err = marshal.Set(key, value) if err != nil { panic(err) } returnedValue, err := marshal.Get(key, new(Book)) if err != nil { panic(err) } // Then, do what you want with the value
我們還沒(méi)有談到 Marshaler,但它是 Gocache 的另一個(gè)功能:我們提供了一項(xiàng)服務(wù)來(lái)幫助您自動(dòng)編組/解組您的對(duì)象從/到您的存儲(chǔ)。
這在使用 struct 對(duì)象作為鍵而不是內(nèi)存存儲(chǔ)時(shí)很有用,因?yàn)槟仨殞?duì)象轉(zhuǎn)換為字節(jié)。
所有這些功能:帶有內(nèi)存和 redis 的鏈?zhǔn)骄彺?、Prometheus 指標(biāo)和封送處理程序只需大約 20 行代碼即可完成。
編寫(xiě)自己的緩存或存儲(chǔ)
如果您想實(shí)現(xiàn)自己的專(zhuān)有緩存,也很容易做到。
這是一個(gè)簡(jiǎn)單的示例,以防您想要記錄在緩存中完成的每個(gè)操作(這不是一個(gè)好主意,但很好,這是一個(gè)簡(jiǎn)單的 todo 示例):
package customcache import ( "log" "github.com/eko/gocache/cache" "github.com/eko/gocache/store" ) const LoggableType = "loggable" type LoggableCache struct { cache cache.CacheInterface } func NewLoggable(cache cache.CacheInterface) *LoggableCache { return &LoggableCache{ cache: cache, } } func (c *LoggableCache) Get(key interface{}) (interface{}, error) { log.Print("Get some data...") return c.cache.Get(key) } func (c *LoggableCache) Set(key, object interface{}, options *store.Options) error { log.Print("Set some data...") return c.cache.Set(key, object, options) } func (c *LoggableCache) Delete(key interface{}) error { log.Print("Delete some data...") return c.cache.Delete(key) } func (c *LoggableCache) Invalidate(options store.InvalidateOptions) error { log.Print("Invalidate some data...") return c.cache.Invalidate(options) } func (c *LoggableCache) Clear() error { log.Print("Clear some data...") return c.cache.Clear() } func (c *LoggableCache) GetType() string { return LoggableType }
同樣,您也可以實(shí)現(xiàn)自定義存儲(chǔ)。如果您認(rèn)為其他人可以使您的緩存或存儲(chǔ)實(shí)現(xiàn)受益,請(qǐng)不要猶豫,打開(kāi)拉取請(qǐng)求并直接為項(xiàng)目做出貢獻(xiàn),以便我們一起討論您的想法并帶來(lái)更強(qiáng)大的緩存庫(kù)。
壓縮
生成模擬測(cè)試數(shù)據(jù):
go get github.com/golang/mock/mockgen make mocks
測(cè)試套件可以運(yùn)行:
make test # run unit test make benchmark-store # run benchmark test
到此這篇關(guān)于Golang實(shí)現(xiàn)多存儲(chǔ)驅(qū)動(dòng)設(shè)計(jì)SDK案例的文章就介紹到這了,更多相關(guān)Golang SDK內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
一文帶你掌握Go語(yǔ)言并發(fā)模式中的Context的上下文管理
在?Go?的日常開(kāi)發(fā)中,Context?上下文對(duì)象無(wú)處不在,無(wú)論是處理網(wǎng)絡(luò)請(qǐng)求、數(shù)據(jù)庫(kù)操作還是調(diào)用?RPC?等場(chǎng)景,那你真的熟悉它的正確用法嗎,隨著本文一探究竟吧2023-05-05手把手帶你走進(jìn)Go語(yǔ)言之運(yùn)算符解析
這篇文章主要介紹了手Go語(yǔ)言之運(yùn)算符解析,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-09-09Go并發(fā)控制WaitGroup的使用場(chǎng)景分析
WaitGroup,可理解為Wait-Goroutine-Group,即等待一組goroutine結(jié)束,本文通過(guò)具體場(chǎng)景結(jié)合實(shí)際例子給大家介紹使用WaitGroup控制的實(shí)現(xiàn)方法,感興趣的朋友跟隨小編一起看看吧2021-07-07Go并發(fā)編程之sync.Once使用實(shí)例詳解
sync.Once使用起來(lái)很簡(jiǎn)單, 下面是一個(gè)簡(jiǎn)單的使用案例,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友參考下吧2021-11-11如何在golang中使用shopspring/decimal來(lái)處理精度問(wèn)題
本文主要介紹了如何在golang中使用shopspring/decimal來(lái)處理精度問(wèn)題,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-04-04golang版本升級(jí)的簡(jiǎn)單實(shí)現(xiàn)步驟
個(gè)人感覺(jué)Go在眾多高級(jí)語(yǔ)言中,是在各方面都比較高效的,下面這篇文章主要給大家介紹了關(guān)于golang版本升級(jí)的簡(jiǎn)單實(shí)現(xiàn)步驟,文中通過(guò)實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下2023-02-02