cachex

README

Cachex

一个简单的缓存库。

读取

数据查询时会先命中第一层缓存，命中失败会从二级缓存等中读取至缓存中

写入

数据会先写入持久化存储再自动存储至第一层缓存中

支持的缓存类型

内存存储

Lru算法

Lru是一种内存数据淘汰策略，最近最少被使用的数据最先被淘汰。使用cachex.NewMemLruCacheStroage创建Lru内存缓存存储。

Lfu算法

Lfu是一种内存数据淘汰策略，使用频率最低的数据最先被淘汰。使用cachex.NewMemLfuCacheStroage创建Lfu内存缓存存储。

Fifo算法

Fifo是一种内存数据淘汰策略，最先加入缓存的数据最先被淘汰。使用cachex.NewMemFifoCacheStroage创建Fifo内存缓存存储。

持久化存储

Redis

使用Redis进行存储，使用cachex.NewRedisCacheStroage创建Redis缓存存储。

LevelDB

使用LevelDB进行存储，使用cachex.NewLevelDBCacheStroage创建Redis缓存存储。

使用方法

见example包

package main

import (
	"fmt"

	"github.com/lfhy/cachex"
)

// 内存缓存使用lru
// 远程缓存使用redis
func main() {
	// 初始化缓存配置
	lruCache := cachex.NewMemLruCacheStroage(30000)
	redisCache := cachex.NewRedisCacheStroage(&cachex.RedisConfig{
		Addr:     "192.168.188.230:6379",
		Password: "password",
		DB:       4,
	}, 0)
	// 建立缓存
	cache := cachex.NewCache(lruCache, redisCache)
	// 设置缓存
	cache.Set("hello", "world")
	// 读取缓存
	value, ok := cache.Get("hello")
	if ok {
		fmt.Printf("第一次从lru读取: %v\n", value)
	} else {
		fmt.Println("读取失败")
	}
	// Lru将缓存删除
	lruCache.Delete("hello")
	// 重新读取缓存
	value, ok = cache.Get("hello")
	if ok {
		fmt.Printf("第二次从redis读: %v\n", value)
	} else {
		fmt.Println("读取失败")
	}
}

Documentation

Index

• type Cache
  • func NewCache(defaultcache CacheStroage[any], remotecache ...CacheStroage[any]) *Cache[any]
  • func NewCacheWithType[T any](defaultcache CacheStroage[T], remotecache ...CacheStroage[T]) *Cache[T]
  • func (c *Cache[T]) Close()
  • func (c *Cache[T]) Create(key string, value T)
  • func (c *Cache[T]) Delete(key string)
  • func (c *Cache[T]) Free()
  • func (c *Cache[T]) Get(key string) (T, bool)
  • func (c *Cache[T]) GetOrSet(key string, value T) (oldValue T, isLoad bool)
  • func (c *Cache[T]) GetOrSetFunc(key string, setFn func() (value T, canSet bool)) (oldValue T, isLoad bool)
  • func (c *Cache[T]) Save(key string, value T)
  • func (c *Cache[T]) Set(key string, value T)
  • func (c *Cache[T]) SetFunc(key string, fn func() (value T, canSet bool))
  • func (c *Cache[T]) Swap(key string, value T) (oldValue T, isLoad bool)
• type CacheStroage
• type Data
• type Eviction
• type FifoCache
  • func NewMemFifoCacheStroage(cacheSize ...int) *FifoCache[any]
  • func NewMemFifoCacheStroageWithType[T any](cacheSize ...int) *FifoCache[T]
  • func (FifoCache) Close()
  • func (c *FifoCache[T]) Delete(key string)
  • func (c *FifoCache[T]) Free()
  • func (c *FifoCache[T]) Get(key string) (T, bool)
  • func (c *FifoCache[T]) Set(key string, value T)
• type JsonByteData
• type LeveldbCache
  • func NewLevelDBCacheStroage(dbpath string) (*LeveldbCache[any], error)
  • func NewLevelDBCacheStroageWithType[T any](dbpath string) (*LeveldbCache[T], error)
  • func (c *LeveldbCache[T]) Close()
  • func (c *LeveldbCache[T]) Delete(key string)
  • func (c *LeveldbCache[T]) Free()
  • func (c *LeveldbCache[T]) Get(key string) (T, bool)
  • func (c *LeveldbCache[T]) GetDBInterface() *leveldb.DB
  • func (c *LeveldbCache[T]) Set(key string, value T)
• type LfuCache
  • func NewMemLfuCacheStroage() *LfuCache[any]
  • func NewMemLfuCacheStroageWithType[T any]() *LfuCache[T]
  • func (LfuCache) Close()
  • func (c *LfuCache[T]) Delete(key string)
  • func (c *LfuCache[T]) Free()
  • func (c *LfuCache[T]) Get(key string) (T, bool)
  • func (c *LfuCache[T]) Set(key string, value T)
