com.hccake.ballcat.common.redis

类 RedisHelper

java.lang.Object

com.hccake.ballcat.common.redis.RedisHelper

public class RedisHelper
extends Object

Redis 操作的辅助类

作者:

lingting, svn, hccake

字段概要

字段

限定符和类型	字段和说明
static RedisHelper	INSTANCE

方法概要

限定符和类型	方法和说明
static long	decr(String key) 当 key 存在时，对其值进行自减操作 （自减步长为 1），当 key 不存在时，则先赋值为 0 再进行自减
static long	decrBy(String key, long delta) 当 key 存在时，对其值进行自减操作，当 key 不存在时，则先赋值为 0 再进行自减
static long	del(Collection<String> keys)
static long	del(String... keys) 删除指定的 keys
static boolean	del(String key) 删除指定的 key
static long	delete(Collection<String> keys) 已过时。 use del(Collection)
static boolean	delete(String key) 已过时。 use del(String)
static Object	evalLua(String lua, List<String> key, Object... argv) 已过时。 RedisScript 应该做为单例，而不是每次生成，不推荐直接使用此方法
static <T> T	execute(org.springframework.data.redis.core.RedisCallback<T> action) 执行 lua脚本
static <T> T	execute(org.springframework.data.redis.core.RedisCallback<T> action, boolean exposeConnection)
static <T> T	execute(org.springframework.data.redis.core.RedisCallback<T> action, boolean exposeConnection, boolean pipeline)
static <T> T	execute(org.springframework.data.redis.core.script.RedisScript<T> script, List<String> keys, Object... args)
static <T> T	execute(org.springframework.data.redis.core.script.RedisScript<T> script, org.springframework.data.redis.serializer.RedisSerializer<?> argsSerializer, org.springframework.data.redis.serializer.RedisSerializer<T> resultSerializer, List<String> keys, Object... args)
static <T> T	execute(org.springframework.data.redis.core.SessionCallback<T> session)
static List<Object>	executePipelined(org.springframework.data.redis.core.RedisCallback<?> action)
static List<Object>	executePipelined(org.springframework.data.redis.core.RedisCallback<?> action, org.springframework.data.redis.serializer.RedisSerializer<?> resultSerializer)
static List<Object>	executePipelined(org.springframework.data.redis.core.SessionCallback<?> session)
static List<Object>	executePipelined(org.springframework.data.redis.core.SessionCallback<?> session, org.springframework.data.redis.serializer.RedisSerializer<?> resultSerializer)
static long	exists(Collection<String> keys)
static long	exists(String... keys) 判断指定的 key 是否存在.
static boolean	exists(String key) 判断 key 是否存在
static boolean	expire(String key, long timeout) 设置过期时间
static boolean	expire(String key, long timeout, TimeUnit timeUnit) 设置过期时间
static boolean	expireAt(String key, Date date) 设置 key 的过期时间到指定的日期
static boolean	expireAt(String key, Instant expireAt)
static String	get(String key) 获取指定 key 的 value 值
static String	getDel(String key) 获取指定 key 的 value 值，并将指定的 key 进行删除
static String	getEx(String key, long timeout) 获取指定 key 的 value 值，并对 key 设置指定的过期时间
static String	getEx(String key, long timeout, TimeUnit timeUnit) 获取指定 key 的 value 值，并对 key 设置指定的过期时间
static org.springframework.data.redis.core.RedisTemplate<String,String>	getRedisTemplate()
static String	getSet(String key, String value) 获取指定的 key 的 value 值，并同时使用指定的 value 值进行覆盖操作
static Long	hashDelete(String key, String... fields) 已过时。 hDel(String, String...)
static String	hashGet(String key, String field) 已过时。 hGet(String, String)
static org.springframework.data.redis.core.HashOperations<String,String,String>	hashOps()
static void	hashSet(String key, String field, String value) 已过时。 hSet(String, String, String)
static boolean	hasKey(String key) 已过时。
static long	hDel(String key, String... fields) 删除指定 hash 的 fields
static boolean	hExists(String key, String field) 判断指定 hash 的 指定 field 是否存在
static String	hGet(String key, String field) 获取 hash 中的指定 field 对应的 value 值
static Map<String,String>	hGetAll(String key) 获取 hash 中所有的 fields 和 values, 并已键值对的方式返回
static Long	hIncrBy(String key, String field) 对 hash 中指定的 field 进行自增
static long	hIncrBy(String key, String field, long delta) 对 hash 中指定的 field 进行自增 若 field 不存在则，先设置为 0 再进行自增，若 hash 不存在则先创建 hash 再进行上述步骤
static double	hIncrByFloat(String key, String field, double delta) 对 hash 中指定的 field 进行自增 若 field 不存在则，先设置为 0 再进行自增，若 hash 不存在则先创建 hash 再进行上述步骤
static Set<String>	hKeys(String key) 返回 hash 中的所有 fields
static long	hLen(String key) 返回 hash 中 fields 的数量
static List<String>	hMGet(String key, Collection<String> fields) 返回 hash 中指定 fields 的值集合
static List<String>	hMGet(String key, String... fields) 返回 hash 中指定 fields 的值集合
static void	hSet(String key, String field, String value) 修改 hash 中的 field 的值，有则覆盖，无则添加
static void	hSetNx(String key, String field, String value) 修改 hash 中的 field 的值，有则不进行操作，无则添加
static List<String>	hVals(String key) 返回 hash 中的所有 values
static long	incr(String key) 对 key 进行自增，自增步长为 1
static long	incrAndExpire(String key, long timeout) 对 key 进行自增 (步长为 1)，并设置过期时间
static long	incrBy(String key, long delta) 对 key 进行自增，并指定自增步长, 当 key 不存在时先创建一个值为 0 的 key，再进行自增
static long	incrByAndExpire(String key, long delta, long timeout) 对 key 进行自增并设置过期时间，指定自增步长, 当 key 不存在时先创建一个值为 0 的 key，再进行自增
static double	incrByFloat(String key, double delta)
static Long	increment(String key) 已过时。 incr(String)
static Long	increment(String key, long delta) 已过时。 incrBy(String, long)
static Long	incrementAndExpire(String key, long time) 已过时。 incrAndExpire(String, long)}
static Long	incrementAndExpire(String key, long delta, long time) 已过时。 incrByAndExpire(String, long, long)}
static Set<String>	keys(String pattern) 获取所有符合指定表达式的 key
static String	lIndex(String key, long index) 获取指定 list 指定索引位置的元素
static List<String>	listGet(String key) 已过时。 use lRange(key, 0, -1) lRange(String, long, long)
static String	listIndex(String key, long index) 已过时。 lIndex(String, long)
static Long	listIndexOf(String key, String val) 已过时。 lPos(String, String)
static String	listLeftPop(String key) 已过时。 lPop(String)
static Long	listLeftPush(String key, String val) 已过时。 lPush(String, String...)
static org.springframework.data.redis.core.ListOperations<String,String>	listOps()
static Long	listRemove(String key, long count, String val) 已过时。
static Long	listRemove(String key, String val) 已过时。
static String	listRightPop(String key) 已过时。 rPop(String)
static Long	listRightPush(String key, String val) 已过时。 rPush(String, String...)
static long	listSet(String key, List<String> list, long time) 已过时。
static long	listSize(String key) 已过时。 lLen(String)
static long	lLen(String key) 获取指定 list 的元素个数即长度
static String	lPop(String key) 以原子方式返回并删除列表的第一个元素，例如列表包含元素 "a", "b", "c" LPOP 操作将返回 ”a“ 并将其删除，list 中元素变为 ”b“, "c"
static List<String>	lPop(String key, long count) 以原子方式返回并删除列表的多个元素
static Long	lPos(String key, String element) 该命令返回 list 匹配元素的索引。
static long	lPush(String key, List<String> elements) 将指定的值插入 list 的头部，若 list 不存在，则先指向创建一个空的 list
static long	lPush(String key, String... elements) 将指定的元素插入 list 的头部，若 list 不存在，则先指向创建一个空的 list
static List<String>	lRange(String key, long start, long end) 获取 list 指定 offset 间的元素。
static long	lRem(String key, long count, String value) 删除 list 中的元素 count > 0: 从 list 头部向尾部查找并删除 n 个和指定值相等的元素，n 为 count count < 0: 从 list 尾部向头部查找并删除 n 个和指定值相等的元素，n 为 count 的绝对值 count = 0: 删除 list 中所有和指定值相等的元素
static void	lSet(String key, long index, String value) 将 list 指定 index 位置的元素设置为当前值
static void	lTrim(String key, long start, long end) 裁剪 list，只保留 start 到 end 之间的元素值，包含 start 和 end
static List<String>	mGet(Collection<String> keys) 从指定的 keys 批量获取 values
static List<String>	mGet(String... keys)
static Map<String,String>	mGetToMap(Collection<String> keys) 批量获取 keys 的值，并返回一个 map
static Map<String,String>	mGetToMap(String... keys)
static List<String>	multiGet(Collection<String> keys) 已过时。 mGet(Collection)
static void	publish(String channel, byte[] message) Publish 一条消息
static void	publish(String channel, String message) Publish 一条消息
static String	rPop(String key) 以原子方式返回并删除列表的最后一个元素。
static List<String>	rPop(String key, long count) 从 list 尾部，以原子方式返回并删除列表中指定数量的元素。
static long	rPush(String key, List<String> values) 将指定的值插入 list 的尾部，若 list 不存在，则先指向创建一个空的 list
static long	rPush(String key, String... values) 将指定的值插入 list 的尾部，若 list 不存在，则先指向创建一个空的 list
static long	sAdd(String key, List<String> members) 将指定的 member 添加到 Set 中，如果 Set 中已有该 member 则忽略。
static long	sAdd(String key, String... members) 将指定的 member 添加到 Set 中，如果 Set 中已有该 member 则忽略。
static org.springframework.data.redis.core.Cursor<String>	scan(org.springframework.data.redis.core.ScanOptions scanOptions) 使用 Cursor 遍历指定规则的 keys
static org.springframework.data.redis.core.Cursor<String>	scan(String patten) 使用 Cursor 遍历指定规则的 keys
static org.springframework.data.redis.core.Cursor<String>	scan(String patten, long count) 使用 Cursor 遍历指定规则的 keys
static long	sCard(String key) 返回 Set 中的元素数，如果 set 不存在则返回 0
static void	set(String key, String value) 设置 value for key
static void	set(String key, String val, Instant instant) 已过时。 {setExAt(String, String, Instant)}
static void	set(String key, String value, long timeout) 设置 value for key, 同时为其设置过期时间
static void	set(String key, String value, long timeout, TimeUnit timeUnit) 设置 value for key, 同时为其设置过期时间
static Long	setAdd(String key, String... values) 已过时。 sAdd(String, String...)
static void	setEx(String key, String value, long timeout) 设置 value for key, 同时为其设置过期时间
static void	setEx(String key, String value, long timeout, TimeUnit timeUnit) 设置 value for key, 同时为其设置过期时间
static void	setExAt(String key, String value, Instant expireTime) 设置 value for key, 同时为其设置其在指定时间过期
static boolean	setIfAbsent(String key, String value) 已过时。 setNx(String, String)
static boolean	setIfAbsent(String key, String value, long time) 已过时。 setNxEx(String, String, long)
static boolean	setNx(String key, String value) 当 key 不存在时，进行 value 设置，当 key 存在时不执行操作
static boolean	setNxEx(String key, String value, long timeout) 当 key 不存在时，进行 value 设置并添加过期时间，当 key 存在时不执行操作
static boolean	setNxEx(String key, String value, long timeout, TimeUnit timeUnit) 当 key 不存在时，进行 value 设置并添加过期时间，当 key 存在时不执行操作
static org.springframework.data.redis.core.SetOperations<String,String>	setOps()
static String	setPop(String key) 已过时。 sPop(String)
static void	setRedisTemplate(org.springframework.data.redis.core.RedisTemplate<String,String> redisTemplate)
static Long	setRemove(String key, String... values) 已过时。 sRem(String, String...)
static Long	setSize(String key) 已过时。 sCard(String)
static boolean	sIsMember(String key, String value) 判断指定的值是否是 Set 中的元素 Time complexity O(1)
static Set<String>	sMembers(String key) 获取 Set 中的所有元素 Time complexity O(N)
static Map<Object,Boolean>	sMIsMember(String key, String... values) 判断指定的值是否是 Set 中的元素 Time complexity O(N)
static String	sPop(String key) 随机从 Set 中删除一个元素，并返回它，如果 Set 为空，则返回 null Time complexity O(1)
static String	sRandMember(String key) 随机从 Set 中返回一个元素，但不删除，如果 Set 为空，则返回 null Time complexity O(1)
static Set<String>	sRandMember(String key, long count) 随机从 Set 中返回 count 个元素，但不删除，如果 Set 为空，则返回 null Time complexity O(1)
static long	sRem(String key, String... members) 从 Set 中删除指定的 member，如果给的值不是 Set 的 member 则不进行操作 Time complexity O(1)
static org.springframework.data.redis.core.Cursor<String>	sScan(String key, org.springframework.data.redis.core.ScanOptions scanOptions) 使用 Cursor 遍历指定 Set 中的所有元素
static org.springframework.data.redis.core.StreamOperations<String,String,String>	streamOps()
static long	ttl(String key) TTL 命令返回 EXPIRE 命令设置的剩余生存时间（以秒为单位）.。
static org.springframework.data.redis.core.ValueOperations<String,String>	valueOps()
static long	xAck(String key, String group, org.springframework.data.redis.connection.stream.RecordId... ids)
static long	xAck(String key, String group, String... ids) XACK key group ID [ID ...]
static org.springframework.data.redis.connection.stream.RecordId	xAdd(org.springframework.data.redis.connection.stream.MapRecord<String,String,String> mapRecord, org.springframework.data.redis.connection.RedisStreamCommands.XAddOptions xAddOptions)
static org.springframework.data.redis.connection.stream.RecordId	xAdd(String key, Map<String,String> content) XADD key ID field string [field string ...]
static org.springframework.data.redis.connection.stream.RecordId	xAdd(String key, Map<String,String> content, org.springframework.data.redis.connection.RedisStreamCommands.XAddOptions xAddOptions)
static long	xDel(String key, org.springframework.data.redis.connection.stream.RecordId... ids)
static long	xDel(String key, String... ids) XDEL key ID [ID ...]
static String	xGroupCreate(String key, String groupName)
static String	xGroupCreate(String key, String groupName, org.springframework.data.redis.connection.stream.ReadOffset readOffset, boolean makeStream) XGROUP CREATE
static long	xLen(String key) XLEN key
static List<org.springframework.data.redis.connection.stream.MapRecord<String,String,String>>	xRange(String key, org.springframework.data.domain.Range<String> range) XRANGE key start end COUNT count
static List<org.springframework.data.redis.connection.stream.MapRecord<String,String,String>>	xRange(String key, org.springframework.data.domain.Range<String> range, org.springframework.data.redis.connection.RedisZSetCommands.Limit limit)
static List<org.springframework.data.redis.connection.stream.MapRecord<String,String,String>>	xRead(org.springframework.data.redis.connection.stream.StreamOffset<String>... streams) XREAD [COUNT count] [BLOCK milliseconds] STREAMS key [key ...]
static List<org.springframework.data.redis.connection.stream.MapRecord<String,String,String>>	xRead(org.springframework.data.redis.connection.stream.StreamReadOptions streamReadOptions, org.springframework.data.redis.connection.stream.StreamOffset<String>... streams)
static List<org.springframework.data.redis.connection.stream.MapRecord<String,String,String>>	xReadGroup(org.springframework.data.redis.connection.stream.Consumer consumer, org.springframework.data.redis.connection.stream.StreamOffset<String>... streams) XREADGROUP GROUP group consumer [COUNT count] [BLOCK milliseconds] [NOACK] STREAMS key [key ...] id [id ...]
static List<org.springframework.data.redis.connection.stream.MapRecord<String,String,String>>	xReadGroup(org.springframework.data.redis.connection.stream.Consumer consumer, org.springframework.data.redis.connection.stream.StreamReadOptions streamReadOptions, org.springframework.data.redis.connection.stream.StreamOffset<String>... streams)
static List<org.springframework.data.redis.connection.stream.MapRecord<String,String,String>>	xReadGroup(String group, String consumer, org.springframework.data.redis.connection.stream.StreamOffset<String>... streams)
static List<org.springframework.data.redis.connection.stream.MapRecord<String,String,String>>	xReadGroup(String group, String consumer, org.springframework.data.redis.connection.stream.StreamReadOptions streamReadOptions, org.springframework.data.redis.connection.stream.StreamOffset<String>... streams)
static boolean	zAdd(String key, double score, String member) 添加拥有指定 score 的 member 到 Sorted Set 中。
static long	zAdd(String key, Map<String,Double> scoreMembers) 批量添加拥有指定 score 的 member 到 Sorted Set 中。
static long	zCard(String key) 返回 Sorted Set 的元素数量，若 key 不存在则返回 0 Time complexity O(1)
static double	zIncrBy(String key, double increment, String member) 如果 member 存在于 Sorted Set 中，则对其 score 和 increment 进行相加运算，并重排序。
static org.springframework.data.redis.core.ZSetOperations.TypedTuple<String>	zPopMax(String key) 返回并删除 Sorted Set 中分数最高的那个元素 Time complexity O(log(N)) with N being the number of elements in the sorted set
static Set<org.springframework.data.redis.core.ZSetOperations.TypedTuple<String>>	zPopMax(String key, long count) 返回并删除 Sorted Set 中分数最高的 n 个元素 Time complexity O(log(N)) with N being the number of elements in the sorted set
static org.springframework.data.redis.core.ZSetOperations.TypedTuple<String>	zPopMin(String key) 返回并删除 Sorted Set 中分数最低的那个元素 Time complexity O(log(N)) with N being the number of elements in the sorted set
static Set<org.springframework.data.redis.core.ZSetOperations.TypedTuple<String>>	zPopMin(String key, long count) 返回并删除 Sorted Set 中分数最低的 n 个元素 Time complexity O(log(N)) with N being the number of elements in the sorted set
static String	zRandMember(String key) 随机从 Sorted Set 中返回一个 member Time complexity O(N) where N is the number of elements returned
static Set<String>	zRange(String key, long start, long end) 返回 Sorted Set 中指定索引范围内的 member.
static Set<String>	zRangeByScore(String key, double min, double max) 返回 Sorted Set 中指定 score 间的所有元素（包括 score 等于 min 和 max 的元素） Time complexity O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned.
static Set<String>	zRangeByScore(String key, double min, double max, long offset, long count) 返回 Sorted Set 中指定 score 间的所有元素（包括 score 等于 min 和 max 的元素）
static Set<org.springframework.data.redis.core.ZSetOperations.TypedTuple<String>>	zRangeByScoreWithScores(String key, double min, double max) 返回 Sorted Set 中指定 score 间的所有元素和其分数（包括 score 等于 min 和 max 的元素）
static Long	zRank(String key, String member) 返回 member 的排名（索引）。
static long	zRem(String key, String... members) 从 Sorted Set 中删除指定的 member。
static Set<String>	zRevRange(String key, long start, long end) 返回 Sorted Set 中 index 在 start 和 end 之前的所有成员（包括 start 和 end）。
static Set<String>	zRevRangeByScore(String key, double min, double max) 返回 Sorted Set 中分数在 min 和 max 之前的所有成员（包括 min 和 max）。
static Double	zScore(String key, String member) 返回 Sorted Set 中指定 member 的分数。
static Boolean	zSetAdd(String key, String value, double score) 已过时。 zAdd(String, double, String)
static org.springframework.data.redis.core.ZSetOperations<String,String>	zSetOps()
static String	zSetRandom(String key) 已过时。 zRandMember(String)
static Set<String>	zSetRange(String key, int start, int end) 已过时。 zRange(String, long, long)
static Set<String>	zSetRangeByScore(String key, double min, double max) 已过时。 zRangeByScore(String, double, double)
static Long	zSetRank(String key, String value) 已过时。 zRank(String, String)
static Long	zSetRemove(String key, String... values) 已过时。 zRem(String, String...)
static Set<String>	zSetReverseRange(String key, int start, int end) 已过时。 zRevRange(String, long, long)
static Set<String>	zSetReverseRangeByScore(String key, double min, double max) 已过时。 zRevRangeByScore(String, double, double)
static Long	zSetSize(String key) 已过时。 zCard(String)

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

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

