cn.sanenen.utils.redis

类 JedisUtil

java.lang.Object

cn.sanenen.utils.redis.JedisUtil

public class JedisUtil
extends Object

redis工具类

字段概要

字段

限定符和类型	字段和说明
protected cn.hutool.log.Log	log

构造器概要

构造器

构造器和说明
JedisUtil(redis.clients.jedis.JedisPool jedisPool)
JedisUtil(cn.hutool.db.nosql.redis.RedisDS redisDS)

方法概要

限定符和类型	方法和说明
void	close()
Long	decr(String key) 将 key 中储存的数字值减一。
Long	decrBy(String key, long decrement) 将 key 所储存的值减去减量 decrement 。
Long	del(String... keys) 删除key
Boolean	exists(String key) 判断key是否存在
Long	expire(String key, Long seconds) 设置过期时间
String	get(String key) 获取值
protected redis.clients.jedis.Jedis	getJedis()
String	getSet(String key, String value) 将给定 key 的值设为 value ，并返回 key 的旧值(old value)。
Long	hdecrBy(String key, String hKey, long decrement) 将 hashKey 所储存的值减去减量 decrement 。
Long	hdel(String key, List<String> fields) 批量通道模式删除
Long	hdel(String key, String field)
Boolean	hexists(String key, String field) 查看哈希表 key 中，给定域 field 是否存在。
String	hget(String key, String field)
Map<String,String>	hgetAll(String key)
Long	hincrBy(String key, String field, long value) 为哈希表 key 中的域 field 的值加上增量 increment 。
Set<String>	hkeys(String key) 返回哈希表 key 中的所有域。
List<Map.Entry<String,String>>	hkeys(String key, String keys) hash结构 key模糊查找
Long	hlen(String key) 返回哈希表 key 中域的数量。
long	hLimit(String key, String field, long limitCount) hash结构控制并发或频次
redis.clients.jedis.resps.ScanResult<Map.Entry<String,String>>	hscan(String key, String cursor, int count, String pattern) 迭代哈希表中的键值对。
Long	hset(String key, String field, String value) 将哈希表 key 中的域 field 的值设为 value 。
Long	hsetnx(String key, String field, String value) 将哈希表 key 中的域 field 的值设置为 value ，当且仅当域 field 不存在。
List<String>	hvals(String key) 返回哈希表 key 中所有域的值。
<T> List<T>	hvals(String key, Class<T> clazz) 获取hash结构所有值，并转换为对象集合
Long	incr(String key) 将 key 中储存的数字值增一。
Long	incrBy(String key, long increment) 将 key 所储存的值加上增量 increment 。
Set<String>	keys(String keys) key模糊查找
boolean	lock(String lockKey, String appId) 获取分布式锁
boolean	lock(String lockKey, String appId, long expireTime) 获取分布式锁
<T> Long	lpush(String key, List<T> objects) 批量放入队列数据
<T> Long	lpush(String key, T t) 放入队列数据
List<String>	lrangeAll(String key) 获取list结构所有值
<T> List<T>	lrangeAll(String key, Class<T> clazz) 获取list结构所有值
void	releaseLock(String lockKey, String appId) 释放分布式锁
Long	renamenx(String oldkey, String newkey) 重命名key
<T> T	rpop(String key, Class<T> clazz) 从队列中取出数据。
<T> List<T>	rpop(String key, int count, Class<T> clazz) 批量从队列中取出数据 6.0以上版本
<T> List<T>	rpopByLua(String key, long count, Class<T> clazz) 批量从队列中取出数据，使用lua脚本方式。
<T> List<T>	rpopByPip(String key, long count, Class<T> clazz) 批量从队列中取出数据，使用管道方式。
void	sadd(String key, String... member) 将一个或多个 member 元素加入到集合 key 当中，已经存在于集合的 member 元素将被忽略。
redis.clients.jedis.resps.ScanResult<String>	scan(String cursor, int count, String pattern) key模糊查找
Long	scard(String key) 返回集合 key 的基数(集合中元素的数量)。
void	set(String key, String value) 设置值
void	setex(String key, long seconds, String value) 将值 value 关联到 key ，并将 key 的生存时间设为 seconds (以秒为单位)。
Long	setnx(String key, String value) 将 key 的值设为 value ，当且仅当 key 不存在。
Boolean	sismember(String key, String member) 判断 member 元素是否集合 key 的成员。
Long	srem(String key, String... member) 移除集合 key 中的一个或多个 member 元素，不存在的 member 元素会被忽略。
Long	ttl(String key) 查询key过期时间

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

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

