localcache

README

What is go-localcache ?

A mem cache library by golang.

Why choose go-localcache ?

1、Support to set different TTL for every key

2、LRU policy to delete useless keys

3、Similar performance like sync.Map -> see bench_test

How to use

	cache := localcache.NewLocalCache(
		localcache.WithCapacity(1024), // WithShardCount set max Capacity
		localcache.WithShardCount(256),// WithShardCount shardCnt must be a power of 2
		localcache.WithGlobalTTL(120), // WithGlobalTTL set all keys default expire time of seconds
		localcache.WithStatist(true),  // WithStatist set whether need to caculate the cache stastic
		localcache.WithPolicy(localcache.PolicyTypeLRU), // WithPolicy set the elimination policy of key
	)
	
	// Get a key and return the value and if the key exists
	cache.Get(key string) (interface{}, bool)
	
	// Set a key-value with default seconds to live
	cache.Set(key string, value interface{})
	
	// SetWithExpire set a key-value with seconds to live
	cache.SetWithExpire(key string, value interface{}, ttl int64)
	
	// Del delete key and return if the key exists
	cache.Del(key string) bool
	
	// Len return count of keys in cache
	cache.Len() int
	
	// Flush clear all keys in chache, should do this when set and del is stop
	cache.Flush()
	
	// Stop the cacheProcess by close stopChan
	cache.Stop()

	// Statistic return cache Statics {"hit":1, "miss":1, "hitRate":50.0}
	Statistic() map[string]interface{}

Documentation

Index

• Constants
• type Cache
  • func NewLocalCache(options ...Option) Cache
• type Option
  • func WithCapacity(cap int) Option
  • func WithGlobalTTL(expireSecond int64) Option
  • func WithPolicy(policyType string) Option
  • func WithShardCount(shardCnt int) Option
  • func WithStatist(needStatistic bool) Option

Constants

const (
	PolicyTypeLRU = "lru"
)

Types

type Cache

type Cache interface {
	// Get a key and return the value and if the key exists
	Get(key string) (interface{}, bool)
	// Set a key-value with default seconds to live
	Set(key string, value interface{})
	// SetWithExpire set a key-value with seconds to live
	SetWithExpire(key string, value interface{}, ttl int64)
	// Del delete key
	Del(key string)
	// Len return count of keys in cache
	Len() int
	// Flush clear all keys in chache, should do this when set and del is stop
	Flush()
	// Stop the cacheProcess by close stopChan
	Stop()
	// Statistic return cache Statistic {"hit":1, "miss":1, "hitRate":50.0}
	Statistic() map[string]interface{}
}

func NewLocalCache

func NewLocalCache(options ...Option) Cache

NewLocalCache return Cache obj with options

type Option

type Option func(*localCache)

func WithCapacity

func WithCapacity(cap int) Option

WithShardCount set max Capacity

func WithGlobalTTL

func WithGlobalTTL(expireSecond int64) Option

WithGlobalTTL set all keys default expire time of seconds

func WithPolicy

func WithPolicy(policyType string) Option

WithPolicy set the elimination policy of keys

func WithShardCount

func WithShardCount(shardCnt int) Option

WithShardCount shardCnt must be a power of 2

func WithStatist

func WithStatist(needStatistic bool) Option

WithStatist set whether need to caculate the cache`s statist, default false.

not need may led performance a very little better ^-^