字段详细资料

INSTANCE

public static final RedisHelper INSTANCE

方法详细资料

getRedisTemplate

public static org.springframework.data.redis.core.RedisTemplate<String,String> getRedisTemplate()

setRedisTemplate

public static void setRedisTemplate(org.springframework.data.redis.core.RedisTemplate<String,String> redisTemplate)

hashOps

public static org.springframework.data.redis.core.HashOperations<String,String,String> hashOps()

valueOps

public static org.springframework.data.redis.core.ValueOperations<String,String> valueOps()

listOps

public static org.springframework.data.redis.core.ListOperations<String,String> listOps()

setOps

public static org.springframework.data.redis.core.SetOperations<String,String> setOps()

zSetOps

public static org.springframework.data.redis.core.ZSetOperations<String,String> zSetOps()

streamOps

public static org.springframework.data.redis.core.StreamOperations<String,String,String> streamOps()

hasKey

@Deprecated
public static boolean hasKey(String key)

已过时。

delete

@Deprecated
public static boolean delete(String key)

已过时。 use del(String)

delete

@Deprecated
public static long delete(Collection<String> keys)

已过时。 use del(Collection)

del

public static boolean del(String key)

删除指定的 key

参数:

key - 要删除的 key

返回:

删除成功返回 true, 如果 key 不存在则返回 false

