cache

type Backend interface {
	Name() string
	// Len 当前缓存中key的个数,若key已经过期但并没有及时清理，也会计算在内
	Len() int
	// Exists is used to check if the cache contains a key without updating recency or frequency.
	Exists(ctx context.Context, key string) bool
	Get(ctx context.Context, key string) (interface{}, error)
	// Put ttl为0则不过期
	Put(ctx context.Context, key string, value interface{}, ttl time.Duration) error
	Delete(ctx context.Context, key string) error
	Clear()
}

type Cache interface {
	// Len 当前缓存中key的个数,若key已经过期但并没有及时清理，也会计算在内
	Len() int
	// Exists is used to check if the cache contains a key without updating recency or frequency.
	Exists(ctx context.Context, key string) bool
	Get(ctx context.Context, key string, opts ...GetOption) (interface{}, error)
	Put(ctx context.Context, key string, value interface{}, ttl time.Duration) error
	Delete(ctx context.Context, key string) error
	// Clear 清空所有cache，仅内存cache支持
	Clear()
}

type Config struct {
	Modifier  KeyModifier            // 修正key,添加前缀或后缀,默认不修改key
	Filter    Filter                 // 预先忽略不存在的key,防止击穿,可使用BloomFilter
	AbsentTTL time.Duration          // 用于标识是否缓存不存在的key,若为0则不缓存无效的key,默认为0,避免击穿
	JitterTTL time.Duration          // 当写入时,如果带有ttl,则会自动增加一个抖动时间,避免雪崩
	MaxSize   int                    // 限制最大条数
	Codec     encoding.Codec         // 编解码,默认使用json
	Creator   CreatorFunc            // 创建entity回调
	OnEvict   EvictCallback          // 驱逐时回调
	Extra     map[string]interface{} // 扩展配置
}

type CreatorFunc func() interface{}

type EvictCallback func(key interface{}, value interface{})

type Factory func(conf *Config) (Backend, error)

type Filter interface {
	// Exists 判断key是否存在,不存在则返回false,直接忽略
	Exists(ctx context.Context, key string) bool
}

type GetOption func(o *GetOptions)

type GetOptions struct {
	Load LoadFunc
}

type KeyModifier func(key string) string

type LoadFunc func(ctx context.Context, key string) ([]byte, error)