go-cache 技术文档

2024-12-29 09:06:24作者：魏献源Searcher

1. 安装指南

首先，确保您的环境中已经安装了 Go 语言环境。接下来，您可以使用以下命令来安装 go-cache 包：

go get github.com/patrickmn/go-cache

这将自动下载并安装 go-cache 包及其依赖项。

2. 项目的使用说明

go-cache 是一个内存中的键值存储/缓存，类似于 memcached，适用于在单台机器上运行的应用程序。它的主要优点是，作为一个线程安全的 map[string]interface{}，具有过期时间，因此不需要通过网络序列化或传输其内容。

任何对象都可以存储一段指定的时间，或者永久存储，并且缓存可以安全地被多个 goroutines 使用。

尽管 go-cache 不适合用作持久化数据存储，但整个缓存可以保存到文件中，并在停机后快速恢复（使用 c.Items() 来检索物品映射以序列化，以及 NewFrom() 来从一个反序列化的物品创建缓存）。

示例代码

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

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

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

	// 设置键 "baz" 的值为 42，没有过期时间
	// (该项直到被重新设置或使用 c.Delete("baz") 删除前不会移除)
	c.Set("baz", 42, cache.NoExpiration)

	// 从缓存中获取键 "foo" 对应的字符串值
	foo, found := c.Get("foo")
	if found {
		fmt.Println(foo)
	}

	// 由于 Go 是静态类型语言，缓存值可以是任何东西，因此在将值传递给不接收任意类型（例如 interface{}）的函数时需要类型断言。
	foo, found := c.Get("foo")
	if found {
		MyFunction(foo.(string))
	}

	// 如果在同一个函数中多次使用值，这会变得繁琐。您可以这样做：
	if x, found := c.Get("foo"); found {
		foo := x.(string)
		// ...
	}
	// 或者
	var foo string
	if x, found := c.Get("foo"); found {
		foo = x.(string)
	}
	// ...
	// 接下来，foo 可以自由地作为字符串传递

	// 如果您想要更高的性能，请存储指针！
	c.Set("foo", &MyStruct, cache.DefaultExpiration)
	if x, found := c.Get("foo"); found {
		foo := x.(*MyStruct)
		// ...
	}
}

3. 项目 API 使用文档

以下是 go-cache 提供的一些主要 API 函数：

New(defaultExpiration, cleanupInterval time.Duration) *Cache：返回一个新的缓存，具有给定的默认过期时间和清理间隔。
NewFrom(defaultExpiration, cleanupInterval time.Duration, items map[string]Item) *Cache：返回一个新的缓存，具有给定的默认过期时间和清理间隔，并从序列化的物品中创建。
(c Cache) Add(k string, x interface{}, d time.Duration) error：向缓存中添加一个项，具有给定的过期时间。
(c Cache) Set(k string, x interface{}, d time.Duration)：设置缓存中一个项的值和过期时间。
(c Cache) Get(k string) (interface{}, bool)：从缓存中获取一个项。

更多 API 文档，请查看 godoc 或项目源代码。