另请参阅:

Del Command

del

public static long del(String... keys)

删除指定的 keys

参数:

keys - 要删除的 key 数组

返回:

如果删除了一个或多个 key，则为大于 0 的整数，如果指定的 key 都不存在，则为 0

del

public static long del(Collection<String> keys)

exists

public static boolean exists(String key)

判断 key 是否存在

参数:

key - 待判断的 key

返回:

如果 key 存在 true , 否则返回 false

另请参阅:

Exists Command

exists

public static long exists(String... keys)

判断指定的 key 是否存在.

参数:

keys - 待判断的数组

返回:

指定的 keys 在 redis 中存在的的数量

另请参阅:

Exists Command

exists

public static long exists(Collection<String> keys)

expire

public static boolean expire(String key,
                             long timeout)

设置过期时间

参数:

key - 待修改过期时间的 key

timeout - 过期时长，单位 秒

另请参阅:

Expire Command

expire

public static boolean expire(String key,
                             long timeout,
                             TimeUnit timeUnit)

设置过期时间

参数:

key - 待修改过期时间的 key

timeout - 时长

timeUnit - 时间单位

expireAt

public static boolean expireAt(String key,
                               Date date)

设置 key 的过期时间到指定的日期

参数:

key - 待修改过期时间的 key

date - 过期时间

返回:

修改成功返回 true

另请参阅:

ExpireAt Command

expireAt

public static boolean expireAt(String key,
                               Instant expireAt)

keys

public static Set<String> keys(String pattern)

获取所有符合指定表达式的 key

