xcache

Documentation

Overview

缓存模块

Index

• func Clear() error
• func Exists(keys string) bool
• func Get(key string) (string, error)
• func GetString(key string) string
• func GetStruct(key string, val any) error
• func Key(args ...any) string
• func Regedit(conf *Config)
• func Remove(key string) error
• func RemoveRegedit()
• func Set(key, val string) error
• func SetExt(key, val string, t time.Duration) error
• func SetNumber(key string, val any) error
• func SetStruct(key string, val any) error
• func SetStructExt(key string, val any, t time.Duration) error
• type Config

Functions

func Clear

func Clear() error

清空缓存数据

func Exists

func Exists(keys string) bool

判断变量是否存在

keys	待判断的变量名

func Get

func Get(key string) (string, error)

获取key的值

key	要获取的key下标

func GetString

func GetString(key string) string

获取KEY设置的值

key	要获取的key下标

func GetStruct

func GetStruct(key string, val any) error

读取结构体

key	缓存的key名称
val	预期读取的类型【使用json串行化进行反解析】

func Key

func Key(args ...any) string

生成CacheKey下标

args	任意类型参数，用于进行MD5加密，返回缓存下标信息

func Regedit

func Regedit(conf *Config)

设置redis连接

conf	缓存配置项

func Remove

func Remove(key string) error

移除缓存下标信息

key	要移除的缓存下标

func RemoveRegedit

func RemoveRegedit()

移除缓存配置

func Set

func Set(key, val string) error

设置Key的值

key	下标
val	值

func SetExt

func SetExt(key, val string, t time.Duration) error

设置Key的值

key	下标
val	值
t	延时删除时间

func SetNumber

func SetNumber(key string, val any) error

设置数字类型缓存，避免使用时再进行fmt.Sprintf转化(因any类型可能为多种数字类型，所以此处使用fmt进行转化) 使用SetNumber存储，读取时也只能使用GetString进行读取，然后再通过xstring.Toxxxx进行转化【或者使用json.Number进行转化】

key	缓存下标
val	缓存值

func SetStruct

func SetStruct(key string, val any) error

设置结构体

key	缓存的key名称
val	设置的缓存值类型，使用json串行化进行解析存储

func SetStructExt

func SetStructExt(key string, val any, t time.Duration) error

设置结构体

key	缓存的key名称
val	设置的缓存值类型，使用json串行化进行解析存储
t	缓存时间

Types

type Config

type Config struct {
	Hosts       string                      // Redis连接地址
	Pass        string                      // redis密码
	RedisSelect uint8                       // redis查询库
	ErrFunc     func(msg string, err error) // Redis报错记录函数，用于记录Redis的报错信息

	// 以下的配置模块为程序内部使用的配置
	Conn        *redis.Pool   // redis连接配置
	CacheSync   sync.Map      // 程序内缓存定时
	Connect     redis.Conn    // redis连接
	DefaultTime time.Duration // 默认缓存时长
}

因xgodb.Cachexxxxx使用稍微有些繁杂，所以此处将缓存模块进一步精简，并逐步废弃xgodb.Cachexxx操作