keys = redisTemplate.keys(pattern);
if (log.isDebugEnabled()) {
log.debug("keys(...) => pattern -> {}", pattern);
log.debug("keys(...) => keys -> {}", keys);
}
return keys;
}
/**
* 将当前数据库中的 key 对应的 key-value,移动到对应位置的数据库中。
*
* 注:单机版的 redis,默认将存储分为 16 个 db, index 为 0 到 15。
* 注:同一个 db 下,key 唯一; 但是在不同 db 中,key 可以相同。
* 注:若目标 db 下,已存在相同的 key, 那么 move 会失败,返回 false。
*
* @param key 定位要移动的 key-value 的 key
* @param dbIndex 要移动到哪个 db
* @return 移动是否成功。
* 注:若目标 db 下,已存在相同的 key, 那么 move 会失败,返回 false。
* @since 2020/3/8 13:01:00
*/
public boolean move(String key, int dbIndex) {
Boolean result = redisTemplate.move(key, dbIndex);
if (log.isDebugEnabled()) {
log.debug("move(...) => key -> {}, dbIndex -> {}", key, dbIndex);
log.debug("move(...) => result -> {}", result);
}
if (result == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return result;
}
/**
* 移除 key 对应的 key-value 的过期时间, 使该 key-value 一直存在
*
* 注:若 key 对应的 key-value,本身就是一直存在(无过期时间的), 那么 persist 方法会返回 false;
* 若没有 key 对应的 key-value 存在,本那么 persist 方法会返回 false;
*
* @param key 定位 key-value 的 key
* @return 操作是否成功
* @since 2020/3/8 13:10:02
*/
public boolean persist(String key) {
Boolean result = redisTemplate.persist(key);
if (log.isDebugEnabled()) {
log.debug("persist(...) => key -> {}", key);
log.debug("persist(...) => result -> {}", result);
}
if (result == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return result;
}
/**
* 获取 key 对应的 key-value 的过期时间
*
* 注:若 key-value 永不过期, 那么返回的为 -1。
* 注:若不存在 key 对应的 key-value, 那么返回的为 -2
* 注:若存在零碎时间不足 1 SECONDS,则(大体上)四舍五入到 SECONDS 级别。
*
* @param key 定位 key-value 的 key
* @return 过期时间(单位s)
* @since 2020/3/8 13:17:35
*/
public long getExpire(String key) {
return getExpire(key, TimeUnit.SECONDS);
}
/**
* 获取 key 对应的 key-value 的过期时间
*
* 注:若 key-value 永不过期, 那么返回的为 -1。
* 注:若不存在 key 对应的 key-value,那么返回的为 -2
* 注:若存在零碎时间不足 1 unit,则(大体上)四舍五入到 unit 别。
*
* @param key 定位 key-value 的 key
* @return 过期时间(单位 unit)
* @since 2020/3/8 13:17:35
*/
public long getExpire(String key, TimeUnit unit) {
Long result = redisTemplate.getExpire(key, unit);
if (log.isDebugEnabled()) {
log.debug("getExpire(...) => key -> {}, unit is -> {}", key, unit);
log.debug("getExpire(...) => result -> {}", result);
}
if (result == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return result;
}
/**
* 从 redis 的所有 key 中,随机获取一个 key
*
* 注:若 redis 中不存在任何 key-value,那么这里返回 null
*
* @return 随机获取到的一个 key
* @since 2020/3/8 14:11:43
*/
public String randomKey() {
String result = redisTemplate.randomKey();
if (log.isDebugEnabled()) {
log.debug("randomKey(...) => result -> {}", result);
}
return result;
}
/**
* 重命名对应的 oldKey 为新的 newKey
*
* 注:若 oldKey 不存在, 则会抛出异常.
* 注:若 redis 中已存在与 newKey 一样的 key,
* 那么原 key-value 会被丢弃,
* 只留下新的 key,以及原来的 value
* 示例说明:假设 redis 中已有(keyAlpha, valueAlpha)和(keyBeta, valueBeat),
* 在使用 rename(keyAlpha, keyBeta)替换后, redis 中只会剩下(keyBeta, valueAlpha)
*
* @param oldKey 旧的 key
* @param newKey 新的 key
* @throws RedisSystemException 若 oldKey 不存在时, 抛出此异常
* @since 2020/3/8 14:14:17
*/
public void rename(String oldKey, String newKey) {
if (log.isDebugEnabled()) {
log.debug("rename(...) => oldKey -> {}, newKey -> {}", oldKey, newKey);
}
redisTemplate.rename(oldKey, newKey);
}
/**
* 当 redis 中不存在 newKey 时, 重命名对应的 oldKey 为新的 newKey。
* 否者不进行重命名操作。
*
* 注:若 oldKey 不存在, 则会抛出异常.
*
* @param oldKey 旧的 key
* @param newKey 新的 key
* @throws RedisSystemException 若 oldKey 不存在时, 抛出此异常
* @since 2020/3/8 14:14:17
*/
public boolean renameIfAbsent(String oldKey, String newKey) {
Boolean result = redisTemplate.renameIfAbsent(oldKey, newKey);
if (log.isDebugEnabled()) {
log.debug("renameIfAbsent(...) => oldKey -> {}, newKey -> {}", oldKey, newKey);
log.debug("renameIfAbsent(...) => result -> {}", result);
}
if (result == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return result;
}
/**
* 获取 key 对应的 value 的数据类型
*
* 注:若 redis 中不存在该 key 对应的 key-value, 那么这里返回 NONE。
*
* @param key 用于定位的 key
* @return key 对应的 value 的数据类型的枚举
* @since 2020/3/8 14:40:16
*/
public DataType type(String key) {
DataType result = redisTemplate.type(key);
if (log.isDebugEnabled()) {
log.debug("type(...) => key -> {}", key);
log.debug("type(...) => result -> {}", result);
}
return result;
}
// ====================== string 相关操作 ======================
/**
* 设置 key-value
*
* 注:若已存在相同的 key, 那么原来的 key-value 会被丢弃。
*
* @param key key
* @param value key 对应的 value
* @since 2020/3/8 15:40:59
*/
public void set(String key, Object value) {
if (log.isDebugEnabled()) {
log.debug("set(...) => key -> {}, value -> {}", key, value);
}
redisTemplate.opsForValue().set(key, value);
}
/**
* 处理 redis 中 key 对应的 value 值, 将第 offset 位的值, 设置为 1 或 0。
*
* 说明:在 redis 中,存储的字符串都是以二级制的进行存在的;如存储的 key-value 里,值为 abc,实际上,
* 在 redis 里面存储的是 011000010110001001100011,前 8 位对应 a,中间 8 位对应 b,后面 8 位对应 c。
* 示例:这里如果 setBit(key, 6, true) 的话,就是将索引位置 6 的那个数,设置值为 1,值就变成
* 了 011000110110001001100011
* 追注:offset 即 index,从 0 开始。
*
* 注:参数 value 为 true,则设置为 1;参数 value 为 false,则设置为 0。
*
* 注:若 redis 中不存在对应的 key,那么会自动创建新的。
* 注:offset 可以超过 value 在二进制下的索引长度。
*
* @param key 定位 value 的 key
* @param offset 要改变的 bit 的索引
* @param value 改为 1 或 0,true - 改为 1,false - 改为 0
* @return set 是否成功
* @since 2020/3/8 16:30:37
*/
public boolean setBit(String key, long offset, boolean value) {
Boolean result = redisTemplate.opsForValue().setBit(key, offset, value);
if (log.isDebugEnabled()) {
log.debug("setBit(...) => key -> {}, offset -> {}, value -> {}", key, offset, value);
log.debug("setBit(...) => result -> {}", result);
}
if (result == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return result;
}
/**
* 设置 key-value
*
* 注:若已存在相同的 key,那么原来的 key-value 会被丢弃
*
* 注:原子操作
*
* @param key key
* @param value key 对应的 value
* @param timeToLive 过时时长
* @param unit timeToLive 的单位
* @since 2020/3/8 15:40:59
*/
public void setEx(String key, Object value, long timeToLive, TimeUnit unit) {
if (log.isDebugEnabled()) {
log.debug("setEx(...) => key -> {}, value -> {}, timeToLive -> {}, unit -> {}", key, value, timeToLive, unit);
}
redisTemplate.opsForValue().set(key, value, timeToLive, unit);
}
/**
* 若不存在 key 时,向 redis 中添加 key-value, 返回成功/失败。
* 若存在,则不作任何操作,返回 false。
*
* @param key key
* @param value key 对应的 value
* @return set 是否成功
* @since 2020/3/8 16:51:36
*/
public boolean setIfAbsent(String key, Object value) {
Boolean result = redisTemplate.opsForValue().setIfAbsent(key, value);
if (log.isDebugEnabled()) {
log.debug("setIfAbsent(...) => key -> {}, value -> {}", key, value);
log.debug("setIfAbsent(...) => result -> {}", result);
}
if (result == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return result;
}
/**
* 若不存在 key 时, 向 redis 中添加一个(具有超时时长的)key-value, 返回成功/失败。
* 若存在,则不作任何操作,返回 false。
*
* @param key key
* @param value key 对应的 value
* @param timeToLive 超时时长
* @param unit timeToLive 的单位
* @return set 是否成功
* @since 2020/3/8 16:51:36
*/
public boolean setIfAbsent(String key, Object value, long timeToLive, TimeUnit unit) {
Boolean result = redisTemplate.opsForValue().setIfAbsent(key, value, timeToLive, unit);
if (log.isDebugEnabled()) {
log.debug("setIfAbsent(...) => key -> {}, value -> {}, timeToLive -> {}, unit -> {}", key, value, timeToLive, unit);
log.debug("setIfAbsent(...) => result -> {}", result);
}
if (result == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return result;
}
/**
* 从(redis 中 key 对应的)value 的 offset 位置起(包含该位置),用 replaceValue 替换对应长度的值。
*
* 举例说明:
* 1. 假设 redis 中存在 key-value("ds", "0123456789"); 调
* 用 setRange("ds", "abcdefghijk", 3)后,redis 中该 value 值就变为了 [012abcdefghijk]
*
* 2. 假设 redis 中存在 key-value("jd", "0123456789"); 调
* 用 setRange("jd", "xyz", 3)后,redis 中该 value 值就变为了 [012xyz6789]
*
* 3. 假设 redis 中存在 key-value("ey", "0123456789"); 调
* 用 setRange("ey", "qwer", 15)后,redis 中该 value 值就变为了 [0123456789 qwer]
* 注:case3 比较特殊,offset 超过了原 value 的长度了。中间就会有一些空格来填充,但是如果在程序
* 中直接输出的话,中间那部分空格可能会出现乱码。
*
* @param key 定位 key-value 的 key
* @param replaceValue 要替换的值
* @param offset 起始位置
* @since 2020/3/8 17:04:31
*/
public void setRange(String key, String replaceValue, long offset) {
if (log.isDebugEnabled()) {
log.debug("setRange(...) => key -> {}, replaceValue -> {}, offset -> {}", key, replaceValue, offset);
}
redisTemplate.opsForValue().set(key, replaceValue, offset);
}
/**
* 获取到 key 对应的 value 的长度。
*
* 注:长度等于 {@link String#length}。
* 注:若 redis 中不存在对应的 key-value,则返回值为 0.
*
* @param key 定位 value 的 key
* @return value 的长度
* @since 2020/3/8 17:14:30
*/
public long size(String key) {
Long result = redisTemplate.opsForValue().size(key);
if (log.isDebugEnabled()) {
log.debug("size(...) => key -> {}", key);
log.debug("size(...) => result -> {}", result);
}
if (result == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return result;
}
/**
* 批量设置 key-value
*
* 注:若存在相同的 key, 则原来的 key-value会 被丢弃。
*
* @param maps key-value 集
* @since 2020/3/8 17:21:19
*/
public void multiSet(Map maps) {
if (log.isDebugEnabled()) {
log.debug("multiSet(...) => maps -> {}", maps);
}
redisTemplate.opsForValue().multiSet(maps);
}
/**
* 当 redis 中,不存在任何一个 keys 时,才批量设置 key-value,并返回成功/失败。
* 否者,不进行任何操作,并返回 false。
*
* 即:假设调用此方法时传入的参数 map 是这样的:{k1=v1, k2=v2, k3=v3}
* 那么 redis 中,k1、k2、k3 都不存在时,才会批量设置 key-value;
* 否则不会设置任何 key-value。
*
* 注:若存在相同的 key,则原来的 key-value 会被丢弃。
*
* @param maps key-value 集
* @return 操作是否成功
* @since 2020/3/8 17:21:19
*/
public boolean multiSetIfAbsent(Map maps) {
Boolean result = redisTemplate.opsForValue().multiSetIfAbsent(maps);
if (log.isDebugEnabled()) {
log.debug("multiSetIfAbsent(...) => maps -> {}", maps);
log.debug("multiSetIfAbsent(...) => result -> {}", result);
}
if (result == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return result;
}
/**
* 增/减 整数
*
* 注:负数则为减。
*
* 注:若 key 对应的 value 值不支持增/减操作(即:value不是数字),那么会
* 抛出 org.springframework.data.redis.RedisSystemException
*
* @param key 用于定位 value 的 key
* @param increment 增加多少
* @return 增加后的总值。
* @throws RedisSystemException key 对应的 value 值不支持增/减操作时
* @since 2020/3/8 17:45:51
*/
public long incrBy(String key, long increment) {
Long result = redisTemplate.opsForValue().increment(key, increment);
if (log.isDebugEnabled()) {
log.debug("incrBy(...) => key -> {}, increment -> {}", key, increment);
log.debug("incrBy(...) => result -> {}", result);
}
if (result == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return result;
}
/**
* 增/减 浮点数
*
* 注:慎用浮点数,会有精度问题。
*
* 如: 先 RedisHelper.StringOps.set("ds", "123");
* 然后再 RedisUtil.StringOps.incrByFloat("ds", 100.6);
* 就会看到精度问题。
*
* 注:负数则为减。
*
* 注:若 key 对应的 value 值不支持增/减操作(即:value不是数字),那么会
* 抛出 org.springframework.data.redis.RedisSystemException
*
* @param key 用于定位value的key
* @param increment 增加多少
* @return 增加后的总值。
* @throws RedisSystemException key对应的value值不支持增/减操作时
* @since 2020/3/8 17:45:51
*/
public double incrByFloat(String key, double increment) {
Double result = redisTemplate.opsForValue().increment(key, increment);
if (log.isDebugEnabled()) {
log.debug("incrByFloat(...) => key -> {}, increment -> {}", key, increment);
log.debug("incrByFloat(...) => result -> {}", result);
}
if (result == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return result;
}
/**
* 追加值到末尾
*
* 注: 当 redis 中原本不存在 key 时,那么(从效果上来看)此方法就等价于 {@link #set(String, Object)}
*
* @param key 定位 value 的 key
* @param value 要追加的 value 值
* @return 追加后,整个 value 的长度
* @since 2020/3/8 17:59:21
*/
public int append(String key, String value) {
Integer result = redisTemplate.opsForValue().append(key, value);
if (log.isDebugEnabled()) {
log.debug("append(...) => key -> {}, value -> {}", key, value);
log.debug("append(...) => result -> {}", result);
}
if (result == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return result;
}
/**
* 根据 key,获取到对应的 value 值
*
* @param key key-value 对应的 key
* @return 该 key 对应的值。
* 注: 若 key 不存在, 则返回 null。
* @since 2020/3/8 16:27:41
*/
public Object get(String key) {
Object result = redisTemplate.opsForValue().get(key);
if (log.isDebugEnabled()) {
log.debug("get(...) => key -> {}", key);
log.debug("get(...) => result -> {} ", result);
}
return result;
}
/**
* 对(key 对应的)value 进行截取, 截取范围为 [start, end]
*
* 注:若 [start, end] 的范围不在 value 的范围中,那么返回的是空字符串 ""
*
* 注:若 value 只有一部分在 [start, end] 的范围中,那么返回的是 value 对应部分的内容(即:不足的地方,并不会以空来填充)
*
* @param key 定位 value 的 key
* @param start 起始位置(从0开始)
* @param end 结尾位置(从0开始)
* @return 截取后的字符串
* @since 2020/3/8 18:08:45
*/
public String getRange(String key, long start, long end) {
String result = redisTemplate.opsForValue().get(key, start, end);
if (log.isDebugEnabled()) {
log.debug("getRange(...) => key -> {}", key);
log.debug("getRange(...) => result -> {} ", result);
}
return result;
}
/**
* 给指定 key 设置新的 value,并返回旧的 value
*
* 注: 若 redis 中不存在 key,那么此操作仍然可以成功,不过返回的旧值是 null
*
* @param key 定位 value 的 key
* @param newValue 要为该 key 设置的新的 value 值
* @return 旧的 value 值
* @since 2020/3/8 18:14:24
*/
public Object getAndSet(String key, Object newValue) {
Object oldValue = redisTemplate.opsForValue().getAndSet(key, newValue);
if (log.isDebugEnabled()) {
log.debug("getAndSet(...) => key -> {}, value -> {}", key, newValue);
log.debug("getAndSet(...) => oldValue -> {}", oldValue);
}
return oldValue;
}
/**
* 获取(key对应的)value 在二进制下,offset 位置的 bit 值。
*
* 注:当 offset 的值在(二进制下的 value 的)索引范围外时,返回的也是 false。
*
* 示例:
* RedisHelper.StringOps.set("akey", "a");
* 字符串 a,转换为二进制为 01100001
* 那么 getBit("akey", 6) 获取到的结果为 false。
*
* @param key 定位 value 的 key
* @param offset 定位 bit 的索引
* @return offset 位置对应的 bit 的值(true - 1, false - 0)
* @since 2020/3/8 18:21:10
*/
public boolean getBit(String key, long offset) {
Boolean result = redisTemplate.opsForValue().getBit(key, offset);
if (log.isDebugEnabled()) {
log.debug("getBit(...) => key -> {}, offset -> {}", key, offset);
log.debug("getBit(...) => result -> {}", result);
}
if (result == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return result;
}
/**
* 批量获取 value 值
*
* 注:若 redis 中,对应的 key 不存在,那么该 key 对应的返回的 value 值为 null
*
* @param keys key 集
* @return value 值集合
* @since 2020/3/8 18:26:33
*/
public List multiGet(Collection keys) {
List result = redisTemplate.opsForValue().multiGet(keys);
if (log.isDebugEnabled()) {
log.debug("multiGet(...) => keys -> {}", keys);
log.debug("multiGet(...) => result -> {}", result);
}
return result;
}
// ====================== hash 相关操作 ======================
/**
* 向 key 对应的 hash 中,增加一个键值对 entryKey-entryValue
*
* 注:同一个 hash 里面,若已存在相同的 entryKey,那么此操作将丢弃原来的 entryKey-entryValue,
* 而使用新的 entryKey-entryValue。
*
* @param key 定位 hash 的 key
* @param entryKey 要向 hash 中增加的键值对里的键
* @param entryValue 要向 hash 中增加的键值对里的值
* @since 2020/3/8 23:49:52
*/
public void hPut(String key, String entryKey, Object entryValue) {
if (log.isDebugEnabled()) {
log.debug("hPut(...) => key -> {}, entryKey -> {}, entryValue -> {}", key, entryKey, entryValue);
}
redisTemplate.opsForHash().put(key, entryKey, entryValue);
}
/**
* 向 key 对应的 hash 中,增加 maps(即: 批量增加 entry 集)
*
* 注:同一个 hash 里面,若已存在相同的 entryKey,那么此操作将丢弃原来的 entryKey-entryValue,
* 而使用新的 entryKey-entryValue
*
* @param key 定位 hash 的 key
* @param maps 要向 hash 中增加的键值对集
* @since 2020/3/8 23:49:52
*/
public void hPutAll(String key, Map maps) {
if (log.isDebugEnabled()) {
log.debug("hPutAll(...) => key -> {}, maps -> {}", key, maps);
}
redisTemplate.opsForHash().putAll(key, maps);
}
/**
* 当 key 对应的 hash 中,不存在 entryKey 时,才(向 key 对应的 hash 中)增加 entryKey-entryValue
* 否者,不进行任何操作
*
* @param key 定位 hash 的 key
* @param entryKey 要向 hash 中增加的键值对里的键
* @param entryValue 要向 hash 中增加的键值对里的值
* @return 操作是否成功。
* @since 2020/3/8 23:49:52
*/
public boolean hPutIfAbsent(String key, String entryKey, Object entryValue) {
Boolean result = redisTemplate.opsForHash().putIfAbsent(key, entryKey, entryValue);
if (log.isDebugEnabled()) {
log.debug("hPutIfAbsent(...) => key -> {}, entryKey -> {}, entryValue -> {}", key, entryKey, entryValue);
log.debug("hPutIfAbsent(...) => result -> {}", result);
}
return result;
}
/**
* 获取到 key 对应的 hash 里面的对应字段的值
*
* 注: 若 redis 中不存在对应的 key,则返回 null。
* 若 key 对应的 hash 中不存在对应的 entryKey,也会返回 null。
*
* @param key 定位 hash 的 key
* @param entryKey 定位 hash 里面的 entryValue 的 entryKey
* @return key 对应的 hash 里的 entryKey 对应的 entryValue 值
* @since 2020/3/9 9:09:30
*/
public Object hGet(String key, String entryKey) {
Object entryValue = redisTemplate.opsForHash().get(key, entryKey);
if (log.isDebugEnabled()) {
log.debug("hGet(...) => key -> {}, entryKey -> {}", key, entryKey);
log.debug("hGet(...) => entryValue -> {}", entryValue);
}
return entryValue;
}
/**
* 获取到 key 对应的 hash(即:获取到 key 对应的 Map)
*
* 注:若 redis 中不存在对应的 key,则返回一个没有任何 entry 的空的 Map(而不是返回 null)。
*
* @param key 定位 hash 的 key
* @return key 对应的 hash。
* @since 2020/3/9 9:09:30
*/
public Map hGetAll(String key) {
Map result = redisTemplate.opsForHash().entries(key);
if (log.isDebugEnabled()) {
log.debug("hGetAll(...) => key -> {}", key);
log.debug("hGetAll(...) => result -> {}", result);
}
return result;
}
/**
* 批量获取(key 对应的)hash 中的 entryKey 的 entryValue
*
* 注:若 hash 中对应的 entryKey 不存在,那么返回的对应的 entryValue 值为 null
*
* 注:redis 中 key 不存在,那么返回的 List 中,每个元素都为 null。
*
* 追注:这个 List 本身不为 null,size 也不为 0,只是每个 list 中的每个元素为 null 而已。
*
* @param key 定位 hash 的 key
* @param entryKeys 需要获取的 hash 中的字段集
* @return hash 中对应 entryKeys 的对应 entryValue 集
* @since 2020/3/9 9:25:38
*/
public List hMultiGet(String key, Collection entryKeys) {
List entryValues = redisTemplate.opsForHash().multiGet(key, entryKeys);
if (log.isDebugEnabled()) {
log.debug("hMultiGet(...) => key -> {}, entryKeys -> {}", key, entryKeys);
log.debug("hMultiGet(...) => entryValues -> {}", entryValues);
}
return entryValues;
}
/**
* (批量)删除(key 对应的)hash 中的对应 entryKey-entryValue
*
* 注: 1、若 redis 中不存在对应的 key,则返回 0;
* 2、若要删除的 entryKey,在 key 对应的 hash 中不存在,在 count 不会 +1, 如:
*
* RedisHelper.HashOps.hPut("ds", "name", "邓沙利文");
* RedisHelper.HashOps.hPut("ds", "birthday", "1994-02-05");
* RedisHelper.HashOps.hPut("ds", "hobby", "女");
* 则调用 RedisUtil.HashOps.hDelete("ds", "name", "birthday", "hobby", "non-exist-entryKey")
* 的返回结果为 3
* 注:若(key 对应的)hash 中的所有 entry 都被删除了,那么该 key 也会被删除
*
* @param key 定位 hash 的 key
* @param entryKeys 定位要删除的 entryKey-entryValue 的 entryKey
* @return 删除了对应 hash 中多少个 entry
* @since 2020/3/9 9:37:47
*/
public long hDelete(String key, Object... entryKeys) {
Long count = redisTemplate.opsForHash().delete(key, entryKeys);
if (log.isDebugEnabled()) {
log.debug("hDelete(...) => key -> {}, entryKeys -> {}", key, entryKeys);
log.debug("hDelete(...) => count -> {}", count);
}
return count;
}
/**
* 查看(key 对应的)hash中,是否存在 entryKey 对应的 entry
*
* 注:若 redis 中不存在 key,则返回 false。
* 注:若 key 对应的 hash 中不存在对应的 entryKey,也会返回 false。
*
* @param key 定位 hash 的 key
* @param entryKey 定位 hash 中 entry 的 entryKey
* @return hash 中是否存在 entryKey 对应的 entry.
* @since 2020/3/9 9:51:55
*/
public boolean hExists(String key, String entryKey) {
Boolean exist = redisTemplate.opsForHash().hasKey(key, entryKey);
if (log.isDebugEnabled()) {
log.debug("hDelete(...) => key -> {}, entryKeys -> {}", key, entryKey);
log.debug("hDelete(...) => exist -> {}", exist);
}
return exist;
}
/**
* 增/减(hash中的某个entryValue值) 整数
*
* 注: 负数则为减。
* 注: 若key不存在,那么会自动创建对应的hash,并创建对应的entryKey、entryValue,entryValue的初始值为increment。
* 注: 若entryKey不存在,那么会自动创建对应的entryValue,entryValue的初始值为increment。
* 注: 若key对应的value值不支持增/减操作(即: value不是数字), 那么会
* 抛出org.springframework.data.redis.RedisSystemException
*
* @param key 用于定位hash的key
* @param entryKey 用于定位entryValue的entryKey
* @param increment 增加多少
* @return 增加后的总值。
* @throws RedisSystemException key对应的value值不支持增/减操作时
* @since 2020/3/9 10:09:28
*/
public long hIncrBy(String key, Object entryKey, long increment) {
Long result = redisTemplate.opsForHash().increment(key, entryKey, increment);
if (log.isDebugEnabled()) {
log.debug("hIncrBy(...) => key -> {}, entryKey -> {}, increment -> {}", key, entryKey, increment);
log.debug("hIncrBy(...) => result -> {}", result);
}
return result;
}
/**
* 增/减(hash中的某个entryValue值) 浮点数
*
* 注: 负数则为减。
* 注: 若key不存在,那么会自动创建对应的hash,并创建对应的entryKey、entryValue,entryValue的初始值为increment。
* 注: 若entryKey不存在,那么会自动创建对应的entryValue,entryValue的初始值为increment。
* 注: 若key对应的value值不支持增/减操作(即: value不是数字), 那么会
* 抛出org.springframework.data.redis.RedisSystemException
* 注: 因为是浮点数, 所以可能会和{@link #incrByFloat(String, double)}一样, 出现精度问题。
* 追注: 本人简单测试了几组数据,暂未出现精度问题。
*
* @param key 用于定位hash的key
* @param entryKey 用于定位entryValue的entryKey
* @param increment 增加多少
* @return 增加后的总值。
* @throws RedisSystemException key对应的value值不支持增/减操作时
* @since 2020/3/9 10:09:28
*/
public double hIncrByFloat(String key, Object entryKey, double increment) {
Double result = redisTemplate.opsForHash().increment(key, entryKey, increment);
if (log.isDebugEnabled()) {
log.debug("hIncrByFloat(...) => key -> {}, entryKey -> {}, increment -> {}", key, entryKey, increment);
log.debug("hIncrByFloat(...) => result -> {}", result);
}
return result;
}
/**
* 获取(key对应的)hash中的所有entryKey
*
* 注: 若key不存在,则返回的是一个空的Set(,而不是返回null)
*
* @param key 定位hash的key
* @return hash中的所有entryKey
* @since 2020/3/9 10:30:13
*/
public Set hKeys(String key) {
Set entryKeys = redisTemplate.opsForHash().keys(key);
if (log.isDebugEnabled()) {
log.debug("hKeys(...) => key -> {}", key);
log.debug("hKeys(...) => entryKeys -> {}", entryKeys);
}
return entryKeys;
}
/**
* 获取(key对应的)hash中的所有entryValue
*
* 注: 若key不存在,则返回的是一个空的List(,而不是返回null)
*
* @param key 定位hash的key
* @return hash中的所有entryValue
* @since 2020/3/9 10:30:13
*/
public List hValues(String key) {
List entryValues = redisTemplate.opsForHash().values(key);
if (log.isDebugEnabled()) {
log.debug("hValues(...) => key -> {}", key);
log.debug("hValues(...) => entryValues -> {}", entryValues);
}
return entryValues;
}
/**
* 获取(key对应的)hash中的所有entry的数量
*
* 注: 若redis中不存在对应的key, 则返回值为0
*
* @param key 定位hash的key
* @return (key对应的)hash中, entry的个数
* @since 2020/3/9 10:41:01
*/
public long hSize(String key) {
Long count = redisTemplate.opsForHash().size(key);
if (log.isDebugEnabled()) {
log.debug("hSize(...) => key -> {}", key);
log.debug("hSize(...) => count -> {}", count);
}
return count;
}
/**
* 根据options匹配到(key对应的)hash中的对应的entryKey, 并返回对应的entry集
*
* 注: ScanOptions实例的创建方式举例:
* 1、ScanOptions.NONE
* 2、ScanOptions.scanOptions().match("n??e").build()
*
* @param key 定位hash的key
* @param options 匹配entryKey的条件
* 注: ScanOptions.NONE表示全部匹配。
* 注: ScanOptions.scanOptions().match(pattern).build()表示按照pattern匹配,
* 其中pattern中可以使用通配符 * ? 等,
* * 表示>=0个字符
* ? 表示有且只有一个字符
* 此处的匹配规则与{@link #keys(String)}处的一样。
* @return 匹配到的(key对应的)hash中的entry
* @since 2020/3/9 10:49:27
*/
public Cursor> hScan(String key, ScanOptions options) {
Cursor> cursor = redisTemplate.opsForHash().scan(key, options);
if (log.isDebugEnabled()) {
log.debug("hScan(...) => key -> {}, options -> {}", key, JSON.toJSONString(options));
log.debug("hScan(...) => cursor -> {}", JSON.toJSONString(cursor));
}
return cursor;
}
// ====================== list 相关操作 ======================
// 提示: 列表中的元素,可以重复。
// 提示: list是有序的。
// 提示: redis中的list中的索引,可分为两类,这两类都可以用来定位list中元素:
// 类别一: 从left到right, 是从0开始依次增大: 0, 1, 2, 3...
// 类别二: 从right到left, 是从-1开始依次减小: -1, -2, -3, -4...
// 提示: redis中String的数据结构可参考resources/data-structure/List(列表)的数据结构(示例一).png
// redis中String的数据结构可参考resources/data-structure/List(列表)的数据结构(示例二).png
/**
* 从左端推入元素进列表
*
* 注: 若redis中不存在对应的key, 那么会自动创建
*
* @param key 定位list的key
* @param value 要推入list的元素
* @return 推入后,(key对应的)list的size
* @since 2020/3/9 11:56:05
*/
public long lLeftPush(String key, Object value) {
Long size = redisTemplate.opsForList().leftPush(key, value);
if (log.isDebugEnabled()) {
log.debug("lLeftPush(...) => key -> {}, item -> {}", key, value);
log.debug("lLeftPush(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 从左端批量推入元素进列表
*
* 注: 若redis中不存在对应的key, 那么会自动创建
* 注: 这一批item中,先push左侧的, 后push右侧的
*
* @param key 定位list的key
* @param items 要批量推入list的元素集
* @return 推入后,(key对应的)list的size
* @since 2020/3/9 11:56:05
*/
public long lLeftPushAll(String key, Object... items) {
Long size = redisTemplate.opsForList().leftPushAll(key, items);
if (log.isDebugEnabled()) {
log.debug("lLeftPushAll(...) => key -> {}, items -> {}", key, items);
log.debug("lLeftPushAll(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 从左端批量推入元素进列表
*
* 注: 若redis中不存在对应的key, 那么会自动创建
* 注: 这一批item中,那个item先从Collection取出来,就先push哪个
*
* @param key 定位list的key
* @param items 要批量推入list的元素集
* @return 推入后,(key对应的)list的size
* @since 2020/3/9 11:56:05
*/
public long lLeftPushAll(String key, Collection items) {
Long size = redisTemplate.opsForList().leftPushAll(key, items);
if (log.isDebugEnabled()) {
log.debug("lLeftPushAll(...) => key -> {}, items -> {}", key, items);
log.debug("lLeftPushAll(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 如果redis中存在key, 则从左端批量推入元素进列表;
* 否则,不进行任何操作
*
* @param key 定位list的key
* @param item 要推入list的项
* @return 推入后,(key对应的)list的size
* @since 2020/3/9 13:40:08
*/
public long lLeftPushIfPresent(String key, Object item) {
Long size = redisTemplate.opsForList().leftPushIfPresent(key, item);
if (log.isDebugEnabled()) {
log.debug("lLeftPushIfPresent(...) => key -> {}, item -> {}", key, item);
log.debug("lLeftPushIfPresent(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 若 key 对应的 list 中存在 pivot 项, 那么将 item 放入第一个 pivot 项前(即:放在第一个pivot项左边);
* 若 key 对应的 list 中不存在 pivot 项, 那么不做任何操作, 直接返回 -1。
*
* 注: 若 redis 中不存在对应的 key, 那么会自动创建
*
* @param key 定位list的key
* @param item 要推入list的元素
* @return 推入后,(key对应的)list的size
* @since 2020/3/9 11:56:05
*/
public long lLeftPush(String key, String pivot, Object item) {
Long size = redisTemplate.opsForList().leftPush(key, pivot, item);
if (log.isDebugEnabled()) {
log.debug("lLeftPush(...) => key -> {}, pivot -> {}, item -> {}", key, pivot, item);
log.debug("lLeftPush(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 与{@link #lLeftPush(String, Object)}类比即可, 不过是从list右侧推入元素
*/
public long lRightPush(String key, Object item) {
Long size = redisTemplate.opsForList().rightPush(key, item);
if (log.isDebugEnabled()) {
log.debug("lRightPush(...) => key -> {}, item -> {}", key, item);
log.debug("lRightPush(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 与{@link #lLeftPushAll(String, Object...)}类比即可, 不过是从list右侧推入元素
*/
public long lRightPushAll(String key, Object... items) {
Long size = redisTemplate.opsForList().rightPushAll(key, items);
if (log.isDebugEnabled()) {
log.debug("lRightPushAll(...) => key -> {}, items -> {}", key, items);
log.debug("lRightPushAll(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 与{@link #lLeftPushAll(String, Collection)}类比即可, 不过是从list右侧推入元素
*/
public long lRightPushAll(String key, Collection items) {
Long size = redisTemplate.opsForList().rightPushAll(key, items);
if (log.isDebugEnabled()) {
log.debug("lRightPushAll(...) => key -> {}, items -> {}", key, items);
log.debug("lRightPushAll(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 与{@link #lLeftPushIfPresent(String, Object)}类比即可, 不过是从list右侧推入元素
*/
public long lRightPushIfPresent(String key, Object item) {
Long size = redisTemplate.opsForList().rightPushIfPresent(key, item);
if (log.isDebugEnabled()) {
log.debug("lRightPushIfPresent(...) => key -> {}, item -> {}", key, item);
log.debug("lRightPushIfPresent(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 与{@link #lLeftPush(String, String, Object)}类比即可, 不过是从list右侧推入元素
*/
public long lRightPush(String key, String pivot, Object item) {
Long size = redisTemplate.opsForList().rightPush(key, pivot, item);
if (log.isDebugEnabled()) {
log.debug("lLeftPush(...) => key -> {}, pivot -> {}, item -> {}", key, pivot, item);
log.debug("lLeftPush(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 【非阻塞队列】 从左侧移出(key对应的)list中的第一个元素, 并将该元素返回
*
* 注: 此方法是非阻塞的, 即: 若(key对应的)list中的所有元素都被pop移出了,此时,再进行pop的话,会立即返回null
* 注: 此方法是非阻塞的, 即: 若redis中不存在对应的key,那么会立即返回null
* 注: 若将(key对应的)list中的所有元素都pop完了,那么该key会被删除
*
* @param key 定位list的key
* @return 移出的那个元素
* @since 2020/3/9 14:33:56
*/
public Object lLeftPop(String key) {
Object item = redisTemplate.opsForList().leftPop(key);
if (log.isDebugEnabled()) {
log.debug("lLeftPop(...) => key -> {}", key);
log.debug("lLeftPop(...) => item -> {}", item);
}
return item;
}
/**
* 【阻塞队列】 从左侧移出(key对应的)list中的第一个元素, 并将该元素返回
*
* 注: 此方法是阻塞的, 即: 若(key对应的)list中的所有元素都被pop移出了,此时,再进行pop的话,
* 会阻塞timeout这么久,然后返回null
* 注: 此方法是阻塞的, 即: 若redis中不存在对应的key,那么会阻塞timeout这么久,然后返回null
* 注: 若将(key对应的)list中的所有元素都pop完了,那么该key会被删除
*
* 提示: 若阻塞过程中, 目标key-list出现了,且里面有item了,那么会立马停止阻塞, 进行元素移出并返回
*
* @param key 定位list的key
* @param timeout 超时时间
* @param unit timeout的单位
* @return 移出的那个元素
* @since 2020/3/9 14:33:56
*/
public Object lLeftPop(String key, long timeout, TimeUnit unit) {
Object item = redisTemplate.opsForList().leftPop(key, timeout, unit);
if (log.isDebugEnabled()) {
log.debug("lLeftPop(...) => key -> {}, timeout -> {}, unit -> {}", key, timeout, unit);
log.debug("lLeftPop(...) => item -> {}", item);
}
return item;
}
/**
* 与{@link #lLeftPop(String)}类比即可, 不过是从list右侧移出元素
*/
public Object lRightPop(String key) {
Object item = redisTemplate.opsForList().rightPop(key);
if (log.isDebugEnabled()) {
log.debug("lRightPop(...) => key -> {}", key);
log.debug("lRightPop(...) => item -> {}", item);
}
return item;
}
/**
* 与{@link #lLeftPop(String, long, TimeUnit)}类比即可, 不过是从list右侧移出元素
*/
public Object lRightPop(String key, long timeout, TimeUnit unit) {
Object item = redisTemplate.opsForList().rightPop(key, timeout, unit);
if (log.isDebugEnabled()) {
log.debug("lRightPop(...) => key -> {}, timeout -> {}, unit -> {}", key, timeout, unit);
log.debug("lRightPop(...) => item -> {}", item);
}
return item;
}
/**
* 【非阻塞队列】 从sourceKey对应的sourceList右侧移出一个item, 并将这个item推
* 入(destinationKey对应的)destinationList的左侧
*
* 注: 若sourceKey对应的list中没有item了,则立马认为(从sourceKey对应的list中pop出来的)item为null,
* null并不会往destinationKey对应的list中push。
* 追注: 此时,此方法的返回值是null。
*
* 注: 若将(sourceKey对应的)list中的所有元素都pop完了,那么该sourceKey会被删除。
*
* @param sourceKey 定位sourceList的key
* @param destinationKey 定位destinationList的key
* @return 移动的这个元素
* @since 2020/3/9 15:06:59
*/
public Object lRightPopAndLeftPush(String sourceKey, String destinationKey) {
Object item = redisTemplate.opsForList().rightPopAndLeftPush(sourceKey, destinationKey);
if (log.isDebugEnabled()) {
log.debug("lRightPopAndLeftPush(...) => sourceKey -> {}, destinationKey -> {}", sourceKey, destinationKey);
log.debug("lRightPopAndLeftPush(...) => item -> {}", item);
}
return item;
}
/**
* 【阻塞队列】 从sourceKey对应的sourceList右侧移出一个item, 并将这个item推
* 入(destinationKey对应的)destinationList的左侧
*
* 注: 若sourceKey对应的list中没有item了,则阻塞等待, 直到能从sourceList中移出一个非null的item(或等待时长超时);
* case1: 等到了一个非null的item, 那么继续下面的push操作,并返回这个item。
* case2: 超时了,还没等到非null的item, 那么pop出的结果就未null,此时并不会往destinationList进行push。
* 此时,此方法的返回值是null。
*
* 注: 若将(sourceKey对应的)list中的所有元素都pop完了,那么该sourceKey会被删除。
*
* @param sourceKey 定位sourceList的key
* @param destinationKey 定位destinationList的key
* @param timeout 超时时间
* @param unit timeout的单位
* @return 移动的这个元素
* @since 2020/3/9 15:06:59
*/
public Object lRightPopAndLeftPush(String sourceKey, String destinationKey, long timeout, TimeUnit unit) {
Object item = redisTemplate.opsForList().rightPopAndLeftPush(sourceKey, destinationKey, timeout, unit);
if (log.isDebugEnabled()) {
log.debug("lRightPopAndLeftPush(...) => sourceKey -> {}, destinationKey -> {}, timeout -> {}," + " unit -> {}", sourceKey, destinationKey, timeout, unit);
log.debug("lRightPopAndLeftPush(...) => item -> {}", item);
}
return item;
}
/**
* 设置(key对应的)list中对应索引位置index处的元素为item
*
* 注: 若key不存在,则会抛出org.springframework.data.redis.RedisSystemException
* 注: 若索引越界,也会抛出org.springframework.data.redis.RedisSystemException
*
* @param key 定位list的key
* @param index 定位list中的元素的索引
* @param item 要替换成的值
* @since 2020/3/9 15:39:50
*/
public void lSet(String key, long index, Object item) {
if (log.isDebugEnabled()) {
log.debug("lSet(...) => key -> {}, index -> {}, item -> {}", key, index, item);
}
redisTemplate.opsForList().set(key, index, item);
}
/**
* 通过索引index, 获取(key对应的)list中的元素
*
* 注: 若key不存在 或 index超出(key对应的)list的索引范围,那么返回null
*
* @param key 定位list的key
* @param index 定位list中的item的索引
* @return list中索引index对应的item
* @since 2020/3/10 0:27:23
*/
public Object lIndex(String key, long index) {
Object item = redisTemplate.opsForList().index(key, index);
if (log.isDebugEnabled()) {
log.debug("lIndex(...) => key -> {}, index -> {}", key, index);
log.debug("lIndex(...) => item -> {}", item);
}
return item;
}
/**
* 获取(key对应的)list中索引在[start, end]之间的item集
*
* 注: 含start、含end。
* 注: 当key不存在时,获取到的是空的集合。
* 注: 当获取的范围比list的范围还要大时,获取到的是这两个范围的交集。
*
* 提示: 可通过RedisUtil.ListOps.lRange(key, 0, -1)来获取到该key对应的整个list
*
* @param key 定位list的key
* @param start 起始元素的index
* @param end 结尾元素的index
* @return 对应的元素集合
* @since 2020/3/10 0:34:59
*/
public List lRange(String key, long start, long end) {
List result = redisTemplate.opsForList().range(key, start, end);
if (log.isDebugEnabled()) {
log.debug("lRange(...) => key -> {}, start -> {}, end -> {}", key, start, end);
log.debug("lRange(...) => result -> {}", result);
}
return result;
}
/**
* 获取(key对应的)list
*
* @param key 定位list的key
* @return (key对应的)list
* @see #lRange(String, long, long)
* @since 2020/3/10 0:46:50
*/
public List lWholeList(String key) {
List result = redisTemplate.opsForList().range(key, 0, -1);
if (log.isDebugEnabled()) {
log.debug("lWholeList(...) => key -> {}", key);
log.debug("lWholeList(...) => result -> {}", result);
}
return result;
}
/**
* 获取(key对应的)list的size
*
* 注: 当key不存在时,获取到的size为0.
*
* @param key 定位list的key
* @return list的size。
* @since 2020/3/10 0:48:40
*/
public long lSize(String key) {
Long size = redisTemplate.opsForList().size(key);
if (log.isDebugEnabled()) {
log.debug("lSize(...) => key -> {}", key);
log.debug("lSize(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 删除(key对应的)list中,前expectCount个值等于item的项
*
* 注: 若expectCount == 0, 则表示删除list中所有的值等于item的项.
* 注: 若expectCount > 0, 则表示删除从左往右进行
* 注: 若expectCount < 0, 则表示删除从右往左进行
*
* 注: 若list中,值等于item的项的个数少于expectCount时,那么会删除list中所有的值等于item的项。
* 注: 当key不存在时, 返回0。
* 注: 若lRemove后, 将(key对应的)list中没有任何元素了,那么该key会被删除。
*
* @param key 定位list的key
* @param expectCount 要删除的item的个数
* @param item 要删除的item
* @return 实际删除了的item的个数
* @since 2020/3/10 0:52:57
*/
public long lRemove(String key, long expectCount, Object item) {
Long actualCount = redisTemplate.opsForList().remove(key, expectCount, item);
if (log.isDebugEnabled()) {
log.debug("lRemove(...) => key -> {}, expectCount -> {}, item -> {}", key, expectCount, item);
log.debug("lRemove(...) => actualCount -> {}", actualCount);
}
if (actualCount == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return actualCount;
}
/**
* 裁剪(即: 对list中的元素取交集。)
*
* 举例说明: list中的元素索引范围是[0, 8], 而这个方法传入的[start, end]为 [3, 10],
* 那么裁剪就是对[0, 8]和[3, 10]进行取交集, 得到[3, 8], 那么裁剪后
* 的list中,只剩下(原来裁剪前)索引在[3, 8]之间的元素了。
*
* 注: 若裁剪后的(key对应的)list就是空的,那么该key会被删除。
*
* @param key 定位list的key
* @param start 要删除的item集的起始项的索引
* @param end 要删除的item集的结尾项的索引
* @since 2020/3/10 1:16:58
*/
public void lTrim(String key, long start, long end) {
if (log.isDebugEnabled()) {
log.debug("lTrim(...) => key -> {}, start -> {}, end -> {}", key, start, end);
}
redisTemplate.opsForList().trim(key, start, end);
}
// ====================== set 相关操作 ======================
// 提示: set中的元素,不可以重复。
// 提示: set是无序的。
// 提示: redis中String的数据结构可参考resources/data-structure/Set(集合)的数据结构(示例一).png
// redis中String的数据结构可参考resources/data-structure/Set(集合)的数据结构(示例二).png
/**
* 向(key对应的)set中添加items
*
* 注: 若key不存在,则会自动创建。
* 注: set中的元素会去重。
*
* @param key 定位set的key
* @param items 要向(key对应的)set中添加的items
* @return 此次添加操作, 添加到set中的元素的个数
* @since 2020/3/11 8:16:00
*/
public long sAdd(String key, Object... items) {
Long count = redisTemplate.opsForSet().add(key, items);
if (log.isDebugEnabled()) {
log.debug("sAdd(...) => key -> {}, items -> {}", key, items);
log.debug("sAdd(...) => count -> {}", count);
}
if (count == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return count;
}
/**
* 从(key对应的)set中删除items
*
* 注: 若key不存在, 则返回0。
* 注: 若已经将(key对应的)set中的项删除完了,那么对应的key也会被删除。
*
* @param key 定位set的key
* @param items 要移除的items
* @return 实际删除了的个数
* @since 2020/3/11 8:26:43
*/
public long sRemove(String key, Object... items) {
Long count = redisTemplate.opsForSet().remove(key, items);
if (log.isDebugEnabled()) {
log.debug("sRemove(...) => key -> {}, items -> {}", key, items);
log.debug("sRemove(...) => count -> {}", count);
}
if (count == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return count;
}
/**
* 从(key对应的)set中随机移出一个item, 并返回这个item
*
* 注: 因为set是无序的,所以移出的这个item,是随机的; 并且,哪怕
* 是数据一样的set,多次测试移出操作,移除的元素也是随机的。
*
* 注: 若已经将(key对应的)set中的项pop完了,那么对应的key会被删除。
*
* @param key 定位set的key
* @return 移出的项
* @since 2020/3/11 8:32:40
*/
public Object sPop(String key) {
Object popItem = redisTemplate.opsForSet().pop(key);
if (log.isDebugEnabled()) {
log.debug("sPop(...) => key -> {}", key);
log.debug("sPop(...) => popItem -> {}", popItem);
}
return popItem;
}
/**
* 将(sourceKey对应的)sourceSet中的元素item, 移动到(destinationKey对应的)destinationSet中
*
* 注: 当sourceKey不存在时, 返回false
* 注: 当item不存在时, 返回false
* 注: 若destinationKey不存在, 那么在移动时会自动创建
* 注: 若已经将(sourceKey对应的)set中的项move出去完了,那么对应的sourceKey会被删除。
*
* @param sourceKey 定位sourceSet的key
* @param item 要移动的项目
* @param destinationKey 定位destinationSet的key
* @return 移动成功与否
* @since 2020/3/11 8:43:32
*/
public boolean sMove(String sourceKey, Object item, String destinationKey) {
Boolean result = redisTemplate.opsForSet().move(sourceKey, item, destinationKey);
if (log.isDebugEnabled()) {
log.debug("sMove(...) => sourceKey -> {}, destinationKey -> {}, item -> {}", sourceKey, destinationKey, item);
log.debug("sMove(...) => result -> {}", result);
}
if (result == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return result;
}
/**
* 获取(key对应的)set中的元素个数
*
* 注: 若key不存在,则返回0
*
* @param key 定位set的key
* @return (key对应的)set中的元素个数
* @since 2020/3/11 8:57:19
*/
public long sSize(String key) {
Long size = redisTemplate.opsForSet().size(key);
if (log.isDebugEnabled()) {
log.debug("sSize(...) => key -> {}", key);
log.debug("sSize(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 判断(key对应的)set中是否含有item
*
* 注: 若key不存在,则返回false。
*
* @param key 定位set的key
* @param item 被查找的项
* @return (key对应的)set中是否含有item
* @since 2020/3/11 9:03:29
*/
public boolean sIsMember(String key, Object item) {
Boolean result = redisTemplate.opsForSet().isMember(key, item);
if (log.isDebugEnabled()) {
log.debug("sSize(...) => key -> {}, size -> {}", key, item);
log.debug("sSize(...) => result -> {}", result);
}
if (result == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return result;
}
/**
* 获取两个(key对应的)Set的交集
*
* 注: 若不存在任何交集,那么返回空的集合(, 而不是null)
* 注: 若其中一个key不存在(或两个key都不存在),那么返回空的集合(, 而不是null)
*
* @param key 定位其中一个set的键
* @param otherKey 定位其中另一个set的键
* @return item交集
* @since 2020/3/11 9:31:25
*/
public Set sIntersect(String key, String otherKey) {
Set intersectResult = redisTemplate.opsForSet().intersect(key, otherKey);
if (log.isDebugEnabled()) {
log.debug("sIntersect(...) => key -> {}, otherKey -> {}", key, otherKey);
log.debug("sIntersect(...) => intersectResult -> {}", intersectResult);
}
return intersectResult;
}
/**
* 获取多个(key对应的)Set的交集
*
* 注: 若不存在任何交集,那么返回空的集合(, 而不是null)
* 注: 若>=1个key不存在,那么返回空的集合(, 而不是null)
*
* @param key 定位其中一个set的键
* @param otherKeys 定位其它set的键集
* @return item交集
* @since 2020/3/11 9:39:23
*/
public Set sIntersect(String key, Collection otherKeys) {
Set intersectResult = redisTemplate.opsForSet().intersect(key, otherKeys);
if (log.isDebugEnabled()) {
log.debug("sIntersect(...) => key -> {}, otherKeys -> {}", key, otherKeys);
log.debug("sIntersect(...) => intersectResult -> {}", intersectResult);
}
return intersectResult;
}
/**
* 获取两个(key对应的)Set的交集, 并将结果add到storeKey对应的Set中。
*
* case1: 交集不为空, storeKey不存在, 则 会创建对应的storeKey,并将交集添加到(storeKey对应的)set中
* case2: 交集不为空, storeKey已存在, 则 会清除原(storeKey对应的)set中所有的项,然后将交集添加到(storeKey对应的)set中
* case3: 交集为空, 则不进行下面的操作, 直接返回0
*
* 注: 求交集的部分,详见{@link #sIntersect(String, String)}
*
* @param key 定位其中一个set的键
* @param otherKey 定位其中另一个set的键
* @param storeKey 定位(要把交集添加到哪个)set的key
* @return add到(storeKey对应的)Set后, 该set对应的size
* @since 2020/3/11 9:46:46
*/
public long sIntersectAndStore(String key, String otherKey, String storeKey) {
Long size = redisTemplate.opsForSet().intersectAndStore(key, otherKey, storeKey);
if (log.isDebugEnabled()) {
log.debug("sIntersectAndStore(...) => key -> {}, otherKey -> {}, storeKey -> {}", key, otherKey, storeKey);
log.debug("sIntersectAndStore(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 获取多个(key对应的)Set的交集, 并将结果add到storeKey对应的Set中。
*
* case1: 交集不为空, storeKey不存在, 则 会创建对应的storeKey,并将交集添加到(storeKey对应的)set中
* case2: 交集不为空, storeKey已存在, 则 会清除原(storeKey对应的)set中所有的项,然后将交集添加到(storeKey对应的)set中
* case3: 交集为空, 则不进行下面的操作, 直接返回0
*
* 注: 求交集的部分,详见{@link #sIntersect(String, Collection)}
*
* @since 2020/3/11 11:04:29
*/
public long sIntersectAndStore(String key, Collection otherKeys, String storeKey) {
Long size = redisTemplate.opsForSet().intersectAndStore(key, otherKeys, storeKey);
if (log.isDebugEnabled()) {
log.debug("sIntersectAndStore(...) => key -> {}, otherKeys -> {}, storeKey -> {}", key, otherKeys, storeKey);
log.debug("sIntersectAndStore(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 获取两个(key对应的)Set的并集
*
* 注: 并集中的元素也是唯一的,这是Set保证的。
*
* @param key 定位其中一个set的键
* @param otherKey 定位其中另一个set的键
* @return item并集
* @since 2020/3/11 11:18:35
*/
public Set sUnion(String key, String otherKey) {
Set unionResult = redisTemplate.opsForSet().union(key, otherKey);
if (log.isDebugEnabled()) {
log.debug("sUnion(...) => key -> {}, otherKey -> {}", key, otherKey);
log.debug("sUnion(...) => unionResult -> {}", unionResult);
}
return unionResult;
}
/**
* 获取两个(key对应的)Set的并集
*
* 注: 并集中的元素也是唯一的,这是Set保证的。
*
* @param key 定位其中一个set的键
* @param otherKeys 定位其它set的键集
* @return item并集
* @since 2020/3/11 11:18:35
*/
public Set sUnion(String key, Collection otherKeys) {
Set unionResult = redisTemplate.opsForSet().union(key, otherKeys);
if (log.isDebugEnabled()) {
log.debug("sUnion(...) => key -> {}, otherKeys -> {}", key, otherKeys);
log.debug("sUnion(...) => unionResult -> {}", unionResult);
}
return unionResult;
}
/**
* 获取两个(key对应的)Set的并集, 并将结果add到storeKey对应的Set中。
*
* case1: 并集不为空, storeKey不存在, 则 会创建对应的storeKey,并将并集添加到(storeKey对应的)set中
* case2: 并集不为空, storeKey已存在, 则 会清除原(storeKey对应的)set中所有的项,然后将并集添加到(storeKey对应的)set中
* case3: 并集为空, 则不进行下面的操作, 直接返回0
*
* 注: 求并集的部分,详见{@link #sUnion(String, String)}
*
* @param key 定位其中一个set的键
* @param otherKey 定位其中另一个set的键
* @param storeKey 定位(要把并集添加到哪个)set的key
* @return add到(storeKey对应的)Set后, 该set对应的size
* @since 2020/3/11 12:26:24
*/
public long sUnionAndStore(String key, String otherKey, String storeKey) {
Long size = redisTemplate.opsForSet().unionAndStore(key, otherKey, storeKey);
if (log.isDebugEnabled()) {
log.debug("sUnionAndStore(...) => key -> {}, otherKey -> {}, storeKey -> {}", key, otherKey, storeKey);
log.debug("sUnionAndStore(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 获取两个(key对应的)Set的并集, 并将结果add到storeKey对应的Set中。
*
* case1: 并集不为空, storeKey不存在, 则 会创建对应的storeKey,并将并集添加到(storeKey对应的)set中
* case2: 并集不为空, storeKey已存在, 则 会清除原(storeKey对应的)set中所有的项,然后将并集添加到(storeKey对应的)set中
* case3: 并集为空, 则不进行下面的操作, 直接返回0
*
* 注: 求并集的部分,详见{@link #sUnion(String, Collection)}
*
* @param key 定位其中一个set的键
* @param otherKeys 定位其它set的键集
* @param storeKey 定位(要把并集添加到哪个)set的key
* @return add到(storeKey对应的)Set后, 该set对应的size
* @since 2020/3/11 12:26:24
*/
public long sUnionAndStore(String key, Collection otherKeys, String storeKey) {
Long size = redisTemplate.opsForSet().unionAndStore(key, otherKeys, storeKey);
if (log.isDebugEnabled()) {
log.debug("sUnionAndStore(...) => key -> {}, otherKeys -> {}, storeKey -> {}", key, otherKeys, storeKey);
log.debug("sUnionAndStore(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 获取 (key对应的)Set 减去 (otherKey对应的)Set 的差集
*
* 注: 如果被减数key不存在, 那么结果为空的集合(,而不是null)
* 注: 如果被减数key存在,但减数key不存在, 那么结果即为(被减数key对应的)Set
*
* @param key 定位"被减数set"的键
* @param otherKey 定位"减数set"的键
* @return item差集
* @since 2020/3/11 14:03:57
*/
public Set sDifference(String key, String otherKey) {
Set differenceResult = redisTemplate.opsForSet().difference(key, otherKey);
if (log.isDebugEnabled()) {
log.debug("sDifference(...) => key -> {}, otherKey -> {}", key, otherKey);
log.debug("sDifference(...) => differenceResult -> {}", differenceResult);
}
return differenceResult;
}
/**
* 获取 (key对应的)Set 减去 (otherKeys对应的)Sets 的差集
*
* 注: 如果被减数key不存在, 那么结果为空的集合(,而不是null)
* 注: 如果被减数key存在,但减数key不存在, 那么结果即为(被减数key对应的)Set
*
* 提示: 当有多个减数时, 被减数先减去哪一个减数,后减去哪一个减数,是无所谓的,是不影响最终结果的。
*
* @param key 定位"被减数set"的键
* @param otherKeys 定位"减数集sets"的键集
* @return item差集
* @since 2020/3/11 14:03:57
*/
public Set sDifference(String key, Collection otherKeys) {
Set differenceResult = redisTemplate.opsForSet().difference(key, otherKeys);
if (log.isDebugEnabled()) {
log.debug("sDifference(...) => key -> {}, otherKeys -> {}", key, otherKeys);
log.debug("sDifference(...) => differenceResult -> {}", differenceResult);
}
return differenceResult;
}
/**
* 获取 (key对应的)Set 减去 (otherKey对应的)Set 的差集, 并将结果add到storeKey对应的Set中。
*
* case1: 差集不为空, storeKey不存在, 则 会创建对应的storeKey,并将差集添加到(storeKey对应的)set中
* case2: 差集不为空, storeKey已存在, 则 会清除原(storeKey对应的)set中所有的项,然后将差集添加到(storeKey对应的)set中
* case3: 差集为空, 则不进行下面的操作, 直接返回0
*
* 注: 求并集的部分,详见{@link #sDifference(String, String)}
*
* @param key 定位"被减数set"的键
* @param otherKey 定位"减数set"的键
* @param storeKey 定位(要把差集添加到哪个)set的key
* @return add到(storeKey对应的)Set后, 该set对应的size
* @since 2020/3/11 14:33:36
*/
public long sDifferenceAndStore(String key, String otherKey, String storeKey) {
Long size = redisTemplate.opsForSet().differenceAndStore(key, otherKey, storeKey);
if (log.isDebugEnabled()) {
log.debug("sDifferenceAndStore(...) => key -> {}, otherKey -> {}, storeKey -> {}", key, otherKey, storeKey);
log.debug("sDifferenceAndStore(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 获取 (key对应的)Set 减去 (otherKey对应的)Set 的差集, 并将结果add到storeKey对应的Set中。
*
* case1: 差集不为空, storeKey不存在, 则 会创建对应的storeKey,并将差集添加到(storeKey对应的)set中
* case2: 差集不为空, storeKey已存在, 则 会清除原(storeKey对应的)set中所有的项,然后将差集添加到(storeKey对应的)set中
* case3: 差集为空, 则不进行下面的操作, 直接返回0
*
* 注: 求并集的部分,详见{@link #sDifference(String, String)}
*
* @param key 定位"被减数set"的键
* @param otherKeys 定位"减数集sets"的键集
* @param storeKey 定位(要把差集添加到哪个)set的key
* @return add到(storeKey对应的)Set后, 该set对应的size
* @since 2020/3/11 14:33:36
*/
public long sDifferenceAndStore(String key, Collection otherKeys, String storeKey) {
Long size = redisTemplate.opsForSet().differenceAndStore(key, otherKeys, storeKey);
if (log.isDebugEnabled()) {
log.debug("sDifferenceAndStore(...) => key -> {}, otherKeys -> {}, storeKey -> {}", key, otherKeys, storeKey);
log.debug("sDifferenceAndStore(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 获取key对应的set
*
* 注: 若key不存在, 则返回的是空的set(, 而不是null)
*
* @param key 定位set的key
* @return (key对应的)set
* @since 2020/3/11 14:49:39
*/
public Set sMembers(String key) {
Set members = redisTemplate.opsForSet().members(key);
if (log.isDebugEnabled()) {
log.debug("sMembers(...) => key -> {}", key);
log.debug("sMembers(...) => members -> {}", members);
}
return members;
}
/**
* 从key对应的set中随机获取一项
*
* @param key 定位set的key
* @return 随机获取到的项
* @since 2020/3/11 14:54:58
*/
public Object sRandomMember(String key) {
Object randomItem = redisTemplate.opsForSet().randomMember(key);
if (log.isDebugEnabled()) {
log.debug("sRandomMember(...) => key -> {}", key);
log.debug("sRandomMember(...) => randomItem -> {}", randomItem);
}
return randomItem;
}
/**
* 从key对应的set中获取count次随机项(, set中的同一个项可能被多次获取)
*
* 注: count可大于set的size。
* 注: 取出来的结果里可能存在相同的值。
*
* @param key 定位set的key
* @param count 要取多少项
* @return 随机获取到的项集
* @since 2020/3/11 14:54:58
*/
public List sRandomMembers(String key, long count) {
List randomItems = redisTemplate.opsForSet().randomMembers(key, count);
if (log.isDebugEnabled()) {
log.debug("sRandomMembers(...) => key -> {}, count -> {}", key, count);
log.debug("sRandomMembers(...) => randomItems -> {}", randomItems);
}
return randomItems;
}
/**
* 从key对应的set中随机获取count个项
*
* 注: 若count >= set的size, 那么返回的即为这个key对应的set。
* 注: 取出来的结果里没有重复的项。
*
* @param key 定位set的key
* @param count 要取多少项
* @return 随机获取到的项集
* @since 2020/3/11 14:54:58
*/
public Set sDistinctRandomMembers(String key, long count) {
Set distinctRandomItems = redisTemplate.opsForSet().distinctRandomMembers(key, count);
if (log.isDebugEnabled()) {
log.debug("sDistinctRandomMembers(...) => key -> {}, count -> {}", key, count);
log.debug("sDistinctRandomMembers(...) => distinctRandomItems -> {}", distinctRandomItems);
}
return distinctRandomItems;
}
/**
* 根据options匹配到(key对应的)set中的对应的item, 并返回对应的item集
*
*
* 注: ScanOptions实例的创建方式举例:
* 1、ScanOptions.NONE
* 2、ScanOptions.scanOptions().match("n??e").build()
*
* @param key 定位set的key
* @param options 匹配set中的item的条件
* 注: ScanOptions.NONE表示全部匹配。
* 注: ScanOptions.scanOptions().match(pattern).build()表示按照pattern匹配,
* 其中pattern中可以使用通配符 * ? 等,
* * 表示>=0个字符
* ? 表示有且只有一个字符
* 此处的匹配规则与{@link #keys(String)}处的一样。
* @return 匹配到的(key对应的)set中的项
* @since 2020/3/9 10:49:27
*/
public Cursor sScan(String key, ScanOptions options) {
Cursor cursor = redisTemplate.opsForSet().scan(key, options);
if (log.isDebugEnabled()) {
log.debug("sScan(...) => key -> {}, options -> {}", key, JSON.toJSONString(options));
log.debug("sScan(...) => cursor -> {}", JSON.toJSONString(cursor));
}
return cursor;
}
// ====================== ZSet 相关操作 ======================
// 特别说明: ZSet是有序的,
// 不仅体现在: redis中的存储上有序。
// 还体现在: 此工具类ZSetOps中返回值类型为Set>的方法, 实际返回类型是LinkedHashSet>
// 提示: redis中的ZSet, 一定程度等于redis中的Set + redis中的Hash的结合体。
// 提示: redis中String的数据结构可参考resources/data-structure/ZSet(有序集合)的数据结构(示例一).png
// redis中String的数据结构可参考resources/data-structure/ZSet(有序集合)的数据结构(示例二).png
// 提示: ZSet中的entryKey即为成员项, entryValue即为这个成员项的分值, ZSet根据成员的分值,来堆成员进行排序。
/**
* 向(key对应的)zset中添加(item, score)
*
* 注: item为entryKey成员项, score为entryValue分数值。
*
* 注: 若(key对应的)zset中已存在(与此次要添加的项)相同的item项,那么此次添加操作会失败,返回false;
* 但是!!! zset中原item的score会被更新为此次add的相同item项的score。
* 所以, 也可以通过zAdd达到更新item对应score的目的。
*
* 注: score可为正、可为负、可为0; 总之, double范围内都可以。
*
* 注: 若score的值一样,则按照item排序。
*
* @param key 定位set的key
* @param item 要往(key对应的)zset中添加的成员项
* @param score item的分值
* @return 是否添加成功
* @since 2020/3/11 15:35:30
*/
public boolean zAdd(String key, Object item, double score) {
Boolean result = redisTemplate.opsForZSet().add(key, item, score);
if (log.isDebugEnabled()) {
log.debug("zAdd(...) => key -> {}, item -> {}, score -> {}", key, item, score);
log.debug("zAdd(...) => result -> {}", result);
}
if (result == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return result;
}
/**
* 批量添加entry-
*
* 注: 若entry- 集中存在item相同的项(, score不一样),那么redis在执行真正的批量add操作前,会
* 将其中一个item过滤掉。
* 注: 同样的,若(key对应的)zset中已存在(与此次要添加的项)相同的item项,那么此次批量添加操作中,
* 对该item项的添加会失败,会失败,成功计数器不会加1;但是!!! zset中原item的score会被更新为此
* 次add的相同item项的score。所以, 也可以通过zAdd达到更新item对应score的目的。
*
* @param key 定位set的key
* @param entries 要添加的entry
- 集
* @return 本次添加进(key对应的)zset中的entry的个数
* @since 2020/3/11 16:45:45
*/
public long zAdd(String key, Set
> entries) {
Long count = redisTemplate.opsForZSet().add(key, entries);
if (log.isDebugEnabled()) {
log.debug("zAdd(...) => key -> {}, entries -> {}", key, JSON.toJSONString(entries));
log.debug("zAdd(...) => count -> {}", count);
}
if (count == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return count;
}
/**
* 从(key对应的)zset中移除项
*
* 注:若key不存在,则返回0
*
* @param key 定位set的key
* @param items 要移除的项集
* @return 实际移除了的项的个数
* @since 2020/3/11 17:20:12
*/
public long zRemove(String key, Object... items) {
Long count = redisTemplate.opsForZSet().remove(key, items);
if (log.isDebugEnabled()) {
log.debug("zRemove(...) => key -> {}, items -> {}", key, items);
log.debug("zRemove(...) => count -> {}", count);
}
if (count == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return count;
}
/**
* 移除(key对应的)zset中, 排名范围在[startIndex, endIndex]内的item
*
* 注:默认的,按score.item升序排名, 排名从0开始
*
* 注: 类似于List中的索引, 排名可以分为多个方式:
* 从前到后(正向)的排名: 0、1、2...
* 从后到前(反向)的排名: -1、-2、-3...
*
* 注: 不论是使用正向排名,还是使用反向排名, 使用此方法时, 应保证 startRange代表的元素的位置
* 在endRange代表的元素的位置的前面, 如:
* 示例一: .zRemoveRange("name", 0, 2);
* 示例二: .zRemoveRange("site", -2, -1);
* 示例三: .zRemoveRange("foo", 0, -1);
*
* 注:若key不存在,则返回0
*
* @param key 定位set的key
* @param startRange 开始项的排名
* @param endRange 结尾项的排名
* @return 实际移除了的项的个数
* @since 2020/3/11 17:20:12
*/
public long zRemoveRange(String key, long startRange, long endRange) {
Long count = redisTemplate.opsForZSet().removeRange(key, startRange, endRange);
if (log.isDebugEnabled()) {
log.debug("zRemoveRange(...) => key -> {}, startRange -> {}, endRange -> {}", key, startRange, endRange);
log.debug("zRemoveRange(...) => count -> {}", count);
}
if (count == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return count;
}
/**
* 移除(key对应的)zset中, score范围在[minScore, maxScore]内的item
*
* 提示: 虽然删除范围包含两侧的端点(即:包含minScore和maxScore), 但是由于double存在精度问题,所以建议:
* 设置值时,minScore应该设置得比要删除的项里,最小的score还小一点
* maxScore应该设置得比要删除的项里,最大的score还大一点
* 追注: 本人简单测试了几组数据,暂未出现精度问题。
*
* 注:若key不存在,则返回0
*
* @param key 定位set的key
* @param minScore score下限(含这个值)
* @param maxScore score上限(含这个值)
* @return 实际移除了的项的个数
* @since 2020/3/11 17:20:12
*/
public long zRemoveRangeByScore(String key, double minScore, double maxScore) {
Long count = redisTemplate.opsForZSet().removeRangeByScore(key, minScore, maxScore);
if (log.isDebugEnabled()) {
log.debug("zRemoveRangeByScore(...) => key -> {}, startIndex -> {}, startIndex -> {}", key, minScore, maxScore);
log.debug("zRemoveRangeByScore(...) => count -> {}", count);
}
if (count == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return count;
}
/**
* 增/减 (key对应的zset中,)item的分数值
*
* @param key 定位zset的key
* @param item 项
* @param delta 变化量(正 - 增, 负 - 减)
* @return 修改后的score值
* @since 2020/3/12 8:55:38
*/
public double zIncrementScore(String key, Object item, double delta) {
Double scoreValue = redisTemplate.opsForZSet().incrementScore(key, item, delta);
if (log.isDebugEnabled()) {
log.debug("zIncrementScore(...) => key -> {}, item -> {}, delta -> {}", key, item, delta);
log.debug("zIncrementScore(...) => scoreValue -> {}", scoreValue);
}
if (scoreValue == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return scoreValue;
}
/**
* 返回item在(key对应的)zset中的(按score从小到大的)排名
*
* 注: 排名从0开始。 即意味着,此方法等价于: 返回item在(key对应的)zset中的位置索引。
* 注: 若key或item不存在, 返回null。
* 注: 排序规则是score,item, 即:优先以score排序,若score相同,则再按item排序。
*
* @param key 定位zset的key
* @param item 项
* @return 排名(等价于 : 索引)
* @since 2020/3/12 9:14:09
*/
public long zRank(String key, Object item) {
Long rank = redisTemplate.opsForZSet().rank(key, item);
if (log.isDebugEnabled()) {
log.debug("zRank(...) => key -> {}, item -> {}", key, item);
log.debug("zRank(...) => rank -> {}", rank);
}
if (rank == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return rank;
}
/**
* 返回item在(key对应的)zset中的(按score从大到小的)排名
*
* 注: 排名从0开始。补充: 因为是按score从大到小排序的, 所以最大score对应的item的排名为0。
* 注: 若key或item不存在, 返回null。
* 注: 排序规则是score,item, 即:优先以score排序,若score相同,则再按item排序。
*
* @param key 定位zset的key
* @param item 项
* @return 排名(等价于 : 索引)
* @since 2020/3/12 9:14:09
*/
public long zReverseRank(String key, Object item) {
Long reverseRank = redisTemplate.opsForZSet().reverseRank(key, item);
if (log.isDebugEnabled()) {
log.debug("zReverseRank(...) => key -> {}, item -> {}", key, item);
log.debug("zReverseRank(...) => reverseRank -> {}", reverseRank);
}
if (reverseRank == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return reverseRank;
}
/**
* 根据索引位置, 获取(key对应的)zset中排名处于[start, end]中的item项集
*
* 注: 不论是使用正向排名,还是使用反向排名, 使用此方法时, 应保证 startIndex代表的元素的
* 位置在endIndex代表的元素的位置的前面, 如:
* 示例一: .zRange("name", 0, 2);
* 示例二: .zRange("site", -2, -1);
* 示例三: .zRange("foo", 0, -1);
*
* 注: 若key不存在, 则返回空的集合。
*
* 注: 当[start, end]的范围比实际zset的范围大时, 返回范围上"交集"对应的项集合。
*
* @param key 定位zset的key
* @param start 排名开始位置
* @param end 排名结束位置
* @return 对应的item项集
* @since 2020/3/12 9:50:40
*/
public Set zRange(String key, long start, long end) {
Set result = redisTemplate.opsForZSet().range(key, start, end);
if (log.isDebugEnabled()) {
log.debug("zRange(...) => key -> {}, start -> {}, end -> {}", key, start, end);
log.debug("zRange(...) => result -> {}", result);
}
return result;
}
/**
* 获取(key对应的)zset中的所有item项
*
* @param key 定位zset的键
* @return (key对应的)zset中的所有item项
* @see #zRange(String, long, long)
* @since 2020/3/12 10:02:07
*/
public Set zWholeZSetItem(String key) {
Set result = redisTemplate.opsForZSet().range(key, 0, -1);
if (log.isDebugEnabled()) {
log.debug("zWholeZSetItem(...) => key -> {}", key);
log.debug("zWholeZSetItem(...) => result -> {}", result);
}
return result;
}
/**
* 根据索引位置, 获取(key对应的)zset中排名处于[start, end]中的entry集
*
* 注: 不论是使用正向排名,还是使用反向排名, 使用此方法时, 应保证 startIndex代表的元素的
* 位置在endIndex代表的元素的位置的前面, 如:
* 示例一: .zRange("name", 0, 2);
* 示例二: .zRange("site", -2, -1);
* 示例三: .zRange("foo", 0, -1);
*
* 注: 若key不存在, 则返回空的集合。
*
* 注: 当[start, end]的范围比实际zset的范围大时, 返回范围上"交集"对应的项集合。
*
* 注: 此方法和{@link #zRange(String, long, long)}类似,不过此方法返回的不是item集, 而是entry集
*
* @param key 定位zset的key
* @param start 排名开始位置
* @param end 排名结束位置
* @return 对应的entry集
* @since 2020/3/12 9:50:40
*/
public Set> zRangeWithScores(String key, long start, long end) {
Set> entries = redisTemplate.opsForZSet().rangeWithScores(key, start, end);
if (log.isDebugEnabled()) {
log.debug("zRangeWithScores(...) => key -> {}, start -> {}, end -> {}", key, start, end);
log.debug("zRangeWithScores(...) => entries -> {}", JSON.toJSONString(entries));
}
return entries;
}
/**
* 获取(key对应的)zset中的所有entry
*
* @param key 定位zset的键
* @return (key对应的)zset中的所有entry
* @see #zRangeWithScores(String, long, long)
* @since 2020/3/12 10:02:07
*/
public Set> zWholeZSetEntry(String key) {
Set> entries = redisTemplate.opsForZSet().rangeWithScores(key, 0, -1);
if (log.isDebugEnabled()) {
log.debug("zWholeZSetEntry(...) => key -> {}", key);
log.debug("zWholeZSetEntry(...) => entries -> {}", JSON.toJSONString(entries));
}
return entries;
}
/**
* 根据score, 获取(key对应的)zset中分数值处于[minScore, maxScore]中的item项集
*
* 注: 若key不存在, 则返回空的集合。
* 注: 当[minScore, maxScore]的范围比实际zset中score的范围大时, 返回范围上"交集"对应的项集合。
*
* 提示: 虽然删除范围包含两侧的端点(即:包含minScore和maxScore), 但是由于double存在精度问题,所以建议:
* 设置值时,minScore应该设置得比要删除的项里,最小的score还小一点
* maxScore应该设置得比要删除的项里,最大的score还大一点
* 追注: 本人简单测试了几组数据,暂未出现精度问题。
*
* @param key 定位zset的key
* @param minScore score下限
* @param maxScore score上限
* @return 对应的item项集
* @since 2020/3/12 9:50:40
*/
public Set zRangeByScore(String key, double minScore, double maxScore) {
Set items = redisTemplate.opsForZSet().rangeByScore(key, minScore, maxScore);
if (log.isDebugEnabled()) {
log.debug("zRangeByScore(...) => key -> {}, minScore -> {}, maxScore -> {}", key, minScore, maxScore);
log.debug("zRangeByScore(...) => items -> {}", items);
}
return items;
}
/**
* 根据score, 获取(key对应的)zset中分数值处于[minScore, maxScore]中的, score处于[minScore,
* 排名大于等于offset的count个item项
*
* 特别注意: 对于不是特别熟悉redis的人来说, offset 和 count最好都使用正数, 避免引起理解上的歧义。
*
* 注: 若key不存在, 则返回空的集合。
*
* 提示: 虽然删除范围包含两侧的端点(即:包含minScore和maxScore), 但是由于double存在精度问题,所以建议:
* 设置值时,minScore应该设置得比要删除的项里,最小的score还小一点
* maxScore应该设置得比要删除的项里,最大的score还大一点
* 追注: 本人简单测试了几组数据,暂未出现精度问题。
*
* @param key 定位zset的key
* @param minScore score下限
* @param maxScore score上限
* @param offset 偏移量(即:排名下限)
* @param count 期望获取到的元素个数
* @return 对应的item项集
* @since 2020/3/12 9:50:40
*/
public Set zRangeByScore(String key, double minScore, double maxScore, long offset, long count) {
Set items = redisTemplate.opsForZSet().rangeByScore(key, minScore, maxScore, offset, count);
if (log.isDebugEnabled()) {
log.debug("zRangeByScore(...) => key -> {}, minScore -> {}, maxScore -> {}, offset -> {}, " + "count -> {}", key, minScore, maxScore, offset, count);
log.debug("zRangeByScore(...) => items -> {}", items);
}
return items;
}
/**
* 获取(key对应的)zset中的所有score处于[minScore, maxScore]中的entry
*
* @param key 定位zset的键
* @param minScore score下限
* @param maxScore score上限
* @return (key对应的)zset中的所有score处于[minScore, maxScore]中的entry
* @see #zRangeByScore(String, double, double)
*
* 注: 若key不存在, 则返回空的集合。
* 注: 当[minScore, maxScore]的范围比实际zset中score的范围大时, 返回范围上"交集"对应的项集合。
* @since 2020/3/12 10:02:07
*/
public Set> zRangeByScoreWithScores(String key, double minScore, double maxScore) {
Set> entries = redisTemplate.opsForZSet().rangeByScoreWithScores(key, minScore, maxScore);
if (log.isDebugEnabled()) {
log.debug("zRangeByScoreWithScores(...) => key -> {}, minScore -> {}, maxScore -> {}", key, minScore, maxScore);
log.debug("zRangeByScoreWithScores(...) => entries -> {}", JSON.toJSONString(entries));
}
return entries;
}
/**
* 获取(key对应的)zset中, score处于[minScore, maxScore]里的、排名大于等于offset的count个entry
*
* 特别注意: 对于不是特别熟悉redis的人来说, offset 和 count最好都使用正数, 避免引起理解上的歧义。
*
* @param key 定位zset的键
* @param minScore score下限
* @param maxScore score上限
* @param offset 偏移量(即:排名下限)
* @param count 期望获取到的元素个数
* @return [startIndex, endIndex] & [minScore, maxScore]里的entry
* @since 2020/3/12 11:09:06
*/
public Set> zRangeByScoreWithScores(String key, double minScore, double maxScore, long offset, long count) {
Set> entries = redisTemplate.opsForZSet().rangeByScoreWithScores(key, minScore, maxScore, offset, count);
if (log.isDebugEnabled()) {
log.debug("zRangeByScoreWithScores(...) => key -> {}, minScore -> {}, maxScore -> {}," + " offset -> {}, count -> {}", key, minScore, maxScore, offset, count);
log.debug("zRangeByScoreWithScores(...) => entries -> {}", JSON.toJSONString(entries));
}
return entries;
}
/**
* 获取时, 先按score倒序, 然后根据索引位置, 获取(key对应的)zset中排名处于[start, end]中的item项集
*
* @see #zRange(String, long, long)。 只是zReverseRange这里会提前多一个倒序。
*/
public Set zReverseRange(String key, long start, long end) {
Set entries = redisTemplate.opsForZSet().reverseRange(key, start, end);
if (log.isDebugEnabled()) {
log.debug("zReverseRange(...) => key -> {}, start -> {}, end -> {}", key, start, end);
log.debug("zReverseRange(...) => entries -> {}", entries);
}
return entries;
}
/**
* 获取时, 先按score倒序, 然后根据索引位置, 获取(key对应的)zset中排名处于[start, end]中的entry集
*
* @see #zRangeWithScores(String, long, long)。 只是zReverseRangeWithScores这里会提前多一个倒序。
*/
public Set> zReverseRangeWithScores(String key, long start, long end) {
Set> entries = redisTemplate.opsForZSet().reverseRangeWithScores(key, start, end);
if (log.isDebugEnabled()) {
log.debug("zReverseRangeWithScores(...) => key -> {}, start -> {}, end -> {}", key, start, end);
log.debug("zReverseRangeWithScores(...) => entries -> {}", JSON.toJSONString(entries));
}
return entries;
}
/**
* 获取时, 先按score倒序, 然后根据score, 获取(key对应的)zset中分数值处于[minScore, maxScore]中的item项集
*
* @see #zRangeByScore(String, double, double)。 只是zReverseRangeByScore这里会提前多一个倒序。
*/
public Set zReverseRangeByScore(String key, double minScore, double maxScore) {
Set items = redisTemplate.opsForZSet().reverseRangeByScore(key, minScore, maxScore);
if (log.isDebugEnabled()) {
log.debug("zReverseRangeByScore(...) => key -> {}, minScore -> {}, maxScore -> {}", key, minScore, maxScore);
log.debug("zReverseRangeByScore(...) => items -> {}", items);
}
return items;
}
/**
* 获取时, 先按score倒序, 然后获取(key对应的)zset中的所有score处于[minScore, maxScore]中的entry
*
* @see #zRangeByScoreWithScores(String, double, double)。 只是zReverseRangeByScoreWithScores这里会提前多一个倒序。
*/
public Set> zReverseRangeByScoreWithScores(String key, double minScore, double maxScore) {
Set> entries = redisTemplate.opsForZSet().reverseRangeByScoreWithScores(key, minScore, maxScore);
if (log.isDebugEnabled()) {
log.debug("zReverseRangeByScoreWithScores(...) => key -> {}, minScore -> {}, maxScore -> {}", key, minScore, maxScore);
log.debug("zReverseRangeByScoreWithScores(...) => entries -> {}", JSON.toJSONString(entries));
}
return entries;
}
/**
* 获取时, 先按score倒序, 然后根据score, 获取(key对应的)zset中分数值处于[minScore, maxScore]中的,
* score处于[minScore,排名大于等于offset的count个item项
*
* @see #zRangeByScore(String, double, double, long, long)。 只是zReverseRangeByScore这里会提前多一个倒序。
*/
public Set zReverseRangeByScore(String key, double minScore, double maxScore, long offset, long count) {
Set items = redisTemplate.opsForZSet().reverseRangeByScore(key, minScore, maxScore, offset, count);
if (log.isDebugEnabled()) {
log.debug("zReverseRangeByScore(...) => key -> {}, minScore -> {}, maxScore -> {}, offset -> {}, " + "count -> {}", key, minScore, maxScore, offset, count);
log.debug("items -> {}", items);
}
return items;
}
/**
* 统计(key对应的zset中)score处于[minScore, maxScore]中的item的个数
*
* @param key 定位zset的key
* @param minScore score下限
* @param maxScore score上限
* @return [minScore, maxScore]中item的个数
* @since 2020/3/13 12:20:43
*/
public long zCount(String key, double minScore, double maxScore) {
Long count = redisTemplate.opsForZSet().count(key, minScore, maxScore);
if (log.isDebugEnabled()) {
log.debug("zCount(...) => key -> {}, minScore -> {}, maxScore -> {}", key, minScore, maxScore);
log.debug("zCount(...) => count -> {}", count);
}
if (count == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return count;
}
/**
* 统计(key对应的)zset中item的个数
*
* 注: 此方法等价于{@link #zZCard(String)}
*
* @param key 定位zset的key
* @return zset中item的个数
* @since 2020/3/13 12:20:43
*/
public long zSize(String key) {
Long size = redisTemplate.opsForZSet().size(key);
if (log.isDebugEnabled()) {
log.debug("zSize(...) => key -> {}", key);
log.debug("zSize(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 统计(key对应的)zset中item的个数
*
* 注: 此方法等价于{@link #zSize(String)}
*
* @param key 定位zset的key
* @return zset中item的个数
* @since 2020/3/13 12:20:43
*/
public long zZCard(String key) {
Long size = redisTemplate.opsForZSet().zCard(key);
if (log.isDebugEnabled()) {
log.debug("zZCard(...) => key -> {}", key);
log.debug("zZCard(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 统计(key对应的)zset中指定item的score
*
* @param key 定位zset的key
* @param item zset中的item
* @return item的score
* @since 2020/3/13 14:51:43
*/
public double zScore(String key, Object item) {
Double score = redisTemplate.opsForZSet().score(key, item);
if (log.isDebugEnabled()) {
log.debug("zScore(...) => key -> {}, item -> {}", key, item);
log.debug("zScore(...) => score -> {}", score);
}
if (score == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return score;
}
/**
* 获取两个(key对应的)ZSet的并集, 并将结果add到storeKey对应的ZSet中。
*
* 注: 和set一样,zset中item是唯一的, 在多个zset进行Union时, 处理相同的item时, score的值会变为对应的score之和,如:
* .zAdd("name1", "a", 1);和RedisUtil.ZSetOps.zAdd("name2", "a", 2);
* 对(name1和name2对应的)zset进行zUnionAndStore之后,新的zset中的项a,对应的score值为3
*
* case1: 交集不为空, storeKey不存在, 则 会创建对应的storeKey,并将并集添加到(storeKey对应的)ZSet中
* case2: 交集不为空, storeKey已存在, 则 会清除原(storeKey对应的)ZSet中所有的项,然后将并集添加到(storeKey对应的)ZSet中
* case3: 交集为空, 则不进行下面的操作, 直接返回0
*
* @param key 定位其中一个zset的键
* @param otherKey 定位另外的zset的键
* @param storeKey 定位(要把交集添加到哪个)set的key
* @return add到(storeKey对应的)ZSet后, 该ZSet对应的size
* @since 2020/3/11 12:26:24
*/
public long zUnionAndStore(String key, String otherKey, String storeKey) {
Long size = redisTemplate.opsForZSet().unionAndStore(key, otherKey, storeKey);
if (log.isDebugEnabled()) {
log.debug("zUnionAndStore(...) => key -> {}, otherKey -> {}, storeKey -> {}", key, otherKey, storeKey);
log.debug("zUnionAndStore(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 获取两个(key对应的)ZSet的并集, 并将结果add到storeKey对应的ZSet中。
*
* 注: 和set一样,zset中item是唯一的, 在多个zset进行Union时, 处理相同的item时, score的值会变为对应的score之和,如:
* .zAdd("name1", "a", 1);和RedisUtil.ZSetOps.zAdd("name2", "a", 2);
* 对(name1和name2对应的)zset进行zUnionAndStore之后,新的zset中的项a,对应的score值为3
*
* case1: 并集不为空, storeKey不存在, 则 会创建对应的storeKey,并将并集添加到(storeKey对应的)ZSet中
* case2: 并集不为空, storeKey已存在, 则 会清除原(storeKey对应的)ZSet中所有的项,然后将并集添加到(storeKey对应的)ZSet中
* case3: 并集为空, 则不进行下面的操作, 直接返回0
*
* @param key 定位其中一个set的键
* @param otherKeys 定位其它set的键集
* @param storeKey 定位(要把并集添加到哪个)set的key
* @return add到(storeKey对应的)ZSet后, 该ZSet对应的size
* @since 2020/3/11 12:26:24
*/
public long zUnionAndStore(String key, Collection otherKeys, String storeKey) {
Long size = redisTemplate.opsForZSet().unionAndStore(key, otherKeys, storeKey);
if (log.isDebugEnabled()) {
log.debug("zUnionAndStore(...) => key -> {}, otherKeys -> {}, storeKey -> {}", key, otherKeys, storeKey);
log.debug("zUnionAndStore(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 获取两个(key对应的)ZSet的交集, 并将结果add到storeKey对应的ZSet中。
*
* 注: 和set一样,zset中item是唯一的, 在多个zset进行Intersect时, 处理相同的item时, score的值会变为对应的score之和,如:
* .zAdd("name1", "a", 1);
* .zAdd("name1", "b", 100);
* 和R
* edisUtil.ZSetOps.zAdd("name2", "a", 2);
* edisUtil.ZSetOps.zAdd("name2", "c", 200);
* 对(name1和name2对应的)zset进行zIntersectAndStore之后,新的zset中的项a,对应的score值为3
*
* case1: 交集不为空, storeKey不存在, 则 会创建对应的storeKey,并将交集添加到(storeKey对应的)ZSet中
* case2: 交集不为空, storeKey已存在, 则 会清除原(storeKey对应的)ZSet中所有的项,然后将交集添加到(storeKey对应的)ZSet中
* case3: 交集为空, 则不进行下面的操作, 直接返回0
*
* @param key 定位其中一个ZSet的键
* @param otherKey 定位其中另一个ZSet的键
* @param storeKey 定位(要把交集添加到哪个)ZSet的key
* @return add到(storeKey对应的)ZSet后, 该ZSet对应的size
* @since 2020/3/11 9:46:46
*/
public long zIntersectAndStore(String key, String otherKey, String storeKey) {
Long size = redisTemplate.opsForZSet().intersectAndStore(key, otherKey, storeKey);
if (log.isDebugEnabled()) {
log.debug("zIntersectAndStore(...) => key -> {}, otherKey -> {}, storeKey -> {}", key, otherKey, storeKey);
log.debug("zIntersectAndStore(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
/**
* 获取多个(key对应的)ZSet的交集, 并将结果add到storeKey对应的ZSet中。
*
* case1: 交集不为空, storeKey不存在, 则 会创建对应的storeKey,并将交集添加到(storeKey对应的)ZSet中
* case2: 交集不为空, storeKey已存在, 则 会清除原(storeKey对应的)ZSet中所有的项,然后将交集添加到(storeKey对应的)ZSet中
* case3: 交集为空, 则不进行下面的操作, 直接返回0
*
* @param key 定位其中一个set的键
* @param otherKeys 定位其它set的键集
* @param storeKey 定位(要把并集添加到哪个)set的key
* @return add到(storeKey对应的)ZSet后, 该ZSet对应的size
* @since 2020/3/11 11:04:29
*/
public long zIntersectAndStore(String key, Collection otherKeys, String storeKey) {
Long size = redisTemplate.opsForZSet().intersectAndStore(key, otherKeys, storeKey);
if (log.isDebugEnabled()) {
log.debug("zIntersectAndStore(...) => key -> {}, otherKeys -> {}, storeKey -> {}", key, otherKeys, storeKey);
log.debug("zIntersectAndStore(...) => size -> {}", size);
}
if (size == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return size;
}
// ====================== 分布式锁(单机版) 相关操作 ======================
// 使用方式(示例):
// boolean flag = false;
// String lockName = "sichuan:mianyang:fucheng:ds";
// String lockValue = UUID.randomUUID().toString();
// try {
// // 非阻塞获取(锁的最大存活时间采用默认值)
// flag = .getLock(lockName, lockValue);
// // 非阻塞获取e.g.
// flag = .getLock(lockName, lockValue, 3, TimeUnit.SECONDS);
// // 阻塞获取(锁的最大存活时间采用默认值)
// flag = .getLockUntilTimeout(lockName, lockValue, 2000);
// // 阻塞获取e.g.
// flag = .getLockUntilTimeout(lockName, lockValue, 2, TimeUnit.SECONDS, 2000);
// if (!flag) {
// throw new RuntimeException(" obtain redis-lock[" + lockName + "] fail");
// }
// // your logic
// // ...
// } finally {
// if (flag) {
// .releaseLock(lockName, lockValue);
// }
// }
//
// |--------------------------------------------------------------------------------------------------------------------|
// |单机版分布式锁、集群版分布式锁,特别说明: |
// | - 此锁是针对单机Redis的分布式锁; |
// | - 对于Redis集群而言, 此锁可能存在失效的情况。考虑如下情况: |
// | 首先,当客户端A通过key-value(假设为key名为key123)在Master上获取到一个锁。 |
// | 然后,Master试着把这个数据同步到Slave的时候突然挂了(此时Slave上没有该分布式锁的key123)。 |
// | 接着,Slave变成了Master。 |
// | 不巧的是,客户端B此时也一以相同的key去获取分布式锁; |
// | 因为现在的Master上没有key123代表的分布式锁, |
// | 所以客户端B此时再通过key123去获取分布式锁时, |
// | 就能获取成功。 |
// | 那么此时,客户端A和客户端B同时获取到了同一把分布式锁,分布式锁失效。 |
// | - 在Redis集群模式下,如果需要严格的分布式锁的话,可使用Redlock算法来实现。Redlock算法原理简述: |
// | - 获取分布式锁: |
// | 1. 客户端获取服务器当前的的时间t0。 |
// | 2. 使用相同的key和value依次向5个实例获取锁。 |
// | 注:为了避免在某个redis节点耗时太久而影响到对后面的Redis节点的锁的获取; |
// | 客户端在获取每一个Redis节点的锁的时候,自身需要设置一个较小的等待获取锁超时的时间, |
// | 一旦都在某个节点获取分布式锁的时间超过了超时时间,那么就认为在这个节点获取分布式锁失败, |
// | (不把时间浪费在这一个节点上),继续获取下一个节点的分布式锁。 |
// | 3. 客户端通过当前时间(t1)减去t0,计算(从所有redis节点)获取锁所消耗的总时间t2(注:t2=t1-t0)。 |
// | 只有t2小于锁本身的锁定时长(注:若锁的锁定时长是1小时, 假设下午一点开始上锁,那么锁会在下午两点 |
// | 的时候失效, 而你却在两点后才获取到锁,这个时候已经没意义了),并且,客户端在至少在多半Redis |
// | 节点上获取到锁, 我们才认为分布式锁获取成功。 |
// | 5. 如果锁已经获取,那么 锁的实际有效时长 = 锁的总有效时长 - 获取分布式锁所消耗的时长; 锁的实际有效时长 应保证 > 0。 |
// | 注: 也就是说, 如果获取锁失败,那么 |
// | A. 可能是 获取到的锁的个数,不满足大多数原则。 |
// | B. 也可能是 锁的实际有效时长不大于0。 |
// | - 释放分布式锁: 在每个redis节点上试着删除锁(, 不论有没有在该节点上获取到锁)。 |
// | - 集群下的分布式锁,可直接使用现有类库 |
// | |
// | 注: 如果Redis集群项目能够容忍master宕机导致单机版分布式锁失效的情况的话,那么是直接使用单机版分布式锁在Redis集群的项目中的; |
// | 如果Redis集群项目不能容忍单机版分布式锁失效的情况的话,那么请使用基于RedLock算法的集群版分布式锁; |
// |--------------------------------------------------------------------------------------------------------------------|
/**
* 获取(分布式)锁.
*
* 注: 获取结果是即时返回的、是非阻塞的。
*
* @see #getLock(String, String, long, TimeUnit)
*/
public boolean getLock(final String key, final String value) {
return getLock(key, value, DEFAULT_LOCK_TIMEOUT, DEFAULT_TIMEOUT_UNIT);
}
/**
* 获取(分布式)锁。
* 若成功, 则直接返回;
* 若失败, 则进行重试, 直到成功 或 超时为止。
*
* 注: 获取结果是阻塞的, 要么成功, 要么超时, 才返回。
*
* @param retryTimeoutLimit 重试的超时时长(ms)
* 其它参数可详见:
* @return 是否成功
* @see #getLock(String, String, long, TimeUnit)
*/
public boolean getLockUntilTimeout(final String key, final String value, final long retryTimeoutLimit) {
return getLockUntilTimeout(key, value, DEFAULT_LOCK_TIMEOUT, DEFAULT_TIMEOUT_UNIT, retryTimeoutLimit);
}
/**
* 获取(分布式)锁。
* 若成功, 则直接返回;
* 若失败, 则进行重试, 直到成功 或 超时为止。
*
* 注: 获取结果是阻塞的, 要么成功, 要么超时, 才返回。
*
* @param retryTimeoutLimit 重试的超时时长(ms)
* 其它参数可详见:
* @return 是否成功
* @see #getLock(String, String, long, TimeUnit, boolean)
*/
public boolean getLockUntilTimeout(final String key, final String value, final long timeout, final TimeUnit unit, final long retryTimeoutLimit) {
if (log.isDebugEnabled()) {
log.debug("getLockUntilTimeout(...) => key -> {}, value -> {}, timeout -> {}, unit -> {}, " + "retryTimeoutLimit -> {}ms", key, value, timeout, unit, retryTimeoutLimit);
}
long startTime = Instant.now().toEpochMilli();
long now = startTime;
do {
try {
boolean alreadyGotLock = getLock(key, value, timeout, unit, false);
if (alreadyGotLock) {
if (log.isDebugEnabled()) {
log.debug("getLockUntilTimeout(...) => consume time -> {}ms, result -> true", now - startTime);
}
return true;
}
} catch (Exception e) {
log.warn("getLockUntilTimeout(...) => try to get lock failure! e.getMessage -> {}", e.getMessage());
}
now = Instant.now().toEpochMilli();
} while (now < startTime + retryTimeoutLimit);
if (log.isDebugEnabled()) {
log.debug("getLockUntilTimeout(...) => consume time -> {}ms, result -> false", now - startTime);
}
return false;
}
/**
* 获取(分布式)锁
*
* 注: 获取结果是即时返回的、是非阻塞的。
*
* @see #getLock(String, String, long, TimeUnit, boolean)
*/
public boolean getLock(final String key, final String value, final long timeout, final TimeUnit unit) {
return getLock(key, value, timeout, unit, true);
}
/**
* 获取(分布式)锁
*
* 注: 获取结果是即时返回的、是非阻塞的。
*
* @param key 锁名
* @param value 锁名对应的value
* 注: value一般采用全局唯一的值, 如: requestId、uuid等。
* 这样, 释放锁的时候, 可以再次验证value值,
* 保证自己上的锁只能被自己释放, 而不会被别人释放。
* 当然, 如果锁超时时, 会被redis自动删除释放。
* @param timeout 锁的(最大)存活时长
* 注: 一般的, 获取锁与释放锁 都是成对使用的, 在锁在达到(最大)存活时长之前,都会被主动释放。
* 但是在某些情况下(如:程序获取锁后,释放锁前,崩了),锁得不到释放, 这时就需要等锁过
* 了(最大)存活时长后,被redis自动删除清理了。这样就能保证redis中不会留下死数据。
* @param unit timeout的单位
* @param recordLog 是否记录日志
* @return 是否成功
*/
public boolean getLock(final String key, final String value, final long timeout, final TimeUnit unit, boolean recordLog) {
if (recordLog) {
log.debug("getLock(...) => key -> {}, value -> {}, timeout -> {}, unit -> {}", key, value, timeout, unit);
}
Boolean result = redisTemplate.execute((RedisConnection connection) -> connection.set(key.getBytes(StandardCharsets.UTF_8), value.getBytes(StandardCharsets.UTF_8), Expiration.seconds(unit.toSeconds(timeout)), RedisStringCommands.SetOption.SET_IF_ABSENT));
if (recordLog) {
log.debug("getLock(...) => result -> {}", result);
}
if (result == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return result;
}
/**
* 释放(分布式)锁
*
* 注: 此方式能(通过value的唯一性)保证: 自己加的锁, 只能被自己释放。
* 注: 锁超时时, 也会被redis自动删除释放。
*
* @param key 锁名
* @param value 锁名对应的value
* @return 释放锁是否成功
* @since 2020/3/15 17:00:45
*/
public boolean releaseLock(final String key, final String value) {
Boolean result = redisTemplate.execute((RedisConnection connection) -> connection.eval(RELEASE_LOCK_LUA.getBytes(), ReturnType.BOOLEAN, 1, key.getBytes(StandardCharsets.UTF_8), value.getBytes(StandardCharsets.UTF_8)));
if (log.isDebugEnabled()) {
log.debug("releaseLock(...) => key -> {}, lockValue -> {}", key, value);
log.debug("releaseLock(...) => result -> {}", result);
}
if (result == null) {
BaseErrorEnum.INVALID_REDIS_RESULT_ERROR.throwException();
}
return result;
}
/**
* 提供一些基础功能支持
*
* @author JustryDeng
* @since 2020/3/16 0:48:14
*/
public static class Helper {
/**
* 默认拼接符
*/
public static final String DEFAULT_SYMBOL = ":";
/**
* 拼接args
*
* @see RedisHelper.Helper#joinBySymbol(String, String...)
*/
public static String join(String... args) {
return RedisHelper.Helper.joinBySymbol(DEFAULT_SYMBOL, args);
}
/**
* 使用symbol拼接args
*
* @param symbol 分隔符, 如: 【:】
* @param args 要拼接的元素数组, 如: 【a b c】
* @return 拼接后的字符串, 如 【a:b:c】
* @since 2019/9/8 16:11
*/
public static String joinBySymbol(String symbol, String... args) {
if (symbol == null || symbol.trim().length() == 0) {
throw new RuntimeException(" symbol must not be empty!");
}
if (args == null || args.length == 0) {
throw new RuntimeException(" args must not be empty!");
}
StringBuilder sb = new StringBuilder(16);
for (String arg : args) {
sb.append(arg).append(symbol);
}
sb.replace(sb.length() - symbol.length(), sb.length(), "");
return sb.toString();
}
}
}