参数:

pattern - 表达式

返回:

java.util.Set

另请参阅:

Keys Command

ttl

public static long ttl(String key)

TTL 命令返回 EXPIRE 命令设置的剩余生存时间（以秒为单位）.。

时间复杂度: O(1)

参数:

key - 待查询的 key

返回:

TTL 以秒为单位，或负值以指示错误

另请参阅:

TTL Command

scan

public static org.springframework.data.redis.core.Cursor<String> scan(org.springframework.data.redis.core.ScanOptions scanOptions)

使用 Cursor 遍历指定规则的 keys

参数:

scanOptions - scan 的配置

返回:

Cursor，一个可迭代对象

另请参阅:

Scan Command

scan

public static org.springframework.data.redis.core.Cursor<String> scan(String patten)

使用 Cursor 遍历指定规则的 keys

参数:

patten - key 的规则

返回:

Cursor，一个可迭代对象

scan

public static org.springframework.data.redis.core.Cursor<String> scan(String patten,
                                                                      long count)

使用 Cursor 遍历指定规则的 keys

参数:

patten - key 的规则

count - 一次扫描获取的 key 数量， 默认为 10

返回:

Cursor，一个可迭代对象

另请参阅:

Scan Command

decr

public static long decr(String key)

当 key 存在时，对其值进行自减操作 （自减步长为 1），当 key 不存在时，则先赋值为 0 再进行自减

参数:

key - key

返回:

自减之后的 value 值

另请参阅:

decrBy(String, long)

decrBy

public static long decrBy(String key,
                          long delta)

当 key 存在时，对其值进行自减操作，当 key 不存在时，则先赋值为 0 再进行自减

参数:

key - key

delta - 自减步长

返回:

自减之后的 value 值

另请参阅:

DecrBy Command

get

public static String get(String key)

获取指定 key 的 value 值

参数:

key - 指定的 key

返回:

当 key 不存在时返回 null

另请参阅:

Get Command

getDel

public static String getDel(String key)

获取指定 key 的 value 值，并将指定的 key 进行删除

参数:

key - 指定的 key

返回:

当 key 不存在时返回 null

另请参阅:

GetDel Command

getEx

public static String getEx(String key,
                           long timeout)

获取指定 key 的 value 值，并对 key 设置指定的过期时间

参数:

key - 指定的 key

timeout - 过期时间，单位时间秒

返回:

当 key 不存在时返回 null

另请参阅:

GetEx Command

getEx

public static String getEx(String key,
                           long timeout,
                           TimeUnit timeUnit)

获取指定 key 的 value 值，并对 key 设置指定的过期时间

参数:

key - 指定的 key

timeout - 过期时间，单位时间秒

timeUnit - 时间单位

返回:

当 key 不存在时返回 null

另请参阅:

GetEx Command

getSet

public static String getSet(String key,
                            String value)

获取指定的 key 的 value 值，并同时使用指定的 value 值进行覆盖操作

参数:

key - 指定的 key

value - 新的 value 值

返回:

当 key 存在时返回其 value 值，否则返回 null

另请参阅:

GetSet Command

incr

public static long incr(String key)

对 key 进行自增，自增步长为 1

参数:

key - 需要自增的 key

返回:

自增后的 value 值

另请参阅:

incrBy(String, long)

incrAndExpire

public static long incrAndExpire(String key,
                                 long timeout)

对 key 进行自增 (步长为 1)，并设置过期时间

另请参阅:

incrByAndExpire(String, long, long)

incrBy

public static long incrBy(String key,
                          long delta)

对 key 进行自增，并指定自增步长, 当 key 不存在时先创建一个值为 0 的 key，再进行自增

参数:

key - 需要自增的 key

delta - 自增的步长

返回:

自增后的 value 值

另请参阅:

IncrBy Command

incrByAndExpire

public static long incrByAndExpire(String key,
                                   long delta,
                                   long timeout)

对 key 进行自增并设置过期时间，指定自增步长, 当 key 不存在时先创建一个值为 0 的 key，再进行自增

参数:

key - 需要自增的 key

delta - 自增的步长

timeout - 过期时间（单位：秒）

返回:

自增后的 value 值

incrByFloat

public static double incrByFloat(String key,
                                 double delta)

另请参阅:

incrBy(String, long)

increment

@Deprecated
public static Long increment(String key)

已过时。 incr(String)

给 key +1

increment

@Deprecated
public static Long increment(String key,
                                          long delta)

已过时。 incrBy(String, long)

给 key 增加 指定数值

incrementAndExpire

@Deprecated
public static Long incrementAndExpire(String key,
                                                   long time)

已过时。 incrAndExpire(String, long)}

incrementAndExpire

@Deprecated
public static Long incrementAndExpire(String key,
                                                   long delta,
                                                   long time)

已过时。 incrByAndExpire(String, long, long)}

mGet

public static List<String> mGet(Collection<String> keys)

从指定的 keys 批量获取 values

参数:

keys - keys

返回:

values list，当值为空时，该 key 对应的 value 为 null

另请参阅:

MGet Command

mGet

public static List<String> mGet(String... keys)

另请参阅:

mGet(Collection)

mGetToMap

public static Map<String,String> mGetToMap(Collection<String> keys)

批量获取 keys 的值，并返回一个 map

参数:

keys - keys

返回:

map，key 和 value 的键值对集合，当 value 获取为 null 时，不存入此 map

mGetToMap

public static Map<String,String> mGetToMap(String... keys)

另请参阅:

mGetToMap(Collection)

multiGet

@Deprecated
public static List<String> multiGet(Collection<String> keys)

已过时。 mGet(Collection)

set

public static void set(String key,
                       String value)

设置 value for key

参数:

key - 指定的 key

value - 值

另请参阅:

Set Command

set

public static void set(String key,
                       String value,
                       long timeout)

设置 value for key, 同时为其设置过期时间

参数:

key - key

value - value

timeout - 过期时间 单位：秒

另请参阅:

setEx(String, String, long)

set

public static void set(String key,
                       String value,
                       long timeout,
                       TimeUnit timeUnit)

设置 value for key, 同时为其设置过期时间

参数:

key - key

value - value

timeout - 过期时间 单位：秒

timeUnit - 过期时间单位

另请参阅:

setEx(String, String, long,TimeUnit)

set

@Deprecated
public static void set(String key,
                                    String val,
                                    Instant instant)

已过时。 {setExAt(String, String, Instant)}

缓存数据

参数:

key - key

val - val

instant - 在指定时间过期

setEx

public static void setEx(String key,
                         String value,
                         long timeout)

设置 value for key, 同时为其设置过期时间

参数:

key - 指定的 key

value - 值

timeout - 过期时间

另请参阅:

SetEx Command

setEx

public static void setEx(String key,
                         String value,
                         long timeout,
                         TimeUnit timeUnit)

设置 value for key, 同时为其设置过期时间

参数:

key - 指定的 key

value - 值

timeout - 过期时间

timeUnit - 时间单位

另请参阅:

SetEx Command

setExAt

public static void setExAt(String key,
                           String value,
                           Instant expireTime)

设置 value for key, 同时为其设置其在指定时间过期

参数:

key - key

value - value

expireTime - 在指定时间过期

setNx

public static boolean setNx(String key,
                            String value)

当 key 不存在时，进行 value 设置，当 key 存在时不执行操作

参数:

key - key

value - value

返回:

boolean

另请参阅:

SetNX Command

setIfAbsent

@Deprecated
public static boolean setIfAbsent(String key,
                                               String value)

已过时。 setNx(String, String)

如果 key 不存在，则设置 key为 val

参数:

key - key

value - val

返回:

boolean

setNxEx

public static boolean setNxEx(String key,
                              String value,
                              long timeout)

当 key 不存在时，进行 value 设置并添加过期时间，当 key 存在时不执行操作

参数:

key - key

value - value

timeout - 过期时间

