feat: Support cache key separator. (mgtv-tech#39)

tollcc · Nov 11, 2024 · 6806dcf · 6806dcf
1 parent be0bef1
commit 6806dcf
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -242,7 +242,7 @@ type Options struct {
     remote                     remote.Remote      // Remote is distributed cache, such as Redis.
     local                      local.Local        // Local is memory cache, such as FreeCache.
     codec                      string             // Value encoding and decoding method. Default is "msgpack.Name". You can also customize it.
-    separatorDisable           bool               // Disable separator for cache key. Default is false. If true, the cache key will not be split into multiple parts.
+    separatorDisabled          bool               // Disable separator for cache key. Default is false. If true, the cache key will not be split into multiple parts.
     separator                  string             // Separator for cache key. Default is ":".
     errNotFound                error              // Error to return for cache miss. Used to prevent cache penetration.
     remoteExpiry               time.Duration      // Remote cache ttl, Default is 1 hour.

diff --git a/README_zh.md b/README_zh.md
@@ -240,7 +240,7 @@ name                       string             // 缓存名称，用于日志标
 remote                     remote.Remote      // remote 是分布式缓存，例如 Redis。
 local                      local.Local        // local 是内存缓存，例如 FreeCache。
 codec                      string             // value的编码和解码方法。默认为 "msgpack.Name"。也可以自定义。
-separatorDisable           bool               // Disable separator for cache key. Default is false. If true, the cache key will not be split into multiple parts.
+separatorDisabled          bool               // Disable separator for cache key. Default is false. If true, the cache key will not be split into multiple parts.
 separator                  string             // Separator for cache key. Default is ":".
 errNotFound                error              // 缓存未命中时返回的错误。用于防止缓存穿透（即缓存空对象）。
 remoteExpiry               time.Duration      // 远程缓存 TTL，默认为 1 小时。

diff --git a/cacheopt.go b/cacheopt.go
@@ -38,7 +38,7 @@ type (
 		remote                     remote.Remote      // Remote is distributed cache, such as Redis.
 		local                      local.Local        // Local is memory cache, such as FreeCache.
 		codec                      string             // Value encoding and decoding method. Default is "msgpack.Name". You can also customize it.
-		disableSeparator           bool               // Disable separator for cache key. Default is false. If true, the cache key will not be split into multiple parts.
+		separatorDisabled          bool               // Disable separator for cache key. Default is false. If true, the cache key will not be split into multiple parts.
 		separator                  string             // Separator for cache key. Default is ":".
 		errNotFound                error              // Error to return for cache miss. Used to prevent cache penetration.
 		remoteExpiry               time.Duration      // Remote cache ttl, Default is 1 hour.
@@ -109,7 +109,7 @@ func newOptions(opts ...Option) Options {
 	if o.eventChBufSize <= 0 {
 		o.eventChBufSize = defaultEventChBufSize
 	}
-	if o.separator == "" && !o.disableSeparator {
+	if o.separator == "" && !o.separatorDisabled {
 		o.separator = defaultSeparator
 	}
 	return o
@@ -219,13 +219,13 @@ func WithEventHandler(eventHandler func(event *Event)) Option {
 
 func WithSeparatorDisable(separatorDisable bool) Option {
 	return func(o *Options) {
-		o.disableSeparator = separatorDisable
+		o.separatorDisabled = separatorDisable
 	}
 }
 
 func WithSeparator(separator string) Option {
 	return func(o *Options) {
-		if !o.disableSeparator {
+		if !o.separatorDisabled {
 			o.separator = separator
 		}
 	}

diff --git a/cacheopt_test.go b/cacheopt_test.go
@@ -25,7 +25,7 @@ func TestCacheOptions(t *testing.T) {
 		assert.Equal(t, defaultEventChBufSize, o.eventChBufSize)
 		assert.Nil(t, o.eventHandler)
 		assert.Equal(t, defaultSeparator, o.separator)
-		assert.Equal(t, false, o.disableSeparator)
+		assert.Equal(t, false, o.separatorDisabled)
 	})
 
 	t.Run("with name", func(t *testing.T) {