mirror of
https://github.com/gookit/cache.git
synced 2026-04-22 23:47:12 +08:00
inhere
132 lines
3.5 KiB
Markdown
132 lines
3.5 KiB
Markdown
# Cache
|
|
|
|
|
|
[](https://pkg.go.dev/github.com/gookit/cache)
|
|
[](https://goreportcard.com/report/github.com/gookit/cache)
|
|
[](https://github.com/gookit/cache/actions)
|
|
|
|
> **[EN README](README.md)**
|
|
|
|
Golang 通用的缓存管理使用库。
|
|
通过包装各种常用的驱动，屏蔽掉底层各个驱动的不同使用方法，来提供统一的使用API。
|
|
|
|
> 所有缓存驱动程序都实现了 `cache.Cache` 接口。 因此，您可以添加任何自定义驱动程序。
|
|
|
|
**支持的驱动:**
|
|
|
|
- `goredis` https://github.com/go-redis/redis
|
|
- `redis` https://github.com/gomodule/redigo
|
|
- `memcached` https://github.com/bradfitz/gomemcache
|
|
- `buntdb` https://github.com/tidwall/buntdb
|
|
- `boltdb` https://github.com/etcd-io/bbolt
|
|
- `badger` https://github.com/dgraph-io/badger
|
|
- `nutsdb` https://github.com/xujiajun/nutsdb
|
|
- `goleveldb` https://github.com/syndtr/goleveldb
|
|
- `gcache` https://github.com/bluele/gcache
|
|
- `gocache` https://github.com/patrickmn/go-cache
|
|
- `bigcache` https://github.com/allegro/bigcache
|
|
|
|
Internal:
|
|
|
|
- file 简单的文件缓存(_当前包的内置实现_)
|
|
- memory 简单的内存缓存(_当前包的内置实现_)
|
|
|
|
> 注意：内置实现比较简单，不推荐生产环境使用；生产环境推荐使用上面列出的三方驱动。
|
|
|
|
## GoDoc
|
|
|
|
- [doc on gowalker](https://gowalker.org/github.com/gookit/cache)
|
|
- [godoc for gopkg](https://pkg.go.dev/gopkg.in/gookit/cache.v1)
|
|
- [godoc for github](https://pkg.go.dev/github.com/gookit/cache)
|
|
|
|
## 安装
|
|
|
|
```bash
|
|
go get github.com/gookit/cache
|
|
```
|
|
|
|
## 接口方法
|
|
|
|
所有缓存驱动程序都实现了cache.Cache接口。 因此，您可以添加任何自定义驱动程序。
|
|
|
|
```go
|
|
// Cache interface definition
|
|
type Cache interface {
|
|
// basic op
|
|
Has(key string) bool
|
|
Get(key string) interface{}
|
|
Set(key string, val interface{}, ttl time.Duration) (err error)
|
|
Del(key string) error
|
|
// multi op
|
|
GetMulti(keys []string) map[string]interface{}
|
|
SetMulti(values map[string]interface{}, ttl time.Duration) (err error)
|
|
DelMulti(keys []string) error
|
|
// clear
|
|
Clear() error
|
|
}
|
|
```
|
|
|
|
## 使用
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/gookit/cache"
|
|
"github.com/gookit/cache/goredis"
|
|
"github.com/gookit/cache/redis"
|
|
)
|
|
|
|
func main() {
|
|
// 注册一个（或多个）缓存驱动
|
|
cache.Register(cache.DvrFile, cache.NewFileCache(""))
|
|
cache.Register(cache.DvrMemory, cache.NewMemoryCache())
|
|
cache.Register(redis.Name, redis.Connect("127.0.0.1:6379", "", 0))
|
|
cache.Register(goredis.Name, goredis.Connect("127.0.0.1:6379", "", 0))
|
|
|
|
// 设置默认驱动名称
|
|
cache.DefaultUse(cache.DvrRedis)
|
|
|
|
// 快速使用（默认驱动）
|
|
//
|
|
// set
|
|
cache.Set("name", "cache value", cache.TwoMinutes)
|
|
// get
|
|
val := cache.Get("name")
|
|
// del
|
|
cache.Del("name")
|
|
|
|
// Out: "cache value"
|
|
fmt.Print(val)
|
|
|
|
// 使用已注册的其他驱动
|
|
client := cache.Driver(cache.DvrFile)
|
|
client.Set("key", "val", 0)
|
|
val = client.Get("key")
|
|
// Out: "val"
|
|
fmt.Print(val)
|
|
}
|
|
```
|
|
|
|
## 设置选项
|
|
|
|
```go
|
|
gords := goredis.Connect("127.0.0.1:6379", "", 0)
|
|
gords.WithOptions(cache.WithPrefix("cache_"), cache.WithEncode(true))
|
|
|
|
cache.Register(goredis.Name, gords)
|
|
|
|
// set
|
|
// real key is: "cache_name"
|
|
cache.Set("name", "cache value", cache.TwoMinutes)
|
|
|
|
// get: "cache value"
|
|
val := cache.Get("name")
|
|
```
|
|
|
|
## License
|
|
|
|
**[MIT](LICENSE)**
|