• type LruCache
  • func NewMemLruCacheStroage(cacheSize ...int) *LruCache[any]
  • func NewMemLruCacheStroageWithType[T any](cacheSize ...int) *LruCache[T]
  • func (LruCache) Close()
  • func (c *LruCache[T]) Delete(key string)
  • func (c *LruCache[T]) Free()
  • func (c *LruCache[T]) Get(key string) (T, bool)
  • func (c *LruCache[T]) Set(key string, value T)
• type RedisCache
  • func NewRedisCacheStroage(config *RedisConfig, timeout ...time.Duration) *RedisCache[any]
  • func NewRedisCacheStroageWithType[T any](config *RedisConfig, timeout ...time.Duration) *RedisCache[T]
  • func (c *RedisCache[T]) Close()
  • func (c *RedisCache[T]) Delete(key string)
  • func (c *RedisCache[T]) Free()
  • func (c *RedisCache[T]) Get(key string) (T, bool)
  • func (c *RedisCache[T]) GetDBInterface() *redis.Client
  • func (c *RedisCache[T]) Set(key string, value T)
• type RedisConfig
• type SliceMap
  • func (SliceMap) Close()
  • func (m *SliceMap[T]) Delete(key string)
  • func (m *SliceMap[T]) Get(key string) (T, bool)
  • func (m *SliceMap[T]) Len() int
  • func (m *SliceMap[T]) Pop() (T, bool)
  • func (m *SliceMap[T]) Set(key string, value T)

Types

type Cache

type Cache[T any] struct {
	// contains filtered or unexported fields
}

func NewCache

func NewCache(defaultcache CacheStroage[any], remotecache ...CacheStroage[any]) *Cache[any]

默认创any类型的存储

func NewCacheWithType

func NewCacheWithType[T any](defaultcache CacheStroage[T], remotecache ...CacheStroage[T]) *Cache[T]

带有类型的存储

func (*Cache[T]) Close

func (c *Cache[T]) Close()

关闭缓存

func (*Cache[T]) Create

func (c *Cache[T]) Create(key string, value T)

设置缓存别名

func (*Cache[T]) Delete

func (c *Cache[T]) Delete(key string)

删除缓存

func (*Cache[T]) Free

func (c *Cache[T]) Free()

清空缓存

func (*Cache[T]) Get

func (c *Cache[T]) Get(key string) (T, bool)

获取缓存

func (*Cache[T]) GetOrSet

func (c *Cache[T]) GetOrSet(key string, value T) (oldValue T, isLoad bool)

获取失败时则设置缓存为指定值

func (*Cache[T]) GetOrSetFunc

func (c *Cache[T]) GetOrSetFunc(key string, setFn func() (value T, canSet bool)) (oldValue T, isLoad bool)

获取失败时则通过指定函数设置为指定值

func (*Cache[T]) Save

func (c *Cache[T]) Save(key string, value T)

设置缓存别名

func (*Cache[T]) Set

func (c *Cache[T]) Set(key string, value T)

设置缓存

func (*Cache[T]) SetFunc

func (c *Cache[T]) SetFunc(key string, fn func() (value T, canSet bool))

通过函数取值 取值后设置缓存

func (*Cache[T]) Swap

func (c *Cache[T]) Swap(key string, value T) (oldValue T, isLoad bool)

获取缓存并设置为另一个值

type CacheStroage

type CacheStroage[T any] interface {
	// 获取缓存
	Get(key string) (T, bool)
	// 设置缓存
	Set(key string, value T)
	// 删除缓存
	Delete(key string)
	// 清空缓存
	Free()
	// 关闭
	Close()
}

type Data

type Data[T any] struct {
	// contains filtered or unexported fields
}

type Eviction

type Eviction[T any] struct {
	Key   string
	Value T
}

type FifoCache

type FifoCache[T any] struct {
	// contains filtered or unexported fields
}

func NewMemFifoCacheStroage

func NewMemFifoCacheStroage(cacheSize ...int) *FifoCache[any]

Fifo最近最先加入缓存的数据最先被淘汰

func NewMemFifoCacheStroageWithType

func NewMemFifoCacheStroageWithType[T any](cacheSize ...int) *FifoCache[T]

Fifo最近最先加入缓存的数据最先被淘汰

func (FifoCache) Close

func (FifoCache) Close()

func (*FifoCache[T]) Delete

func (c *FifoCache[T]) Delete(key string)

删除缓存

func (*FifoCache[T]) Free

func (c *FifoCache[T]) Free()

清空缓存

func (*FifoCache[T]) Get

func (c *FifoCache[T]) Get(key string) (T, bool)

获取缓存

func (*FifoCache[T]) Set

func (c *FifoCache[T]) Set(key string, value T)

设置缓存

type JsonByteData

type JsonByteData[T any] struct {
	Data T `json:"Data"`
}

type LeveldbCache

type LeveldbCache[T any] struct {
	// contains filtered or unexported fields
}

