mirror of
https://github.com/gookit/cache.git
synced 2026-04-22 23:47:12 +08:00
inhere
132 lines
3.6 KiB
Markdown
132 lines
3.6 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)
|
|
|
|
> **[中文说明](README_cn.md)**
|
|
|
|
Generic cache use and cache manager for golang. Provide a unified usage API by packaging various commonly used drivers.
|
|
|
|
> All cache driver implemented the `cache.Cache` interface. So, You can add any custom driver.
|
|
|
|
**Supported Drivers:**
|
|
|
|
- `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 internal driver [driver_file.go](driver_file.go)
|
|
- memory internal driver [driver_memory.go](driver_memory.go)
|
|
|
|
> Notice: The built-in implementation is relatively simple and is not recommended for production environments;
|
|
> the production environment recommends using the third-party drivers listed above.
|
|
|
|
## 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)
|
|
|
|
## Install
|
|
|
|
The package supports 3 last Go versions and requires a Go version with modules support.
|
|
|
|
```bash
|
|
go get github.com/gookit/cache
|
|
```
|
|
|
|
## Cache Interface
|
|
|
|
All cache driver implemented the `cache.Cache` interface. So, You can add any custom driver.
|
|
|
|
```go
|
|
type Cache interface {
|
|
// basic operation
|
|
Has(key string) bool
|
|
Get(key string) interface{}
|
|
Set(key string, val interface{}, ttl time.Duration) (err error)
|
|
Del(key string) error
|
|
// multi operation
|
|
GetMulti(keys []string) map[string]interface{}
|
|
SetMulti(values map[string]interface{}, ttl time.Duration) (err error)
|
|
DelMulti(keys []string) error
|
|
// clear and close
|
|
Clear() error
|
|
Close() error
|
|
}
|
|
```
|
|
|
|
## Usage
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/gookit/cache"
|
|
"github.com/gookit/cache/goredis"
|
|
"github.com/gookit/cache/redis"
|
|
)
|
|
|
|
func main() {
|
|
// register one(or some) cache driver
|
|
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))
|
|
|
|
// setting default driver name
|
|
cache.DefaultUse(redis.Name)
|
|
|
|
// quick use.(it is default driver)
|
|
//
|
|
// set
|
|
cache.Set("name", "cache value", cache.TwoMinutes)
|
|
// get
|
|
val := cache.Get("name")
|
|
// del
|
|
cache.Del("name")
|
|
|
|
// get: "cache value"
|
|
fmt.Print(val)
|
|
|
|
// More ...
|
|
// fc := cache.Driver(DvrFile)
|
|
// fc.Set("key", "value", 10)
|
|
// fc.Get("key")
|
|
}
|
|
```
|
|
|
|
## With Options
|
|
|
|
```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**
|