返回:

boolean 操作是否成功

另请参阅:

SetNX Command

setNxEx

public static boolean setNxEx(String key,
                              String value,
                              long timeout,
                              TimeUnit timeUnit)

当 key 不存在时，进行 value 设置并添加过期时间，当 key 存在时不执行操作

参数:

key - key

value - value

timeout - 过期时间

timeUnit - 时间单位

返回:

boolean 操作是否成功

另请参阅:

SetNX Command

setIfAbsent

@Deprecated
public static boolean setIfAbsent(String key,
                                               String value,
                                               long time)

已过时。 setNxEx(String, String, long)

如果key存在则设置

参数:

key - key

value - 值

time - 过期时间, 单位 秒

返回:

boolean

hDel

public static long hDel(String key,
                        String... fields)

删除指定 hash 的 fields

参数:

key - hash 的 key

fields - hash 元素的 field 集合

返回:

删除的 field 数量

另请参阅:

HDel Command

hExists

public static boolean hExists(String key,
                              String field)

判断指定 hash 的 指定 field 是否存在

参数:

key - hash 的 key

field - 元素的 field

返回:

存在返回 true, 否则返回 false

另请参阅:

HExists Command

hGet

public static String hGet(String key,
                          String field)

获取 hash 中的指定 field 对应的 value 值

参数:

key - hash 的 key

field - 元素的 field

另请参阅:

HGet Command

hGetAll

public static Map<String,String> hGetAll(String key)

获取 hash 中所有的 fields 和 values, 并已键值对的方式返回

参数:

key - hash 的 key

另请参阅:

HGetAll Command

hIncrBy

public static long hIncrBy(String key,
                           String field,
                           long delta)

对 hash 中指定的 field 进行自增

若 field 不存在则，先设置为 0 再进行自增，若 hash 不存在则先创建 hash 再进行上述步骤

参数:

key - key

field - field

delta - 自增步长

返回:

自增后的 value 值

另请参阅:

HIncrBy Command

hIncrBy

public static Long hIncrBy(String key,
                           String field)

对 hash 中指定的 field 进行自增

另请参阅:

hIncrBy(String, String, long)

hIncrByFloat

public static double hIncrByFloat(String key,
                                  String field,
                                  double delta)

对 hash 中指定的 field 进行自增

若 field 不存在则，先设置为 0 再进行自增，若 hash 不存在则先创建 hash 再进行上述步骤

参数:

key - key

field - field

delta - 自增步长

返回:

自增后的 value 值

另请参阅:

HIncrByFloat Command

hKeys

public static Set<String> hKeys(String key)

返回 hash 中的所有 fields

参数:

key - hash 的 key

返回:

Set of fields in hash

另请参阅:

HKeys Command

hLen

public static long hLen(String key)

返回 hash 中 fields 的数量

参数:

key - hash 的 key

返回:

fields size

另请参阅:

HLen Command

hMGet

public static List<String> hMGet(String key,
                                 Collection<String> fields)

返回 hash 中指定 fields 的值集合

参数:

key - hash 的 key

返回:

fields value list, 按传入的 fields 顺序排列

另请参阅:

HKeys Command

hMGet

public static List<String> hMGet(String key,
                                 String... fields)

返回 hash 中指定 fields 的值集合

参数:

key - hash 的 key

返回:

fields value list, 按传入的 fields 顺序排列

另请参阅:

HKeys Command

hSet

public static void hSet(String key,
                        String field,
                        String value)

修改 hash 中的 field 的值，有则覆盖，无则添加

参数:

key - hash 的 key

field - field

value - value

另请参阅:

HSet Command

hashSet

@Deprecated
public static void hashSet(String key,
                                        String field,
                                        String value)

已过时。 hSet(String, String, String)

hSetNx

public static void hSetNx(String key,
                          String field,
                          String value)

修改 hash 中的 field 的值，有则不进行操作，无则添加

参数:

key - hash 的 key

field - field

value - value

另请参阅:

HSetNx Command

hVals

public static List<String> hVals(String key)

返回 hash 中的所有 values

参数:

key - hash 的 key

返回:

List of fields in hash

另请参阅:

HVals Command

hashGet

@Deprecated
public static String hashGet(String key,
                                          String field)

已过时。 hGet(String, String)

获取 指定 key 中 指定 field 的值

参数:

key - key

field - field

返回:

java.lang.Object

hashDelete

@Deprecated
public static Long hashDelete(String key,
                                           String... fields)

已过时。 hDel(String, String...)

移除指定 key中的 字段

参数:

key - key

fields - 字段

返回:

java.lang.Long

lIndex

public static String lIndex(String key,
                            long index)

获取指定 list 指定索引位置的元素

参数:

key - list 的 key

index - 索引位置，0 表示第一个元素，负数索引用于指定从尾部开始计数，-1 表示最后一个元素，-2 倒数第二个

返回:

返回对应索引位置的元素，不存在时为 null

另请参阅:

LIndex Command

listIndex

@Deprecated
public static String listIndex(String key,
                                            long index)

已过时。 lIndex(String, long)

获知指定key中指定索引的值

lLen

public static long lLen(String key)

获取指定 list 的元素个数即长度

参数:

key - list 的 key

返回:

返回 list 的长度，当 list 不存在时返回 0

另请参阅:

LLen Command

listSize

@Deprecated
public static long listSize(String key)

已过时。 lLen(String)

lPop

public static String lPop(String key)

以原子方式返回并删除列表的第一个元素，例如列表包含元素 "a", "b", "c" LPOP 操作将返回 ”a“ 并将其删除，list 中元素变为 ”b“, "c"

参数:

key - list 的 key

返回:

返回弹出的元素

另请参阅:

LPop Command

lPop

public static List<String> lPop(String key,
                                long count)

以原子方式返回并删除列表的多个元素

参数:

key - list 的 key

count - 弹出的个数

返回:

返回弹出的元素列表，key 不存在时为 null

从以下版本开始:

Redis 版本大于等于 6.2.0

另请参阅:

LPop Command

listLeftPop

@Deprecated
public static String listLeftPop(String key)

已过时。 lPop(String)

lPos

public static Long lPos(String key,
                        String element)

该命令返回 list 匹配元素的索引。它会从头到尾扫描列表，寻找 “element” 的第一个匹配项。

参数:

key - list 的 key

element - 查找的元素

返回:

指定元素正向第一个匹配项的索引，如果找不到，返回 null

从以下版本开始:

Redis 版本大于等于 6.0.6

另请参阅:

LPos Command

listIndexOf

@Deprecated
public static Long listIndexOf(String key,
                                            String val)

已过时。 lPos(String, String)

获取指定值在指定key中的索引

lPush

public static long lPush(String key,
                         String... elements)

将指定的元素插入 list 的头部，若 list 不存在，则先指向创建一个空的 list

参数:

key - list 的 key

elements - 插入的元素

返回:

插入后的 list 长度

另请参阅:

LPush Command

lPush

public static long lPush(String key,
                         List<String> elements)

将指定的值插入 list 的头部，若 list 不存在，则先指向创建一个空的 list

参数:

key - list 的 key

elements - 插入的元素

返回:

插入后的 list 长度

另请参阅:

LPush Command

listLeftPush

@Deprecated
public static Long listLeftPush(String key,
                                             String val)

已过时。 lPush(String, String...)

插入列表

参数:

key - key

val - val

lRange

public static List<String> lRange(String key,
                                  long start,
                                  long end)

获取 list 指定 offset 间的元素。

参数:

key - list 的 key

start - begin offset, 从 0 开始，0 表示列表第一个元素，也可以为负数，表示从 list 末尾开始的偏移量， -1 是列表最后第一个元素

end - end offset，值规则 同 start

返回:

元素集合

另请参阅:

LRange Command

listGet

@Deprecated
public static List<String> listGet(String key)

已过时。 use lRange(key, 0, -1) lRange(String, long, long)

