cache

README

cache

Redis 相关能力分两层：

组件	用途
cache.C	带本地 LFU 的对象缓存（Get/Set/Exists），如 token 校验
cache.RedisContext	裸 Redis 命令（KV、pub/sub），通过 app.GetRedis() 获取

RedisContext

EnableCache 启动后会注册 RedisSession；业务使用：

r := app.GetRedis()
val, err := r.Get(ctx, "key")
if cache.IsNotFound(err) {
    // key 不存在（内部已映射 redis.Nil）
}
_ = r.Set(ctx, "key", "value", time.Minute)
_ = r.Publish(ctx, "app:logs", line)

或使用对称 helper：

app.Redis(func(r cache.RedisContext) error {
    return r.Set(ctx, "k", "v", time.Minute)
})

错误处理

业务不要 import "github.com/redis/go-redis/v9" 判断 redis.Nil：

if cache.IsNotFound(err) {
    // missing key
}

cache.C 的 Get/Del 同样会归一化 redis.Nil。

Documentation

Index

• func IsNotFound(err error) bool
• func NormalizeErr(err error) error
• func SetRedisSessionResolver(fn func() RedisSession)
• type C
  • func New(ctx context.Context, redisOpts RedisOptions, cacheOpts Options) (c C)
• type Options
• type RedisContext
  • func NewRedis() *RedisContext
  • func WrapRedisSession(s RedisSession) *RedisContext
  • func (r *RedisContext) Del(ctx context.Context, keys ...string) error
  • func (r *RedisContext) Exists(ctx context.Context, key string) (bool, error)
  • func (r *RedisContext) Get(ctx context.Context, key string) (string, error)
  • func (r *RedisContext) Publish(ctx context.Context, channel string, message any) error
  • func (r *RedisContext) Set(ctx context.Context, key string, value any, ttl time.Duration) error
• type RedisOptions
• type RedisSession
  • func NewRedisSession(c *redis.Client) RedisSession

Functions

func IsNotFound

func IsNotFound(err error) bool

IsNotFound reports whether err is a missing-key error from cache/redis session.

func NormalizeErr

func NormalizeErr(err error) error

NormalizeErr maps redis driver errors to cache-level errors.

func SetRedisSessionResolver

func SetRedisSessionResolver(fn func() RedisSession)

SetRedisSessionResolver installs the global session resolver (used by factory).

Types

type C

type C interface {
	Get(key string, value interface{}) (err error)
	GetSkipLocal(key string, value interface{}) (err error)
	GetProxy() *cache.Cache
	Exists(key string) bool
	Set(key string, value interface{}) (err error)
	SetTTL(key string, value interface{}, ttl time.Duration) (err error)
	Del(key string) error
}

func New

func New(ctx context.Context, redisOpts RedisOptions, cacheOpts Options) (c C)

New *

c := New(ctx, RedisOptions{
		Addr: addr,
		Password: "redisUAT",
	}, Options{
		MaxSize: 10,
		Ttl:     time.Second*20,
	})

type Options

type Options struct {
	MaxSize int
	Ttl     time.Duration
}

type RedisContext

type RedisContext struct {
	// contains filtered or unexported fields
}

RedisContext is the facade for RedisSession, similar to persistence.OrmContext.

func NewRedis

func NewRedis() *RedisContext

func WrapRedisSession

func WrapRedisSession(s RedisSession) *RedisContext

func (*RedisContext) Del

func (r *RedisContext) Del(ctx context.Context, keys ...string) error

func (*RedisContext) Exists

func (r *RedisContext) Exists(ctx context.Context, key string) (bool, error)

func (*RedisContext) Get

func (r *RedisContext) Get(ctx context.Context, key string) (string, error)

func (*RedisContext) Publish

func (r *RedisContext) Publish(ctx context.Context, channel string, message any) error

func (*RedisContext) Set

func (r *RedisContext) Set(ctx context.Context, key string, value any, ttl time.Duration) error

type RedisOptions

type RedisOptions redis.Options

type RedisSession

type RedisSession interface {
	Get(ctx context.Context, key string) (string, error)
	Set(ctx context.Context, key string, value any, ttl time.Duration) error
	Del(ctx context.Context, keys ...string) error
	Exists(ctx context.Context, key string) (bool, error)
	Publish(ctx context.Context, channel string, message any) error
}

RedisSession is the low-level Redis command surface (KV, pub/sub).

func NewRedisSession

func NewRedisSession(c *redis.Client) RedisSession

NewRedisSession wraps a go-redis client; client stays inside cache package.