缓存管理

概述

go-zero 除了提供 sqlx.SqlConn, 我们也提供了一个 sqlc.CachedConn 的封装，用于sql 数据库缓存的支持，我们建议如下代码使用 goctl model -c 进行生成，无需手动录入。 简单实例如下：

  1. cachedConn := sqlc.NewConn(conn, cacheConf)
  2. var v User
  3. err := cachedConn.QueryRowCtx(ctx, &v, "id:1", func(ctx context.Context, conn sqlx.SqlConn, v any) error {
  4.     return conn.QueryRowCtx(ctx, v, "select * from user where id = ?", 1)
  5. })
  1. sqlc 只支持主键，唯一键的单条记录索引方式。其他批量查询的方式不支持。

创建 sqlc.CachedConn

NewConnWithCache

  1. func NewConn(db sqlx.SqlConn, c cache.CacheConf, opts ...cache.Option) CachedConn

我们可以通过NewConnWithCache 方法创建一个 CachedConn，其中 db 就是我们sqlx中的 SqlConn，需要用户自行创建。

cache.CacheConf 为我们内置Cache的配置，他支持多个 redis 组成一个我们业务上面的集群，我们会自动将key 分配到多个 redis 实例上面

cache.Option 支持对 cache 进行额外设置，例如对过期时间和未找到的过期时间进行设置， cache.WithExpiry(time.Hour)

目前支持的 cache.Option 有如下的2个签名：

  1. cache.WithExpiry(time.Hour); // 设置过期时间一个小时，默认 7 * 24h。
  2. cache.WithNotFoundExpiry(time.Second * 5); // 设置notfound 的过期时间，默认是 1 分钟。

NewNodeConn

  1. func NewNodeConn(db sqlx.SqlConn, rds *redis.Redis, opts ...cache.Option) CachedConn

我们可以直接传入一个 redis，初始化我们的 CachedConn。

NewConnWithCache

  1. func NewConnWithCache(db sqlx.SqlConn, c cache.Cache) CachedConn

当然我们也支持用户自定义的缓存，只需要自行实现 cache.Cache 接口即可。

主键查找

  1. func (cc CachedConn) QueryRowCtx(ctx context.Context, v any, key string, query QueryCtxFn)

入参说明：

  • ctx: context
  • v: any 用于接受查询到的数据，需要传入指针
  • key: string redis 中的缓存key，会根据这个key到缓存中查询数据；也会将查询到的数据写入到这个缓存的key 中。
  • query: QueryCtxFn 真实的查询方式，如果缓存中没有，将会执行这个查询方式。

关于 QueryCtxFn 定义

  1. type QueryCtxFn func(ctx context.Context, conn sqlx.SqlConn, v any)

说明： 主键查询将会自动完成redis缓存的读取，如果缓存中不存在则会尝试 QueryCtxFn 查询，接着在将结果自动缓存到redis中。

唯一键所有查询

  1. func (cc CachedConn) QueryRowIndexCtx(ctx context.Context, v any, key string,
  2.     keyer func(primary any) string, indexQuery IndexQueryCtxFn,
  3.     primaryQuery PrimaryQueryCtxFn) error

入参说明：

  • ctx: context
  • v: any 用于接受查询到的数据，需要传入指针
  • key: string redis 中的缓存key，会根据这个key到缓存中查询数据；也会将查询到的数据写入到这个缓存的key 中。
  • keyer: func 需要根据查询到的对象返回对应的主键。
  • indexQuery: IndexQueryCtxFn 索引查询方法
  • primaryQuery: PrimaryQueryCtxFn 更加主键查询的方法

更新缓存

  1. func (cc CachedConn) ExecCtx(ctx context.Context, exec ExecCtxFn, keys ...string)

入参说明：

  • ctx: context
  • exec: ExecCtxFn 真正的 sql 语句。
  • keys: []string 需要删除缓存key

我们在一些 CURD 的过程中需要更新缓存，就需要将对应的key传入，会自动完成redis 清理。示例:

  1. _, err := cachedConn.ExecCtx(ctx, func(ctx context.Context, conn sqlx.SqlConn) (sql.Result, error) {
  2.     return conn.ExecCtx(ctx, "delete from user where id = ?", 1)
  3. }, "id:1")

自行管理缓存

  1. func (cc CachedConn) SetCacheCtx(ctx context.Context, key string, val any) error
  2. func (cc CachedConn) DelCacheCtx(ctx context.Context, keys ...string) error

go-zero 也提供另外2个方法可以直接对 cache 进行操作，方便用户自行管理。

无缓存操作

go-zero 也提供了以 NoCache 结尾的方法，方便用户无需缓存的操作。

  1. func (cc CachedConn) QueryRowNoCache(v any, q string, args ...any) error