字段详细资料

log

protected final cn.hutool.log.Log log

构造器详细资料

JedisUtil

public JedisUtil(redis.clients.jedis.JedisPool jedisPool)

JedisUtil

public JedisUtil(cn.hutool.db.nosql.redis.RedisDS redisDS)

方法详细资料

close

public void close()

getJedis

protected redis.clients.jedis.Jedis getJedis()

del

public Long del(String... keys)

删除key

参数:

keys - key

exists

public Boolean exists(String key)

判断key是否存在

参数:

key - key

expire

public Long expire(String key,
                   Long seconds)

设置过期时间

参数:

key - key

seconds - 过期时间 秒

renamenx

public Long renamenx(String oldkey,
                     String newkey)

重命名key

参数:

oldkey - oldkey

newkey - newkey

返回:

修改成功时，返回 1 。如果 newkey 已经存在，返回 0 。

ttl

public Long ttl(String key)

查询key过期时间

参数:

key - key

返回:

如果未设置过期时间则返回-1，如果密钥不存在，则返回-2

get

public String get(String key)

获取值

参数:

key - key

set

public void set(String key,
                String value)

设置值

参数:

key - key

setex

public void setex(String key,
                  long seconds,
                  String value)

将值 value 关联到 key ，并将 key 的生存时间设为 seconds (以秒为单位)。

参数:

key - key

setnx

public Long setnx(String key,
                  String value)

将 key 的值设为 value ，当且仅当 key 不存在。

参数:

key - key

返回:

设置成功，返回 1 。设置失败，返回 0 。

decr

public Long decr(String key)

将 key 中储存的数字值减一。

参数:

key - key

返回:

执行 DECR 命令之后 key 的值。

decrBy

public Long decrBy(String key,
                   long decrement)

将 key 所储存的值减去减量 decrement 。

参数:

key - key

返回:

减去 decrement 之后， key 的值。

incr

public Long incr(String key)

将 key 中储存的数字值增一。

参数:

key - key

返回:

执行 INCR 命令之后 key 的值。

incrBy

public Long incrBy(String key,
                   long increment)

将 key 所储存的值加上增量 increment 。

参数:

key - key

返回:

加上 increment 之后， key 的值。

getSet

public String getSet(String key,
                     String value)

将给定 key 的值设为 value ，并返回 key 的旧值(old value)。

参数:

key - key

hdel

public Long hdel(String key,
                 String field)

参数:

key - key

返回:

如果存在则删除该字段并返回1，否则返回0

hdel

public Long hdel(String key,
                 List<String> fields)

批量通道模式删除

参数:

key - key

返回:

如果存在则删除该字段并返回1，否则返回0

hexists

public Boolean hexists(String key,
                       String field)

查看哈希表 key 中，给定域 field 是否存在。

参数:

key - key

field - 小key

hget

public String hget(String key,
                   String field)

参数:

key - key

field - 小key

hgetAll

public Map<String,String> hgetAll(String key)

参数:

key - key

hincrBy

public Long hincrBy(String key,
                    String field,
                    long value)

为哈希表 key 中的域 field 的值加上增量 increment 。

参数:

key - key

返回:

执行 HINCRBY 命令之后，哈希表 key 中域 field 的值。

hkeys

public Set<String> hkeys(String key)

返回哈希表 key 中的所有域。

参数:

key - key

hlen

public Long hlen(String key)

返回哈希表 key 中域的数量。

参数:

key - key

hset

public Long hset(String key,
                 String field,
                 String value)

将哈希表 key 中的域 field 的值设为 value 。

参数:

key - key

hsetnx

public Long hsetnx(String key,
                   String field,
                   String value)

将哈希表 key 中的域 field 的值设置为 value ，当且仅当域 field 不存在。

参数:

key - key

hvals

public List<String> hvals(String key)

返回哈希表 key 中所有域的值。

参数:

key - key

sadd

public void sadd(String key,
                 String... member)

将一个或多个 member 元素加入到集合 key 当中，已经存在于集合的 member 元素将被忽略。

参数:

key - key

scard

public Long scard(String key)

返回集合 key 的基数(集合中元素的数量)。

参数:

key - key

sismember

public Boolean sismember(String key,
                         String member)

判断 member 元素是否集合 key 的成员。

参数:

key - key

srem

public Long srem(String key,
                 String... member)

移除集合 key 中的一个或多个 member 元素，不存在的 member 元素会被忽略。

参数:

key - key

rpop

public <T> T rpop(String key,
                  Class<T> clazz)

从队列中取出数据。

参数:

key - key

clazz - 需要被转换的对象

rpop

public <T> List<T> rpop(String key,
                        int count,
                        Class<T> clazz)

批量从队列中取出数据 6.0以上版本

参数:

key - key

count - 查询出条数

clazz - 需要被转换的对象

rpopByPip

public <T> List<T> rpopByPip(String key,
                             long count,
                             Class<T> clazz)

批量从队列中取出数据，使用管道方式。

参数:

key - key

count - 查询出条数

clazz - 需要被转换的对象

rpopByLua

public <T> List<T> rpopByLua(String key,
                             long count,
                             Class<T> clazz)

批量从队列中取出数据，使用lua脚本方式。 注意：因为事务关系，单次数量不宜太多。

参数:

key - key

count - 查询出条数

clazz - 需要被转换的对象

lpush

public <T> Long lpush(String key,
                      List<T> objects)

批量放入队列数据

参数:

key - key

lpush

public <T> Long lpush(String key,
                      T t)

放入队列数据

参数:

key - key

hscan

public redis.clients.jedis.resps.ScanResult<Map.Entry<String,String>> hscan(String key,
                                                                            String cursor,
                                                                            int count,
                                                                            String pattern)

迭代哈希表中的键值对。

参数:

key - 大key

cursor - 光标。等于 ScanParams.SCAN_POINTER_START 时，说明数据已读完。

count - 查询出条数

pattern - 如 * ，pre_*

scan

public redis.clients.jedis.resps.ScanResult<String> scan(String cursor,
                                                         int count,
                                                         String pattern)

key模糊查找

参数:

cursor - 光标。等于 ScanParams.SCAN_POINTER_START 时，说明数据已读完。

count - 查询出条数

pattern - 如 * ，pre_*

hkeys

public List<Map.Entry<String,String>> hkeys(String key,
                                            String keys)

hash结构 key模糊查找

参数:

keys - 要查找的key 例: aaa* ,aaa开头的所有key

返回:

匹配到的key

keys

public Set<String> keys(String keys)

key模糊查找

参数:

keys - 要查找的key 例: aaa* ,aaa开头的所有key

返回:

匹配到的key

hdecrBy

public Long hdecrBy(String key,
                    String hKey,
                    long decrement)

将 hashKey 所储存的值减去减量 decrement 。

参数:

key - key

hKey - hashKey（小key）

decrement - 减量

返回:

减去 decrement 之后， key 的值。

hvals

public <T> List<T> hvals(String key,
                         Class<T> clazz)

获取hash结构所有值，并转换为对象集合

参数:

key - key

clazz - 对象class

返回:

结果集

lrangeAll

public List<String> lrangeAll(String key)

获取list结构所有值

参数:

key - key

返回:

结果集

lrangeAll

public <T> List<T> lrangeAll(String key,
                             Class<T> clazz)

获取list结构所有值

参数:

key - key

clazz - 对象class

返回:

结果集

lock

public boolean lock(String lockKey,
                    String appId)

获取分布式锁

参数:

lockKey - 锁键

appId - 应用标识

返回:

是否获取锁 true 成功

lock

public boolean lock(String lockKey,
                    String appId,
                    long expireTime)

获取分布式锁

参数:

lockKey - 锁键

appId - 应用标识

expireTime - 锁超时时间 单位 秒

返回:

是否获取锁 true 成功

releaseLock

public void releaseLock(String lockKey,
                        String appId)

释放分布式锁

参数:

lockKey - 锁key

appId - 应用id

hLimit

public long hLimit(String key,
                   String field,
                   long limitCount)

hash结构控制并发或频次

参数:

key - 大key

field - 小key，一般为 用户名，手机号等。

limitCount - 并发或频次总量

返回:

1 并发或频次已超过。 -1 获取到一并发，或者增加一次。