otter

<p align="center"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/7aea81ba-38f2-4b16-86e8-d490851c15fd.png" width="40%" height="auto" > <h2 align="center">高性能内存缓存</h2> </p> <p align="center"> <a href="https://pkg.go.dev/github.com/maypok86/otter"><img src="https://yellow-cdn.veclightyear.com/835a84d5/046acc6e-6c5a-48a1-9912-6e2cde6aedee.svg" alt="Go Reference"></a> <img src="https://yellow-cdn.veclightyear.com/835a84d5/46d86a8a-45e0-4337-8982-6493f37dfc23.svg" /> <a href="https://codecov.io/gh/maypok86/otter" > <img src="https://yellow-cdn.veclightyear.com/835a84d5/44047286-affd-4f8d-94a8-14a9e1fc0c59.svg?token=G0PJFOR8IF"/> </a> <img src="https://goreportcard.com/badge/github.com/maypok86/otter" /> <a href="https://github.com/avelino/awesome-go"><img src="https://yellow-cdn.veclightyear.com/835a84d5/eab15aa9-25e5-4927-ab05-693879d8a7c5.svg" alt="Mentioned in Awesome Go"></a> </p>

Otter 是基于缓存和并发数据结构研究的 Go 语言最强大的缓存库之一。Otter 还借鉴了其他语言缓存库（如 caffeine）的设计经验。

✨ 特性 <a id="features" />

简单的 API：只需在构建器中设置所需参数即可使用
自动配置：Otter 根据应用程序的并行度自动配置
泛型：可以安全地使用任何可比较类型作为键，任何类型作为值
TTL：过期的值将自动从缓存中删除
基于成本的淘汰：Otter 支持基于每个条目成本的淘汰
删除监听器：可以在构建器中传递回调函数，当条目从缓存中删除时将调用该函数
统计信息：可以收集各种使用统计数据
出色的吞吐量：Otter 可以处理大量请求
高命中率：使用新的 S3-FIFO 算法，显示出优秀的结果

🗃 相关工作 <a id="related-works" />

Otter 基于以下论文：

📚 使用方法 <a id="usage" />

📋 要求 <a id="requirements" />

Go 1.19+

🛠️ 安装 <a id="installation" />

go get -u github.com/maypok86/otter

✏️ 示例 <a id="examples" />

Otter 使用构建器模式，允许您方便地创建具有不同参数的缓存实例。

具有固定 TTL 的缓存

package main

import (
    "fmt"
    "time"

    "github.com/maypok86/otter"
)

func main() {
    // 创建容量为 10000 个元素的缓存
    cache, err := otter.MustBuilder[string, string](10_000).
        CollectStats().
        Cost(func(key string, value string) uint32 {
            return 1
        }).
        WithTTL(time.Hour).
        Build()
    if err != nil {
        panic(err)
    }

    // 设置带有 TTL（1 小时）的项目
    cache.Set("key", "value")

    // 从缓存中获取值
    value, ok := cache.Get("key")
    if !ok {
        panic("未找到键")
    }
    fmt.Println(value)

    // 从缓存中删除项目
    cache.Delete("key")

    // 删除数据并停止 goroutine
    cache.Close()
}

具有可变 TTL 的缓存

package main

import (
    "fmt"
    "time"

    "github.com/maypok86/otter"
)

func main() {
    // 创建容量为 10000 个元素的缓存
    cache, err := otter.MustBuilder[string, string](10_000).
        CollectStats().
        Cost(func(key string, value string) uint32 {
            return 1
        }).
        WithVariableTTL().
        Build()
    if err != nil {
        panic(err)
    }

    // 设置带有 TTL（1 小时）的项目
    cache.Set("key1", "value1", time.Hour)
    // 设置带有 TTL（1 分钟）的项目
    cache.Set("key2", "value2", time.Minute)

    // 从缓存中获取值
    value, ok := cache.Get("key1")
    if !ok {
        panic("未找到键")
    }
    fmt.Println(value)

    // 从缓存中删除项目
    cache.Delete("key1")

    // 删除数据并停止 goroutine
    cache.Close()
}