name: cache 模块

sort: 2

缓存模块

beego 的 cache 模块是用来做数据缓存的,设计思路来自于 database/sql,目前支持 file、memcache、memory 和 redis 四种引擎,安装方式如下:

  1. go get github.com/beego/beego/v2/client/cache

如果你使用memcache 或者 redis 驱动就需要手工安装引入包

  1. go get -u github.com/beego/beego/v2/client/cache/memcache

而且需要在使用的地方引入包

  1. import _ "github.com/beego/beego/v2/client/cache/memcache"

使用入门

首先引入包:

  1. import (
  2. "github.com/beego/beego/v2/client/cache"
  3. )

然后初始化一个全局变量对象:

  1. bm, err := cache.NewCache("memory", `{"interval":60}`)

然后我们就可以使用bm增删改缓存:

  1. bm.Put(context.TODO(), "astaxie", 1, 10*time.Second)
  2. bm.Get(context.TODO(), "astaxie")
  3. bm.IsExist(context.TODO(), "astaxie")
  4. bm.Delete(context.TODO(), "astaxie")

第一个参数是 Go 语言的context。我们引入context参数,是为了能够支持可观测性(tracing, metrics)

引擎设置

目前支持四种不同的引擎,接下来分别介绍这四种引擎如何设置:

  • memory

    配置信息如下所示,配置的信息表示 GC 的时间,表示每隔 60s 会进行一次过期清理:

    1. {"interval":60}
  • file

    配置信息如下所示,配置 CachePath 表示缓存的文件目录,FileSuffix 表示文件后缀,DirectoryLevel 表示目录层级,EmbedExpiry 表示过期设置

    1. {"CachePath":"./cache","FileSuffix":".cache","DirectoryLevel":"2","EmbedExpiry":"120"}
  • redis

    配置信息如下所示,redis 采用了库 redigo:

    1. {"key":"collectionName","conn":":6039","dbNum":"0","password":"thePassWord"}
    • key: Redis collection 的名称
    • conn: Redis 连接信息
    • dbNum: 连接 Redis 时的 DB 编号. 默认是0.
    • password: 用于连接有密码的 Redis 服务器.
  • memcache

    配置信息如下所示,memcache 采用了 vitess的库,表示 memcache 的连接地址:

    1. {"conn":"127.0.0.1:11211"}

开发自己的引擎

cache 模块采用了接口的方式实现,因此用户可以很方便的实现接口,然后注册就可以实现自己的 Cache 引擎:

  1. type Cache interface {
  2. // Get a cached value by key.
  3. Get(ctx context.Context, key string) (interface{}, error)
  4. // GetMulti is a batch version of Get.
  5. GetMulti(ctx context.Context, keys []string) ([]interface{}, error)
  6. // Set a cached value with key and expire time.
  7. Put(ctx context.Context, key string, val interface{}, timeout time.Duration) error
  8. // Delete cached value by key.
  9. Delete(ctx context.Context, key string) error
  10. // Increment a cached int value by key, as a counter.
  11. Incr(ctx context.Context, key string) error
  12. // Decrement a cached int value by key, as a counter.
  13. Decr(ctx context.Context, key string) error
  14. // Check if a cached value exists or not.
  15. IsExist(ctx context.Context, key string) (bool, error)
  16. // Clear all cache.
  17. ClearAll(ctx context.Context) error
  18. // Start gc routine based on config string settings.
  19. StartAndGC(config string) error
  20. }

用户开发完毕在最后写类似这样的:

  1. func init() {
  2. cache.Register("myowncache", NewOwnCache())
  3. }