增加缓存名称配置

HISTORY.md

@@ -1,5 +1,11 @@
 ## ✒ 历史版本的特性介绍 (Features in old versions)
 
+### v0.4.8
+
+> 此版本发布于 2023-03-13
+
+* 增加缓存名字配置，主要用于区分每个监控数据的来源
+
 ### v0.4.7
 
 > 此版本发布于 2023-03-08

README.en.md

@@ -93,6 +93,10 @@ func main() {
 	// Also, try WithLFU if you want to use lfu to evict data.
 	cache = cachego.NewCache(cachego.WithLRU(100))
 	cache = cachego.NewCache(cachego.WithLFU(100))
+
+	// Use NewCacheWithReport to create a cache with report.
+	cache, reporter := cachego.NewCacheWithReport(cachego.WithCacheName("test"))
+	fmt.Println(reporter.CacheName())
 }
 ```
 

README.md

@@ -92,6 +92,10 @@ func main() {
 	// Also, try WithLFU if you want to use lfu to evict data.
 	cache = cachego.NewCache(cachego.WithLRU(100))
 	cache = cachego.NewCache(cachego.WithLFU(100))
+
+	// Use NewCacheWithReport to create a cache with report.
+	cache, reporter := cachego.NewCacheWithReport(cachego.WithCacheName("test"))
+	fmt.Println(reporter.CacheName())
 }
 ```
 

_examples/basic.go

@@ -69,4 +69,8 @@ func main() {
 	// Also, try WithLFU if you want to use lfu to evict data.
 	cache = cachego.NewCache(cachego.WithLRU(100))
 	cache = cachego.NewCache(cachego.WithLFU(100))
+
+	// Use NewCacheWithReport to create a cache with report.
+	cache, reporter := cachego.NewCacheWithReport(cachego.WithCacheName("test"))
+	fmt.Println(reporter.CacheName())
 }

_examples/report.go

@@ -84,4 +84,9 @@ func main() {
 	fmt.Println("CacheSize:", reporter.CacheSize())
 	fmt.Println("MissedRate:", reporter.MissedRate())
 	fmt.Println("HitRate:", reporter.HitRate())
+
+	// Sometimes you may have several caches in one service.
+	// You can set each name by WithCacheName and get the name from reporter.
+	cachego.WithCacheName("test")
+	reporter.CacheName()
 }

config.go

@@ -17,6 +17,7 @@ package cachego
 import "time"
 
 type config struct {
+	cacheName    string
 	cacheType    cacheType
 	shardings    int
 	singleflight bool
@@ -41,6 +42,7 @@ type config struct {
 
 func newDefaultConfig() *config {
 	return &config{
+		cacheName:    "",
 		cacheType:    standard,
 		shardings:    0,
 		singleflight: true,

doc.go

@@ -65,6 +65,10 @@ Package cachego provides an easy way to use foundation for your caching operatio
 	cache = cachego.NewCache(cachego.WithLRU(100))
 	cache = cachego.NewCache(cachego.WithLFU(100))
 
+	// Use NewCacheWithReport to create a cache with report.
+	cache, reporter := cachego.NewCacheWithReport(cachego.WithCacheName("test"))
+	fmt.Println(reporter.CacheName())
+
 2. ttl:
 
 	cache := cachego.NewCache()
@@ -392,6 +396,11 @@ Package cachego provides an easy way to use foundation for your caching operatio
 	fmt.Println("MissedRate:", reporter.MissedRate())
 	fmt.Println("HitRate:", reporter.HitRate())
 
+	// Sometimes you may have several caches in one service.
+	// You can set each name by WithCacheName and get the name from reporter.
+	cachego.WithCacheName("test")
+	reporter.CacheName()
+
 9. task:
 
 	var (
@@ -468,4 +477,4 @@ Package cachego provides an easy way to use foundation for your caching operatio
 package cachego // import "github.com/FishGoddess/cachego"
 
 // Version is the version string representation of cachego.
-const Version = "v0.4.7"
+const Version = "v0.4.8"

option.go

@@ -31,6 +31,13 @@ func applyOptions(conf *config, opts []Option) {
 	}
 }
 
+// WithCacheName returns an option setting the cacheName of config.
+func WithCacheName(cacheName string) Option {
+	return func(conf *config) {
+		conf.cacheName = cacheName
+	}
+}
+
 // WithLRU returns an option setting the type of cache to lru.
 // Notice that lru cache must have max entries limit, so you have to specify a maxEntries.
 func WithLRU(maxEntries int) Option {

option_test.go

@@ -19,6 +19,17 @@ import (
 	"time"
 )
 
+// go test -v -cover -run=^TestWithCacheName$
+func TestWithCacheName(t *testing.T) {
+	got := &config{cacheName: ""}
+	expect := &config{cacheName: "-"}
+
+	WithCacheName("-").applyTo(got)
+	if !isConfigEquals(got, expect) {
+		t.Errorf("got %+v != expect %+v", got, expect)
+	}
+}
+
 // go test -v -cover -run=^TestWithLRU$
 func TestWithLRU(t *testing.T) {
 	got := &config{cacheType: standard, maxEntries: 0}

pkg/clock/clock.go

@@ -87,7 +87,7 @@ func (c *Clock) start() {
 			atomic.AddInt64(&c.now, int64(duration))
 		}
 
-		time.Sleep(100 * time.Millisecond)
+		time.Sleep(duration)
 		atomic.StoreInt64(&c.now, time.Now().UnixNano())
 	}
 }

report.go

@@ -21,6 +21,7 @@ import (
 
 // Reporter stores some values for reporting.
 type Reporter struct {
+	conf  *config
 	cache Cache
 
 	missedCount uint64
@@ -45,6 +46,12 @@ func (r *Reporter) increaseLoadCount() {
 	atomic.AddUint64(&r.loadCount, 1)
 }
 
+// CacheName returns the name of cache.
+// You can use WithCacheName to set cache's name.
+func (r *Reporter) CacheName() string {
+	return r.conf.cacheName
+}
+
 // CountMissed returns the missed count.
 func (r *Reporter) CountMissed() uint64 {
 	return atomic.LoadUint64(&r.missedCount)
@@ -103,6 +110,7 @@ type reportableCache struct {
 
 func report(conf *config, cache Cache) (Cache, *Reporter) {
 	reporter := &Reporter{
+		conf:        conf,
 		cache:       cache,
 		hitCount:    0,
 		missedCount: 0,

report_test.go

@@ -20,8 +20,13 @@ import (
 	"time"
 )
 
+const (
+	testCacheName = "test"
+)
+
 func newTestReportableCache() (*reportableCache, *Reporter) {
 	conf := newDefaultConfig()
+	conf.cacheName = testCacheName
 	conf.maxEntries = maxTestEntries
 	cache, reporter := report(conf, newStandardCache(conf))
 	return cache.(*reportableCache), reporter
@@ -195,6 +200,14 @@ func TestReportableCacheReportLoad(t *testing.T) {
 	}
 }
 
+// go test -v -cover -run=^TestReporterCacheName$
+func TestReporterCacheName(t *testing.T) {
+	_, reporter := newTestReportableCache()
+	if reporter.CacheName() != testCacheName {
+		t.Errorf("CacheName %s is wrong", reporter.CacheName())
+	}
+}
+
 // go test -v -cover -run=^TestReporterCacheSize$
 func TestReporterCacheSize(t *testing.T) {
 	cache, reporter := newTestReportableCache()