cache

README

cache

redis and memory cache libraries.

Example of use

Using Redis Cache

package main

import (
	"github.com/redis/go-redis/v9"
	"github.com/go-dev-frame/sponge/pkg/cache"
	"github.com/go-dev-frame/sponge/pkg/encoding"
)

func main() {
	redisClient := redis.NewClient(&redis.Options{
		Addr:     "localhost:6379",
		Password: "",
		DB:       0,
	})

	cachePrefix := ""
	jsonEncoding := encoding.JSONEncoding{}
	newObject := func() interface{} {
		return &User{}
	}

	c := cache.NewRedisCache(redisClient, cachePrefix, jsonEncoding, newObject)
	// operations
	// c.Set(ctx, key, value, expiration)
	// c.Get(ctx, key)
	// c.Delete(ctx, key)
}

Using Memory Cache

package main

import (
	"github.com/go-dev-frame/sponge/pkg/cache"
	"github.com/go-dev-frame/sponge/pkg/encoding"
)

func main() {
	// set memory cache client
	//cache.InitGlobalMemory(
	//	WithNumCounters(1e7),
	//	WithMaxCost(1<<30),
	//	WithBufferItems(64),
	//)

	cachePrefix := ""
	jsonEncoding := encoding.JSONEncoding{}
	newObject := func() interface{} {
		return &User{}
	}

	c := cache.NewMemoryCache(redisClient, cachePrefix, jsonEncoding, newObject)
	// operations
	// c.Set(ctx, key, value, expiration)
	// c.Get(ctx, key)
	// c.Delete(ctx, key)
}

Documentation

Overview

Package cache is memory and redis cache libraries.

Index

• Variables
• func BuildCacheKey(keyPrefix string, key string) (string, error)
• func CloseGlobalMemory() error
• func Del(ctx context.Context, keys ...string) error
• func Get(ctx context.Context, key string, val interface{}) error
• func GetGlobalMemoryCli() *ristretto.Cache
• func InitGlobalMemory(opts ...Option)
• func InitMemory(opts ...Option) *ristretto.Cache
• func MultiGet(ctx context.Context, keys []string, valueMap interface{}) error
• func MultiSet(ctx context.Context, valMap map[string]interface{}, expiration time.Duration) error
• func Set(ctx context.Context, key string, val interface{}, expiration time.Duration) error
• func SetCacheWithNotFound(ctx context.Context, key string) error
• type Cache
  • func NewMemoryCache(keyPrefix string, encode encoding.Encoding, newObject func() interface{}) Cache
  • func NewRedisCache(client *redis.Client, keyPrefix string, encode encoding.Encoding, ...) Cache
  • func NewRedisClusterCache(client *redis.ClusterClient, keyPrefix string, encode encoding.Encoding, ...) Cache
• type Option
  • func WithBufferItems(bufferItems int64) Option
  • func WithMaxCost(maxCost int64) Option
  • func WithNumCounters(numCounters int64) Option

Variables

var (
	// DefaultExpireTime default expiry time
	DefaultExpireTime = time.Hour * 24
	// DefaultNotFoundExpireTime expiry time when result is empty 1 minute,
	// often used for cache time when data is empty (cache pass-through)
	DefaultNotFoundExpireTime = time.Minute * 10

	// NotFoundPlaceholder placeholder
	NotFoundPlaceholder      = "*"
	NotFoundPlaceholderBytes = []byte(NotFoundPlaceholder)
	ErrPlaceholder           = errors.New("cache: placeholder")

	// DefaultClient generate a cache client, where keyPrefix is generally the business prefix
	DefaultClient Cache
)

var CacheNotFound = redis.Nil

CacheNotFound no hit cache

Functions

func BuildCacheKey

func BuildCacheKey(keyPrefix string, key string) (string, error)

BuildCacheKey construct a cache key with a prefix

func CloseGlobalMemory

func CloseGlobalMemory() error

CloseGlobalMemory close memory cache

func Del

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

Del multiple delete data

func Get

func Get(ctx context.Context, key string, val interface{}) error

Get data

func GetGlobalMemoryCli

func GetGlobalMemoryCli() *ristretto.Cache

GetGlobalMemoryCli get memory cache client

func InitGlobalMemory

func InitGlobalMemory(opts ...Option)

InitGlobalMemory init global memory cache

func InitMemory

func InitMemory(opts ...Option) *ristretto.Cache

InitMemory create a memory cache

func MultiGet

func MultiGet(ctx context.Context, keys []string, valueMap interface{}) error

MultiGet multiple get data

func MultiSet

func MultiSet(ctx context.Context, valMap map[string]interface{}, expiration time.Duration) error

MultiSet multiple set data

func Set

func Set(ctx context.Context, key string, val interface{}, expiration time.Duration) error

Set data

func SetCacheWithNotFound

func SetCacheWithNotFound(ctx context.Context, key string) error

SetCacheWithNotFound .

Types

type Cache

type Cache interface {
	Set(ctx context.Context, key string, val interface{}, expiration time.Duration) error
	Get(ctx context.Context, key string, val interface{}) error
	MultiSet(ctx context.Context, valMap map[string]interface{}, expiration time.Duration) error
	MultiGet(ctx context.Context, keys []string, valueMap interface{}) error
	Del(ctx context.Context, keys ...string) error
	SetCacheWithNotFound(ctx context.Context, key string) error
}

Cache driver interface

func NewMemoryCache

func NewMemoryCache(keyPrefix string, encode encoding.Encoding, newObject func() interface{}) Cache

NewMemoryCache create a memory cache

func NewRedisCache

func NewRedisCache(client *redis.Client, keyPrefix string, encode encoding.Encoding, newObject func() interface{}) Cache

NewRedisCache new a cache, client parameter can be passed in for unit testing

func NewRedisClusterCache

func NewRedisClusterCache(client *redis.ClusterClient, keyPrefix string, encode encoding.Encoding, newObject func() interface{}) Cache

NewRedisClusterCache new a cache

type Option

type Option func(*options)

Option set the jwt options.

func WithBufferItems

func WithBufferItems(bufferItems int64) Option

WithBufferItems set number of keys per Get buffer.

func WithMaxCost

func WithMaxCost(maxCost int64) Option

WithMaxCost set maximum cost of cache.

func WithNumCounters

func WithNumCounters(numCounters int64) Option

WithNumCounters set number of keys.