获取 list 中的所有元素

lRem

public static long lRem(String key,
                        long count,
                        String value)

删除 list 中的元素

• count > 0: 从 list 头部向尾部查找并删除 n 个和指定值相等的元素，n 为 count
• count < 0: 从 list 尾部向头部查找并删除 n 个和指定值相等的元素，n 为 count 的绝对值
• count = 0: 删除 list 中所有和指定值相等的元素

参数:

key - list 的 key

count - 删除的数量以及规则

value - 待删除的元素值

返回:

移除元素的数量

另请参阅:

LRem Command

listRemove

@Deprecated
public static Long listRemove(String key,
                                           String val)

已过时。

use lrem(key, 1, value) lRem(String, long, String)

listRemove

@Deprecated
public static Long listRemove(String key,
                                           long count,
                                           String val)

已过时。

参数:

count - 删除多少个

listSet

@Deprecated
public static long listSet(String key,
                                        List<String> list,
                                        long time)

已过时。

插入list 并设置过期时间

参数:

key - key

list - list 值

time - 过期时间

返回:

long

lSet

public static void lSet(String key,
                        long index,
                        String value)

将 list 指定 index 位置的元素设置为当前值

参数:

key - list 的 key

index - 索引位置，0 表示第一个元素，负数索引用于指定从尾部开始计数，-1 表示最后一个元素，-2 倒数第二个

value - 值

另请参阅:

LSet Command

lTrim

public static void lTrim(String key,
                         long start,
                         long end)

裁剪 list，只保留 start 到 end 之间的元素值，包含 start 和 end

参数:

key - list 的 key

start - 开始索引位置，0 表示第一个元素，负数索引用于指定从尾部开始计数，-1 表示最后一个元素，-2 倒数第二个

end - 结束的索引位置

另请参阅:

LTrim Command

rPop

public static String rPop(String key)

以原子方式返回并删除列表的最后一个元素。

例如 list 包含元素 "a"、"b"、"c", RPOP 操作将返回 ”c“ 并将其删除，list 中元素变为 ”a“, "b"

参数:

key - list 的 key

返回:

弹出的元素

另请参阅:

RPOP Command

rPop

public static List<String> rPop(String key,
                                long count)

从 list 尾部，以原子方式返回并删除列表中指定数量的元素。

参数:

key - list 的 key

count - 待弹出的元素数量

返回:

弹出的元素集合

从以下版本开始:

Redis 6.2.0

另请参阅:

RPOP Command

rPush

public static long rPush(String key,
                         String... values)

将指定的值插入 list 的尾部，若 list 不存在，则先指向创建一个空的 list

参数:

key - list 的 key

values - 插入的元素

返回:

插入后的 list 长度

另请参阅:

RPush Command

rPush

public static long rPush(String key,
                         List<String> values)

将指定的值插入 list 的尾部，若 list 不存在，则先指向创建一个空的 list

参数:

key - list 的 key

values - 插入的元素

返回:

插入后的 list 长度

另请参阅:

RPush Command

listRightPush

@Deprecated
public static Long listRightPush(String key,
                                              String val)

已过时。 rPush(String, String...)

listRightPop

@Deprecated
public static String listRightPop(String key)

已过时。 rPop(String)

sAdd

public static long sAdd(String key,
                        String... members)

将指定的 member 添加到 Set 中，如果 Set 中已有该 member 则忽略。如果 Set 不存在，则先创建一个新的 Set，再进行添加

Time complexity O(1)

参数:

key - Set 的 key

members - 添加的成员

返回:

添加到集合中的元素数量，不包括集合中已经存在的所有元素

另请参阅:

SAdd Command

sAdd

public static long sAdd(String key,
                        List<String> members)

将指定的 member 添加到 Set 中，如果 Set 中已有该 member 则忽略。如果 Set 不存在，则先创建一个新的 Set，再进行添加

Time complexity O(1)

参数:

key - Set 的 key

members - 添加的成员

返回:

添加到集合中的元素数量，不包括集合中已经存在的所有元素

另请参阅:

SAdd Command

setAdd

@Deprecated
public static Long setAdd(String key,
                                       String... values)

已过时。 sAdd(String, String...)

Set中添加数据

sCard

public static long sCard(String key)

返回 Set 中的元素数，如果 set 不存在则返回 0

参数:

key - Set 的 key

返回:

The cardinality (number of elements) of the set

另请参阅:

SCard Command

setSize

@Deprecated
public static Long setSize(String key)

已过时。 sCard(String)

获取集合中元素数量

sIsMember

public static boolean sIsMember(String key,
                                String value)

判断指定的值是否是 Set 中的元素

Time complexity O(1)

参数:

key - Set 的 key

value - 待判断的值

返回:

如果是 Set 中的元素返回true, 否则返回false

另请参阅:

SIsMember Command

sMembers

public static Set<String> sMembers(String key)

获取 Set 中的所有元素

Time complexity O(N)

参数:

key - Set 的 key

返回:

Set 中的所有元素

另请参阅:

SMembers Command

sMIsMember

public static Map<Object,Boolean> sMIsMember(String key,
                                             String... values)

判断指定的值是否是 Set 中的元素

Time complexity O(N)

参数:

key - Set 的 key

values - 待判断的值集合

返回:

一个 Map, key 为待判断的值，value 为结果

从以下版本开始:

Redis 6.2.0

另请参阅:

SMIsMember Command

sPop

public static String sPop(String key)

随机从 Set 中删除一个元素，并返回它，如果 Set 为空，则返回 null

Time complexity O(1)

参数:

key - Set 的 key

返回:

弹出的元素，或者 null

另请参阅:

SPop Command

setPop

@Deprecated
public static String setPop(String key)

已过时。 sPop(String)

随机弹出一个元素

sRandMember

public static String sRandMember(String key)

随机从 Set 中返回一个元素，但不删除，如果 Set 为空，则返回 null

Time complexity O(1)

参数:

key - Set 的 key

返回:

随机选中的元素或者 null

另请参阅:

SRandMember Command

sRandMember

public static Set<String> sRandMember(String key,
                                      long count)

随机从 Set 中返回 count 个元素，但不删除，如果 Set 为空，则返回 null

Time complexity O(1)

参数:

key - Set 的 key

count - 随机返回的元素数量

返回:

随机选中的元素或者 null

另请参阅:

SRandMember Command

sRem

public static long sRem(String key,
                        String... members)

从 Set 中删除指定的 member，如果给的值不是 Set 的 member 则不进行操作

Time complexity O(1)

参数:

key - Set 的 key

members - 待删除的成员

返回:

The number of members that were removed from the set, not including non-existing members

另请参阅:

SRem Command

setRemove

@Deprecated
public static Long setRemove(String key,
                                          String... values)

已过时。 sRem(String, String...)

移除集合中的元素

sScan

public static org.springframework.data.redis.core.Cursor<String> sScan(String key,
                                                                       org.springframework.data.redis.core.ScanOptions scanOptions)

使用 Cursor 遍历指定 Set 中的所有元素

参数:

scanOptions - scan 的配置

返回:

Cursor，一个可迭代对象

另请参阅:

SScan Command

zAdd

public static boolean zAdd(String key,
                           double score,
                           String member)

添加拥有指定 score 的 member 到 Sorted Set 中。如果 member 在 Sorted Set 中已存在，则更新 score，并进行重排序。 如果 key 不存在，则先创建一个空的 Sorted Set 再进行添加操作。

Time complexity O(log(N)) with N being the number of elements in the sorted set

参数:

key - Sorted Set 的 key

score - 分数

member - 成员

返回:

当元素被成功添加时返回 true，当元素存在时返回 false（分数会更新）

另请参阅:

ZAdd Command

zAdd

public static long zAdd(String key,
                        Map<String,Double> scoreMembers)

