cn.sunxiansheng.redis.utils

类 RBase

java.lang.Object

cn.sunxiansheng.redis.utils.RBase

直接已知子类:

RHash, RList, RSet, RSortedSet, RString

public class RBase
extends Object

Redis基础工具类，提供一些基础的操作

字段概要

字段

限定符和类型	字段和说明
protected org.springframework.data.redis.core.RedisTemplate<String,Object>	redisTemplate

构造器概要

构造器

构造器和说明
RBase(org.springframework.data.redis.core.RedisTemplate<String,Object> redisTemplate)

方法概要

限定符和类型	方法和说明
String	buildKeyByCustomSeparator(String separator, String... parts) 构建缓存key（使用自定义的key分隔符）
String	buildKeyByDefaultSeparator(String... parts) 构建缓存key（使用默认的key分隔符）
protected <T> T	convertValue(Object value, Class<T> type) 转换缓存中的对象为指定类型
Boolean	delete(String key) 删除单个key
Long	deleteBatch(Collection<String> keys) 批量删除key
<T> T	executeLuaScript(String script, Class<T> resultType, Collection<String> keys, Object... args) 执行Lua脚本
Boolean	expire(String key, long timeout) 指定缓存失效时间（时间单位：秒）
Boolean	expire(String key, long timeout, TimeUnit unit) 指定缓存失效时间
Long	getExpire(String key) 获取缓存失效时间
Boolean	hasKey(String key) 判断key是否存在

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

redisTemplate

protected org.springframework.data.redis.core.RedisTemplate<String,Object> redisTemplate

构造器详细资料

RBase

public RBase(org.springframework.data.redis.core.RedisTemplate<String,Object> redisTemplate)

方法详细资料

buildKeyByDefaultSeparator

public String buildKeyByDefaultSeparator(String... parts)

构建缓存key（使用默认的key分隔符）

参数:

parts - 多个字符串拼接成缓存key

返回:

拼接后的缓存key

buildKeyByCustomSeparator

public String buildKeyByCustomSeparator(String separator,
                                        String... parts)

构建缓存key（使用自定义的key分隔符）

参数:

separator - 自定义的key分隔符

parts - 多个字符串拼接成缓存key

返回:

拼接后的缓存key

delete

public Boolean delete(String key)

删除单个key

参数:

key - 键

返回:

如果键不存在，返回false；如果删除成功，返回true

deleteBatch

public Long deleteBatch(Collection<String> keys)

批量删除key

参数:

keys - 键的集合

返回:

成功删除的键的数量，键不存在不计数

expire

public Boolean expire(String key,
                      long timeout,
                      TimeUnit unit)

指定缓存失效时间

参数:

key - 键

timeout - 失效时间（小于等于0 表示 永久有效）

unit - 时间单位

返回:

设置成功返回true，失败返回false

expire

public Boolean expire(String key,
                      long timeout)

指定缓存失效时间（时间单位：秒）

参数:

key - 键

timeout - 失效时间（单位：秒，小于等于0 表示 永久有效）

返回:

设置成功返回true，失败返回false

getExpire

public Long getExpire(String key)

获取缓存失效时间

参数:

key - 键

返回:

缓存失效时间（秒）。键不存在返回-2，键存在但没有设置过期时间返回-1

hasKey

public Boolean hasKey(String key)

判断key是否存在

参数:

key - 键

返回:

存在返回true，不存在返回false

convertValue

protected <T> T convertValue(Object value,
                             Class<T> type)

转换缓存中的对象为指定类型

类型参数:

T - 返回的泛型类型

参数:

value - 缓存中的对象

type - 要转换的目标类型

返回:

转换后的对象

抛出:

ClassCastException - 如果对象不能转换为指定类型

executeLuaScript

public <T> T executeLuaScript(String script,
                              Class<T> resultType,
                              Collection<String> keys,
                              Object... args)

执行Lua脚本

类型参数:

T - 返回类型的泛型

参数:

script - Lua脚本内容

resultType - 返回类型的Class对象

keys - Redis中脚本执行时需要的键

args - 脚本执行时需要的参数

返回:

执行结果