【Golang】本地缓存go-cache-EW帮帮网

github.com/patrickmn/go-cache 是一个用于 Go 语言的轻量级内存键值存储/缓存库，特别适用于单机应用程序。它类似于 Memcached，但完全运行在 Go 应用程序的内存中，无需通过网络传输数据或进行复杂的序列化操作。该库的核心是一个线程安全的 map[string]interface{}，支持为存储的条目设置过期时间，适合在需要快速、临时存储的场景中使用。以下是对该库的详细解析，包括其功能、使用方法、注意事项以及示例代码。

概述

go-cache 是一个简单、高效的内存缓存库，主要特点包括：

线程安全：可以安全地被多个 goroutine 并发访问和修改。
灵活的过期机制：支持为每个条目设置默认过期时间或自定义过期时间，也可以通过 NoExpiration 常量设置永不过期。
易用性：提供直观的 API，开发者可以快速上手。
高性能：由于数据存储在内存中，访问速度非常快。
支持任意类型：使用 interface{} 存储值，允许存储任何类型的对象（需要类型断言来检索）。
序列化支持：可以将缓存保存到文件并从中加载，用于快速恢复数据（但不推荐作为持久化存储）。

它适用于单机环境下的缓存需求，例如缓存 HTTP 响应、数据库查询结果或计算结果等。

主要功能

以下是 go-cache 提供的主要功能及其说明：

1. 创建缓存

通过 cache.New() 创建一个缓存实例，需要指定默认过期时间和清理间隔：

默认过期时间：新添加的条目在多长时间后过期。
清理间隔：缓存内部的 janitor goroutine 多久清理一次过期的条目。

2. 基本操作

Set(key string, value interface{}, duration time.Duration)：设置键值对，可以指定过期时间。
Get(key string) (interface{}, bool)：获取键对应的值，返回值和是否存在标志。
Delete(key string)：删除指定键的条目。

3. 过期机制

默认过期：通过 SetDefault(key, value) 使用创建缓存时指定的默认过期时间。
自定义过期：在 Set() 中指定 duration 参数。
永不过期：使用 cache.NoExpiration 常量。

4. 数值操作

支持对存储的数值进行增减操作，适用于计数器等场景：

Increment(key string, n int64) error：增加指定键的数值。
Decrement(key string, n int64) error：减少指定键的数值。
支持多种类型：如 IncrementInt、DecrementFloat64 等，针对不同数值类型（int、float32、uint64 等）提供专门方法。

5. 清理与刷新

DeleteExpired()：手动清理所有过期的条目（自动清理由 janitor goroutine 完成）。
Flush()：清空缓存中的所有条目。

6. 序列化与恢复

SaveFile(filename string) error：将缓存保存到文件中。
LoadFile(filename string) error：从文件中加载缓存。
Items() map[string]Item：获取当前缓存条目的副本，可用于序列化。

7. 高级功能

Add(key string, value interface{}, duration time.Duration) error：仅在键不存在或已过期时添加条目。
Replace(key string, value interface{}, duration time.Duration) error：仅在键存在时替换条目。
GetWithExpiration(key string) (interface{}, time.Time, bool)：获取值及其过期时间。
OnEvicted(f func(string, interface{}))：设置条目被驱逐时的回调函数。
ItemCount() int：返回缓存中的条目数量。

8. 线程安全

缓存内部使用锁机制，确保在多个 goroutine 并发操作时数据一致性。

使用示例

以下是一个简单的使用示例，展示如何创建缓存、设置和获取值：

package main

import (
	"fmt"
	"time"
	"github.com/patrickmn/go-cache"
)

func main() {
	// 创建缓存，默认过期时间为 5 分钟，清理间隔为 10 分钟
	c := cache.New(5*time.Minute, 10*time.Minute)

	// 设置键 "foo" 的值为 "bar"，使用默认过期时间
	c.Set("foo", "bar", cache.DefaultExpiration)

	// 设置键 "baz" 的值为 42，永不过期
	c.Set("baz", 42, cache.NoExpiration)

	// 获取 "foo" 的值
	if value, found := c.Get("foo"); found {
		fmt.Println("foo 的值:", value) // 输出: foo 的值: bar
	}

	// 类型断言示例
	if value, found := c.Get("foo"); found {
		foo := value.(string)
		fmt.Println("foo 类型断言后:", foo) // 输出: foo 类型断言后: bar
	}

	// 存储指针以提高性能
	type MyStruct struct{ Name string }
	c.Set("struct", &MyStruct{Name: "example"}, cache.DefaultExpiration)
	if value, found := c.Get("struct"); found {
		s := value.(*MyStruct)
		fmt.Println("struct 的值:", s.Name) // 输出: struct 的值: example
	}

	// 数值增减示例
	c.Set("counter", 10, cache.NoExpiration)
	c.Increment("counter", 5)
	if value, found := c.Get("counter"); found {
		fmt.Println("counter 的值:", value) // 输出: counter 的值: 15
	}
}

性能特点

高效性：由于是内存操作，go-cache 的读写性能非常高，适合高频访问场景。
无基准数据：具体性能依赖于使用场景，建议开发者根据实际需求进行基准测试。
内存使用：缓存数据存储在内存中，大量数据可能导致内存占用较高。

注意事项

类型断言：由于值是 interface{} 类型，获取时需要使用类型断言以确保类型安全。
序列化限制：使用 SaveFile 和 LoadFile 时，若存储了自定义类型，需要在使用 gob 编码前注册这些类型。
非持久化存储：go-cache 设计为临时缓存，不适合长期存储数据。
并发性能：虽然线程安全，但在高并发场景下可能因锁竞争影响性能。
过期清理：若清理间隔设为 0，则不会自动清理过期条目，需手动调用 DeleteExpired()。
回调函数：OnEvicted 可用于日志记录或资源清理，但在回调中应避免阻塞操作。

在这里插入图片描述

与其他缓存库的对比

与 github.com/eko/gocache：后者支持更多功能（如标签失效、多后端支持），但更复杂。
与 VCache：后者使用泛型支持更灵活的键类型，而 go-cache 仅支持字符串键。

总结

github.com/patrickmn/go-cache 是一个简单、高效、易用的内存缓存库，适合单机环境中需要快速访问和临时存储的场景。它提供了灵活的过期策略、线程安全支持和丰富的操作方法，同时保持了轻量级的特性。对于需要复杂功能或分布式缓存的场景，可以考虑其他替代库，但对于大多数单机应用，go-cache 是一个可靠的选择。

【Golang】本地缓存go-cache

概述