func NewLevelDBCacheStroage

func NewLevelDBCacheStroage(dbpath string) (*LeveldbCache[any], error)

Leveldb最近最少被使用的数据最先被淘汰

func NewLevelDBCacheStroageWithType

func NewLevelDBCacheStroageWithType[T any](dbpath string) (*LeveldbCache[T], error)

Leveldb最近最少被使用的数据最先被淘汰

func (*LeveldbCache[T]) Close

func (c *LeveldbCache[T]) Close()

获取DB实例对象

func (*LeveldbCache[T]) Delete

func (c *LeveldbCache[T]) Delete(key string)

删除缓存

func (*LeveldbCache[T]) Free

func (c *LeveldbCache[T]) Free()

清空缓存

func (*LeveldbCache[T]) Get

func (c *LeveldbCache[T]) Get(key string) (T, bool)

获取缓存

func (*LeveldbCache[T]) GetDBInterface

func (c *LeveldbCache[T]) GetDBInterface() *leveldb.DB

获取DB实例对象

func (*LeveldbCache[T]) Set

func (c *LeveldbCache[T]) Set(key string, value T)

设置缓存

type LfuCache

type LfuCache[T any] struct {
	UpperBound int
	LowerBound int

	EvictionChannel chan<- Eviction[T]
	// contains filtered or unexported fields
}

func NewMemLfuCacheStroage

func NewMemLfuCacheStroage() *LfuCache[any]

Lfu使用频率最低的数据最先被淘汰

func NewMemLfuCacheStroageWithType

func NewMemLfuCacheStroageWithType[T any]() *LfuCache[T]

Lfu使用频率最低的数据最先被淘汰

func (LfuCache) Close

func (LfuCache) Close()

func (*LfuCache[T]) Delete

func (c *LfuCache[T]) Delete(key string)

删除缓存

func (*LfuCache[T]) Free

func (c *LfuCache[T]) Free()

清空缓存

func (*LfuCache[T]) Get

func (c *LfuCache[T]) Get(key string) (T, bool)

获取缓存

func (*LfuCache[T]) Set

func (c *LfuCache[T]) Set(key string, value T)

设置缓存

type LruCache

type LruCache[T any] struct {
	// contains filtered or unexported fields
}

func NewMemLruCacheStroage

func NewMemLruCacheStroage(cacheSize ...int) *LruCache[any]

Lru最近最少被使用的数据最先被淘汰

func NewMemLruCacheStroageWithType

func NewMemLruCacheStroageWithType[T any](cacheSize ...int) *LruCache[T]

Lru最近最少被使用的数据最先被淘汰

func (LruCache) Close

func (LruCache) Close()

func (*LruCache[T]) Delete

func (c *LruCache[T]) Delete(key string)

删除缓存

func (*LruCache[T]) Free

func (c *LruCache[T]) Free()

清空缓存

func (*LruCache[T]) Get

func (c *LruCache[T]) Get(key string) (T, bool)

获取缓存

func (*LruCache[T]) Set

func (c *LruCache[T]) Set(key string, value T)

设置缓存

type RedisCache

type RedisCache[T any] struct {
	// contains filtered or unexported fields
}

func NewRedisCacheStroage

func NewRedisCacheStroage(config *RedisConfig, timeout ...time.Duration) *RedisCache[any]

Redis存储 传入连接参数和缓存超时时间

func NewRedisCacheStroageWithType

func NewRedisCacheStroageWithType[T any](config *RedisConfig, timeout ...time.Duration) *RedisCache[T]

Redis存储 传入连接参数和缓存超时时间

func (*RedisCache[T]) Close

func (c *RedisCache[T]) Close()

func (*RedisCache[T]) Delete

func (c *RedisCache[T]) Delete(key string)

删除缓存

func (*RedisCache[T]) Free

func (c *RedisCache[T]) Free()

清空缓存

func (*RedisCache[T]) Get

func (c *RedisCache[T]) Get(key string) (T, bool)

获取缓存

func (*RedisCache[T]) GetDBInterface

func (c *RedisCache[T]) GetDBInterface() *redis.Client

获取DB实例对象

func (*RedisCache[T]) Set

func (c *RedisCache[T]) Set(key string, value T)

设置缓存

type RedisConfig

type RedisConfig = redis.Options

type SliceMap

type SliceMap[T any] struct {
	// contains filtered or unexported fields
}

func (SliceMap) Close

func (SliceMap) Close()

func (*SliceMap[T]) Delete

func (m *SliceMap[T]) Delete(key string)

func (*SliceMap[T]) Get

func (m *SliceMap[T]) Get(key string) (T, bool)

func (*SliceMap[T]) Len

func (m *SliceMap[T]) Len() int

func (*SliceMap[T]) Pop

func (m *SliceMap[T]) Pop() (T, bool)

func (*SliceMap[T]) Set

func (m *SliceMap[T]) Set(key string, value T)