批量添加拥有指定 score 的 member 到 Sorted Set 中。如果 member 在 Sorted Set 中已存在，则更新 score，并进行重排序。 如果 key 不存在，则先创建一个空的 Sorted Set 再进行添加操作。

Time complexity O(log(N)) with N being the number of elements in the sorted set

参数:

key - Sorted Set 的 key

scoreMembers - 成员和分数的键值对

返回:

返回被成功添加的成员数

另请参阅:

ZAdd Command

zSetAdd

@Deprecated
public static Boolean zSetAdd(String key,
                                           String value,
                                           double score)

已过时。 zAdd(String, double, String)

zset中添加数据

zCard

public static long zCard(String key)

返回 Sorted Set 的元素数量，若 key 不存在则返回 0

Time complexity O(1)

参数:

key - Sorted Set 的 key

返回:

Sorted Set 中的元素数量

另请参阅:

ZCard Command

zSetSize

@Deprecated
public static Long zSetSize(String key)

已过时。 zCard(String)

获取有序集合中元素数量

zIncrBy

public static double zIncrBy(String key,
                             double increment,
                             String member)

如果 member 存在于 Sorted Set 中，则对其 score 和 increment 进行相加运算，并重排序。
如果 member 不存在，则先添加一个 score 为 0 的 member 再进行相加操作。
如果 key 不存在，则先创建一个 Sorted Set，再进行上述操作。

Time complexity O(log(N)) with N being the number of elements in the sorted set

参数:

key - Sorted Set 的 key

increment - 增长步长，可以为负数

member - 成员

返回:

The new score

另请参阅:

ZIncrBy Command

zPopMax

public static org.springframework.data.redis.core.ZSetOperations.TypedTuple<String> zPopMax(String key)

返回并删除 Sorted Set 中分数最高的那个元素

Time complexity O(log(N)) with N being the number of elements in the sorted set

参数:

key - Sorted Set 的 key

返回:

弹出的 member 和 score

从以下版本开始:

Redis 5.0.0

另请参阅:

ZPopMax Command

zPopMax

public static Set<org.springframework.data.redis.core.ZSetOperations.TypedTuple<String>> zPopMax(String key,
                                                                                                 long count)

返回并删除 Sorted Set 中分数最高的 n 个元素

Time complexity O(log(N)) with N being the number of elements in the sorted set

参数:

key - Sorted Set 的 key

count - 弹出的个数

返回:

弹出的 member 和 score

从以下版本开始:

Redis 5.0.0

另请参阅:

ZPopMax Command

zPopMin

public static org.springframework.data.redis.core.ZSetOperations.TypedTuple<String> zPopMin(String key)

返回并删除 Sorted Set 中分数最低的那个元素

Time complexity O(log(N)) with N being the number of elements in the sorted set

参数:

key - Sorted Set 的 key

返回:

弹出的 member 和 score

从以下版本开始:

Redis 5.0.0

另请参阅:

ZPopMin Command

zPopMin

public static Set<org.springframework.data.redis.core.ZSetOperations.TypedTuple<String>> zPopMin(String key,
                                                                                                 long count)

返回并删除 Sorted Set 中分数最低的 n 个元素

Time complexity O(log(N)) with N being the number of elements in the sorted set

参数:

key - Sorted Set 的 key

count - 弹出的个数

返回:

弹出的 member 和 score

从以下版本开始:

Redis 5.0.0

另请参阅:

ZPopMin Command

zRandMember

public static String zRandMember(String key)

随机从 Sorted Set 中返回一个 member

Time complexity O(N) where N is the number of elements returned

参数:

key - Sorted Set 的 Key

返回:

Random String from the set

从以下版本开始:

Redis 6.2.0

另请参阅:

ZRandMember Command

zSetRandom

@Deprecated
public static String zSetRandom(String key)

已过时。 zRandMember(String)

随机弹出一个元素

zRange

public static Set<String> zRange(String key,
                                 long start,
                                 long end)

返回 Sorted Set 中指定索引范围内的 member.

Time complexity O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements returned.

参数:

key - the key to query

start - the minimum index

end - the maximum index

返回:

A Set of Strings in the specified range

另请参阅:

ZRange Command

zRangeByScore

public static Set<String> zRangeByScore(String key,
                                        double min,
                                        double max)

返回 Sorted Set 中指定 score 间的所有元素（包括 score 等于 min 和 max 的元素）

Time complexity O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned.

参数:

key - the key to query

min - minimum score

max - maximum score

返回:

A List of elements in the specified score range

另请参阅:

ZRangeByScore Command

zRangeByScore

public static Set<String> zRangeByScore(String key,
                                        double min,
                                        double max,
                                        long offset,
                                        long count)

返回 Sorted Set 中指定 score 间的所有元素（包括 score 等于 min 和 max 的元素）

参数:

key - the key to query

min - minimum score

max - maximum score

offset - 偏移量

count - 获取的元素数

返回:

A List of elements in the specified score range

另请参阅:

ZRangeByScore Command

zRangeByScoreWithScores

public static Set<org.springframework.data.redis.core.ZSetOperations.TypedTuple<String>> zRangeByScoreWithScores(String key,
                                                                                                                 double min,
                                                                                                                 double max)

返回 Sorted Set 中指定 score 间的所有元素和其分数（包括 score 等于 min 和 max 的元素）

参数:

key - the key to query

min - minimum score

max - maximum score

返回:

A List of elements in the specified score range

另请参阅:

ZRangeByScore Command

zRank

public static Long zRank(String key,
                         String member)

返回 member 的排名（索引）。排名从 0 开始，按分数从低到高的顺序.

Time complexity O(log(N))

参数:

key - Sorted Set 的 key

member - 成员

返回:

如果 member 存在的话返回其排名，否则返回 null

另请参阅:

ZRank Command

zRem

public static long zRem(String key,
                        String... members)

从 Sorted Set 中删除指定的 member。不存在的 member 将被忽略。

Time complexity O(log(N)) with N being the number of elements in the sorted set

参数:

key - Sorted Set 的 key

members - 待删除的成员

返回:

从排序集中删除的 member 数，不包括不存在的 member 数

另请参阅:

ZRem Command

zSetRemove

@Deprecated
public static Long zSetRemove(String key,
                                           String... values)

已过时。 zRem(String, String...)

移除有序集合中的元素

zSetRank

@Deprecated
public static Long zSetRank(String key,
                                         String value)

已过时。 zRank(String, String)

在有序集合中的排名

zRevRange

public static Set<String> zRevRange(String key,
                                    long start,
                                    long end)

返回 Sorted Set 中 index 在 start 和 end 之前的所有成员（包括 start 和 end）。

与默认的排序规则相反，元素的顺序是按分数从高到低进行的，具有相同分数的元素以相反的字典顺序排序

Time complexity O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements returned.

参数:

key - the key to query

start - the minimum index

end - the maximum index

返回:

A List of Strings in the specified range

另请参阅:

ZRevRange Commad

zRevRangeByScore

public static Set<String> zRevRangeByScore(String key,
                                           double min,
                                           double max)

返回 Sorted Set 中分数在 min 和 max 之前的所有成员（包括 min 和 max）。

与默认的排序规则相反，元素的顺序是按分数从高到低进行的。

具有相同分数的元素以相反的字典顺序返回.

Time complexity O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned.

参数:

key - the key to query

min - minimum score

max - maximum score

返回:

A List of elements in the specified score range

另请参阅:

ZRevRangeByScore Commad

zScore

public static Double zScore(String key,
                            String member)

返回 Sorted Set 中指定 member 的分数。如果指定的 member 在 Sorted Set 中不存在，或者 Key 根本不存在，则返回 null。

Time complexity: O(1)

参数:

key - Sorted Set Key

member - Sorted Set Member

返回:

the score

另请参阅:

ZSCORE Commad

zSetRange

@Deprecated
public static Set<String> zSetRange(String key,
                                                 int start,
                                                 int end)

