祝妈妈、老婆妇女节快乐！

Author: FishGoddess

HISTORY.md

@@ -1,5 +1,14 @@
 ## ✒ 历史版本的特性介绍 (Features in old versions)
 
+### v0.4.7
+
+> 此版本发布于 2023-03-08
+
+* 默认开启 10 分钟的 GC（因为从线上使用情况来看开启的概率远远大于不开启）
+* 默认限制最多缓存 10w 个键值对，如果需要不限制，可以使用 WithMaxEntries 指定为 0
+* 完善文档和使用案例，特别是强调了 GC 和单飞的使用
+* 祝我的妈妈，我的老婆女神节、妇女节都快乐！
+
 ### v0.4.6
 
 > 此版本发布于 2023-03-01

README.en.md

@@ -47,15 +47,10 @@ import (
 
 func main() {
 	// Use NewCache function to create a cache.
-	// You can use WithLRU to specify the type of cache to lru.
-	// Also, try WithLFU if you want to use lfu to evict data.
-	cache := cachego.NewCache(cachego.WithLRU(100))
-	cache = cachego.NewCache(cachego.WithLFU(100))
-
 	// By default, it creates a standard cache which evicts entries randomly.
 	// Use WithShardings to shard cache to several parts for higher performance.
-	cache = cachego.NewCache(cachego.WithShardings(64))
-	cache = cachego.NewCache()
+	// Use WithGC to clean expired entries every 10 minutes.
+	cache := cachego.NewCache(cachego.WithGC(10*time.Minute), cachego.WithShardings(64))
 
 	// Set an entry to cache with ttl.
 	cache.Set("key", 123, time.Second)
@@ -86,12 +81,18 @@ func main() {
 	value, ok = cache.Get("key")
 	if !ok {
 		// Loaded entry will be set to cache and returned.
+		// By default, it will use singleflight.
 		value, _ = cache.Load("key", time.Second, func() (value interface{}, err error) {
 			return 666, nil
 		})
 	}
 
 	fmt.Println(value) // 666
+
+	// You can use WithLRU to specify the type of cache to lru.
+	// Also, try WithLFU if you want to use lfu to evict data.
+	cache = cachego.NewCache(cachego.WithLRU(100))
+	cache = cachego.NewCache(cachego.WithLFU(100))
 }
 ```
 

README.md

@@ -7,7 +7,7 @@
 
 **cachego** 是一个拥有分片机制的轻量级内存缓存库，API 友好，支持多种数据淘汰机制，可以应用于所有的 [GoLang](https://golang.org) 应用程序中。
 
-> 目前 v0.3.x 版本已经在多个线上服务中运行稳定，服务日常请求过万 qps，最高抵御过 96w/s qps 的冲击，欢迎使用！👏🏻
+> 目前 v0.3.x 版本已经在多个线上服务中运行稳定，服务日常请求过万 qps，瞬时最高抵御过 96w/s qps 的冲击，欢迎使用！👏🏻
 
 [Read me in English](./README.en.md).
 
@@ -46,15 +46,10 @@ import (
 
 func main() {
 	// Use NewCache function to create a cache.
-	// You can use WithLRU to specify the type of cache to lru.
-	// Also, try WithLFU if you want to use lfu to evict data.
-	cache := cachego.NewCache(cachego.WithLRU(100))
-	cache = cachego.NewCache(cachego.WithLFU(100))
-
 	// By default, it creates a standard cache which evicts entries randomly.
 	// Use WithShardings to shard cache to several parts for higher performance.
-	cache = cachego.NewCache(cachego.WithShardings(64))
-	cache = cachego.NewCache()
+	// Use WithGC to clean expired entries every 10 minutes.
+	cache := cachego.NewCache(cachego.WithGC(10*time.Minute), cachego.WithShardings(64))
 
 	// Set an entry to cache with ttl.
 	cache.Set("key", 123, time.Second)
@@ -85,12 +80,18 @@ func main() {
 	value, ok = cache.Get("key")
 	if !ok {
 		// Loaded entry will be set to cache and returned.
+		// By default, it will use singleflight.
 		value, _ = cache.Load("key", time.Second, func() (value interface{}, err error) {
 			return 666, nil
 		})
 	}
 
 	fmt.Println(value) // 666
+
+	// You can use WithLRU to specify the type of cache to lru.
+	// Also, try WithLFU if you want to use lfu to evict data.
+	cache = cachego.NewCache(cachego.WithLRU(100))
+	cache = cachego.NewCache(cachego.WithLFU(100))
 }
 ```
 

_examples/basic.go

@@ -23,15 +23,10 @@ import (
 
 func main() {
 	// Use NewCache function to create a cache.
-	// You can use WithLRU to specify the type of cache to lru.
-	// Also, try WithLFU if you want to use lfu to evict data.
-	cache := cachego.NewCache(cachego.WithLRU(100))
-	cache = cachego.NewCache(cachego.WithLFU(100))
-
 	// By default, it creates a standard cache which evicts entries randomly.
 	// Use WithShardings to shard cache to several parts for higher performance.
-	cache = cachego.NewCache(cachego.WithShardings(64))
-	cache = cachego.NewCache()
+	// Use WithGC to clean expired entries every 10 minutes.
+	cache := cachego.NewCache(cachego.WithGC(10*time.Minute), cachego.WithShardings(64))
 
 	// Set an entry to cache with ttl.
 	cache.Set("key", 123, time.Second)
@@ -62,10 +57,16 @@ func main() {
 	value, ok = cache.Get("key")
 	if !ok {
 		// Loaded entry will be set to cache and returned.
+		// By default, it will use singleflight.
 		value, _ = cache.Load("key", time.Second, func() (value interface{}, err error) {
 			return 666, nil
 		})
 	}
 
 	fmt.Println(value) // 666
+
+	// You can use WithLRU to specify the type of cache to lru.
+	// Also, try WithLFU if you want to use lfu to evict data.
+	cache = cachego.NewCache(cachego.WithLRU(100))
+	cache = cachego.NewCache(cachego.WithLFU(100))
 }

config.go

@@ -44,9 +44,9 @@ func newDefaultConfig() *config {
 		cacheType:    standard,
 		shardings:    0,
 		singleflight: true,
-		gcDuration:   0,
+		gcDuration:   10 * time.Minute,
 		maxScans:     10000,
-		maxEntries:   0,
+		maxEntries:   100000,
 		now:          now,
 		hash:         hash,
 		recordMissed: true,

doc.go

@@ -18,15 +18,10 @@ Package cachego provides an easy way to use foundation for your caching operatio
 1. basic:
 
 	// Use NewCache function to create a cache.
-	// You can use WithLRU to specify the type of cache to lru.
-	// Also, try WithLFU if you want to use lfu to evict data.
-	cache := cachego.NewCache(cachego.WithLRU(100))
-	cache = cachego.NewCache(cachego.WithLFU(100))
-
 	// By default, it creates a standard cache which evicts entries randomly.
 	// Use WithShardings to shard cache to several parts for higher performance.
-	cache = cachego.NewCache(cachego.WithShardings(64))
-	cache = cachego.NewCache()
+	// Use WithGC to clean expired entries every 10 minutes.
+	cache := cachego.NewCache(cachego.WithGC(10*time.Minute), cachego.WithShardings(64))
 
 	// Set an entry to cache with ttl.
 	cache.Set("key", 123, time.Second)
@@ -57,13 +52,19 @@ Package cachego provides an easy way to use foundation for your caching operatio
 	value, ok = cache.Get("key")
 	if !ok {
 		// Loaded entry will be set to cache and returned.
+		// By default, it will use singleflight.
 		value, _ = cache.Load("key", time.Second, func() (value interface{}, err error) {
 			return 666, nil
 		})
 	}
 
 	fmt.Println(value) // 666
 
+	// You can use WithLRU to specify the type of cache to lru.
+	// Also, try WithLFU if you want to use lfu to evict data.
+	cache = cachego.NewCache(cachego.WithLRU(100))
+	cache = cachego.NewCache(cachego.WithLFU(100))
+
 2. ttl:
 
 	cache := cachego.NewCache()
@@ -467,4 +468,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.6"
+const Version = "v0.4.7"