已过时。 zRange(String, long, long)

在有序集合中的排名, 从小到大

zSetReverseRange

@Deprecated
public static Set<String> zSetReverseRange(String key,
                                                        int start,
                                                        int end)

已过时。 zRevRange(String, long, long)

在有序集合中的排名, 从大到小

zSetRangeByScore

@Deprecated
public static Set<String> zSetRangeByScore(String key,
                                                        double min,
                                                        double max)

已过时。 zRangeByScore(String, double, double)

在有序集合中的排名, 分数区间, 从小到大

zSetReverseRangeByScore

@Deprecated
public static Set<String> zSetReverseRangeByScore(String key,
                                                               double min,
                                                               double max)

已过时。 zRevRangeByScore(String, double, double)

在有序集合中的排名, 分数区间, 从大到小

execute

public static <T> T execute(org.springframework.data.redis.core.RedisCallback<T> action)

执行 lua脚本

参数:

action - redis 操作

返回:

T

execute

@Nullable
public static <T> T execute(org.springframework.data.redis.core.RedisCallback<T> action,
                                       boolean exposeConnection)

execute

@Nullable
public static <T> T execute(org.springframework.data.redis.core.RedisCallback<T> action,
                                       boolean exposeConnection,
                                       boolean pipeline)

execute

public static <T> T execute(org.springframework.data.redis.core.SessionCallback<T> session)

execute

public static <T> T execute(org.springframework.data.redis.core.script.RedisScript<T> script,
                            List<String> keys,
                            Object... args)

execute

public static <T> T execute(org.springframework.data.redis.core.script.RedisScript<T> script,
                            org.springframework.data.redis.serializer.RedisSerializer<?> argsSerializer,
                            org.springframework.data.redis.serializer.RedisSerializer<T> resultSerializer,
                            List<String> keys,
                            Object... args)

evalLua

@Deprecated
public static Object evalLua(String lua,
                                          List<String> key,
                                          Object... argv)

已过时。 RedisScript 应该做为单例，而不是每次生成，不推荐直接使用此方法

executePipelined

public static List<Object> executePipelined(org.springframework.data.redis.core.SessionCallback<?> session)

executePipelined

public static List<Object> executePipelined(org.springframework.data.redis.core.SessionCallback<?> session,
                                            @Nullable
                                            org.springframework.data.redis.serializer.RedisSerializer<?> resultSerializer)

executePipelined

public static List<Object> executePipelined(org.springframework.data.redis.core.RedisCallback<?> action)

executePipelined

public static List<Object> executePipelined(org.springframework.data.redis.core.RedisCallback<?> action,
                                            @Nullable
                                            org.springframework.data.redis.serializer.RedisSerializer<?> resultSerializer)

publish

public static void publish(String channel,
                           String message)

Publish 一条消息

参数:

channel - 渠道

message - 消息

publish

public static void publish(String channel,
                           byte[] message)

Publish 一条消息

参数:

channel - 渠道

message - 消息

xAck

public static long xAck(String key,
                        String group,
                        String... ids)

XACK key group ID [ID ...]

参数:

key - key of stream

group - consume group

ids - record ids

从以下版本开始:

Redis 5.0.0

另请参阅:

XACK Command

xAck

public static long xAck(String key,
                        String group,
                        org.springframework.data.redis.connection.stream.RecordId... ids)

xAdd

public static org.springframework.data.redis.connection.stream.RecordId xAdd(String key,
                                                                             Map<String,String> content)

XADD key ID field string [field string ...]

参数:

key - key of stream

content - record content

返回:

the ID of the added entry

从以下版本开始:

Redis 5.0.0

另请参阅:

XADD Command

xAdd

public static org.springframework.data.redis.connection.stream.RecordId xAdd(String key,
                                                                             Map<String,String> content,
                                                                             org.springframework.data.redis.connection.RedisStreamCommands.XAddOptions xAddOptions)

xAdd

public static org.springframework.data.redis.connection.stream.RecordId xAdd(org.springframework.data.redis.connection.stream.MapRecord<String,String,String> mapRecord,
                                                                             org.springframework.data.redis.connection.RedisStreamCommands.XAddOptions xAddOptions)

xDel

public static long xDel(String key,
                        String... ids)

XDEL key ID [ID ...]

参数:

key - key of stream

ids - record ids

从以下版本开始:

Redis 5.0.0

另请参阅:

XDEL Command

xDel

public static long xDel(String key,
                        org.springframework.data.redis.connection.stream.RecordId... ids)

xGroupCreate

public static String xGroupCreate(String key,
                                  String groupName,
                                  org.springframework.data.redis.connection.stream.ReadOffset readOffset,
                                  boolean makeStream)

XGROUP CREATE

参数:

key - key of stream

groupName - group name

从以下版本开始:

Redis 5.0.0

另请参阅:

XGROUP CREATE Command

xGroupCreate

public static String xGroupCreate(String key,
                                  String groupName)

xLen

public static long xLen(String key)

XLEN key

参数:

key - key of stream

返回:

length of stream

从以下版本开始:

Redis 5.0.0

另请参阅:

XLEN Command

xRange

public static List<org.springframework.data.redis.connection.stream.MapRecord<String,String,String>> xRange(String key,
                                                                                                            org.springframework.data.domain.Range<String> range)

XRANGE key start end COUNT count

参数:

key - key of stream

range - start and end

返回:

The entries with IDs matching the specified range.

从以下版本开始:

Redis 5.0.0

另请参阅:

XRANGE Command

xRange

public static List<org.springframework.data.redis.connection.stream.MapRecord<String,String,String>> xRange(String key,
                                                                                                            org.springframework.data.domain.Range<String> range,
                                                                                                            org.springframework.data.redis.connection.RedisZSetCommands.Limit limit)

xRead

public static List<org.springframework.data.redis.connection.stream.MapRecord<String,String,String>> xRead(org.springframework.data.redis.connection.stream.StreamOffset<String>... streams)

XREAD [COUNT count] [BLOCK milliseconds] STREAMS key [key ...] ID [ID ...]

从以下版本开始:

Redis 5.0.0

另请参阅:

XREAD Command

xRead

public static List<org.springframework.data.redis.connection.stream.MapRecord<String,String,String>> xRead(org.springframework.data.redis.connection.stream.StreamReadOptions streamReadOptions,
                                                                                                           org.springframework.data.redis.connection.stream.StreamOffset<String>... streams)

xReadGroup

public static List<org.springframework.data.redis.connection.stream.MapRecord<String,String,String>> xReadGroup(org.springframework.data.redis.connection.stream.Consumer consumer,
                                                                                                                org.springframework.data.redis.connection.stream.StreamOffset<String>... streams)

XREADGROUP GROUP group consumer [COUNT count] [BLOCK milliseconds] [NOACK] STREAMS key [key ...] id [id ...]

从以下版本开始:

Redis 5.0.0

另请参阅:

XREADGROUP Command

xReadGroup

public static List<org.springframework.data.redis.connection.stream.MapRecord<String,String,String>> xReadGroup(org.springframework.data.redis.connection.stream.Consumer consumer,
                                                                                                                org.springframework.data.redis.connection.stream.StreamReadOptions streamReadOptions,
                                                                                                                org.springframework.data.redis.connection.stream.StreamOffset<String>... streams)

xReadGroup

public static List<org.springframework.data.redis.connection.stream.MapRecord<String,String,String>> xReadGroup(String group,
                                                                                                                String consumer,
                                                                                                                org.springframework.data.redis.connection.stream.StreamOffset<String>... streams)

xReadGroup

public static List<org.springframework.data.redis.connection.stream.MapRecord<String,String,String>> xReadGroup(String group,
                                                                                                                String consumer,
                                                                                                                org.springframework.data.redis.connection.stream.StreamReadOptions streamReadOptions,
                                                                                                                org.springframework.data.redis.connection.stream.StreamOffset<String>... streams)