package com.zy.common.utils;
|
|
import lombok.extern.slf4j.Slf4j;
|
import org.springframework.beans.factory.annotation.Autowired;
|
import org.springframework.data.redis.core.RedisTemplate;
|
import org.springframework.stereotype.Component;
|
import org.springframework.util.CollectionUtils;
|
|
import java.util.ArrayList;
|
import java.util.HashMap;
|
import java.util.HashSet;
|
import java.util.List;
|
import java.util.Map;
|
import java.util.Set;
|
import java.util.concurrent.ConcurrentHashMap;
|
import java.util.concurrent.TimeUnit;
|
import java.util.regex.Pattern;
|
|
/**
|
* redisTemplate封装
|
*
|
*/
|
@Slf4j
|
@Component
|
public class RedisUtil {
|
|
private static final long LOCAL_NO_EXPIRE = Long.MAX_VALUE;
|
/** 无 TTL 写入 Redis 失败时，内存条目默认保留时长（秒） */
|
private static final long LOCAL_DEFAULT_TTL_SEC = 86400L;
|
|
// @Autowired
|
// private RedisTemplate<String, Object> redisTemplate;
|
|
@Autowired
|
private RedisTemplate redisTemplate;
|
|
private final ConcurrentHashMap<String, LocalCacheEntry> localCache = new ConcurrentHashMap<>();
|
private final Object fallbackLock = new Object();
|
private volatile boolean redisFallbackMode = false;
|
private final Set<String> fallbackLocalKeys = ConcurrentHashMap.newKeySet();
|
|
public RedisTemplate getRedisTemplate() {
|
return redisTemplate;
|
}
|
|
public RedisUtil(RedisTemplate redisTemplate) {
|
this.redisTemplate = redisTemplate;
|
}
|
|
/**
|
* 指定缓存失效时间
|
*
|
* @param key 键
|
* @param time 时间(秒)
|
* @return
|
*/
|
public boolean expire(String key, long time) {
|
try {
|
if (time > 0) {
|
redisTemplate.expire(key, time, TimeUnit.SECONDS);
|
}
|
return true;
|
} catch (Exception e) {
|
e.printStackTrace();
|
return false;
|
}
|
}
|
|
/**
|
* 根据key 获取过期时间
|
*
|
* @param key 键 不能为null
|
* @return 时间(秒) 返回0代表为永久有效
|
*/
|
public long getExpire(String key) {
|
return redisTemplate.getExpire(key, TimeUnit.SECONDS);
|
}
|
|
/**
|
* 判断key是否存在
|
*
|
* @param key 键
|
* @return true 存在 false不存在
|
*/
|
public boolean hasKey(String key) {
|
try {
|
return redisTemplate.hasKey(key);
|
} catch (Exception e) {
|
e.printStackTrace();
|
return localHasValid(key);
|
}
|
}
|
|
/**
|
* 删除缓存
|
*
|
* @param key 可以传一个值 或多个
|
*/
|
@SuppressWarnings("unchecked")
|
public void del(String... key) {
|
if (key != null && key.length > 0) {
|
try {
|
if (key.length == 1) {
|
redisTemplate.delete(key[0]);
|
} else {
|
redisTemplate.delete(CollectionUtils.arrayToList(key));
|
}
|
} catch (Exception e) {
|
// Redis 不可用时仍清理本地条目
|
}
|
for (String k : key) {
|
if (k != null) {
|
localCache.remove(k);
|
}
|
}
|
}
|
}
|
|
//============================ String =============================
|
|
/**
|
* 普通缓存获取
|
*
|
* @param key 键
|
* @return 值
|
*/
|
public Object get(String key) {
|
if (key == null) {
|
return null;
|
}
|
try {
|
Object v = redisTemplate.opsForValue().get(key);
|
notifyRedisAvailable();
|
return v;
|
} catch (Exception e) {
|
enterFallbackIfNeeded();
|
log.info("Redis 不可用，从 JVM 内存读取 key={}，原因: {}", key, e.getMessage());
|
return localGet(key);
|
}
|
}
|
|
/**
|
* 获取全部数据
|
* @return
|
*/
|
public HashMap<Object, Object> getRedis() {
|
Set<String> keys = redisTemplate.keys("*");
|
HashMap<Object, Object> map = new HashMap<>();
|
for (String key : keys) {
|
Object value = redisTemplate.opsForValue().get(key);
|
map.put(key, value);
|
}
|
|
return map;//返回全部数据集合
|
}
|
|
/**
|
* 普通缓存放入
|
*
|
* @param key 键
|
* @param value 值
|
* @return true成功 false失败
|
*/
|
public boolean set(String key, Object value) {
|
try {
|
redisTemplate.opsForValue().set(key, value);
|
long start = System.currentTimeMillis();
|
while (System.currentTimeMillis() - start < 10000) {//有效期10s
|
Object o = redisTemplate.opsForValue().get(key);
|
if (o == null) {
|
continue;
|
}
|
|
if (o.equals(value)) {
|
break;
|
}
|
}
|
localCache.remove(key);
|
notifyRedisAvailable();
|
return true;
|
} catch (Exception e) {
|
log.debug("Redis set 失败", e);
|
localPutFallback(key, value, LOCAL_DEFAULT_TTL_SEC);
|
return true;
|
}
|
}
|
|
/**
|
* 普通缓存放入-异步
|
*
|
* @param key 键
|
* @param value 值
|
* @return true成功 false失败
|
*/
|
public boolean setAsync(String key, Object value) {
|
try {
|
redisTemplate.opsForValue().set(key, value);
|
localCache.remove(key);
|
notifyRedisAvailable();
|
return true;
|
} catch (Exception e) {
|
log.debug("Redis setAsync 失败", e);
|
localPutFallback(key, value, LOCAL_DEFAULT_TTL_SEC);
|
return true;
|
}
|
}
|
|
/**
|
* 普通缓存放入并设置时间
|
*
|
* @param key 键
|
* @param value 值
|
* @param time 时间(秒) time要大于0 如果time小于等于0 将设置无限期
|
* @return true成功 false 失败
|
*/
|
public boolean set(String key, Object value, long time) {
|
try {
|
if (time > 0) {
|
redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);
|
} else {
|
set(key, value);
|
return true;
|
}
|
localCache.remove(key);
|
notifyRedisAvailable();
|
return true;
|
} catch (Exception e) {
|
log.debug("Redis set(expire) 失败", e);
|
long ttl = time > 0 ? time : LOCAL_DEFAULT_TTL_SEC;
|
localPutFallback(key, value, ttl);
|
return true;
|
}
|
}
|
|
/**
|
* 递增
|
*
|
* @param key 键
|
* @param delta 要增加几(大于0)
|
* @return
|
*/
|
public long incr(String key, long delta) {
|
if (delta < 0) {
|
throw new RuntimeException("递增因子必须大于0");
|
}
|
return redisTemplate.opsForValue().increment(key, delta);
|
}
|
|
/**
|
* 递减
|
*
|
* @param key 键
|
* @param delta 要减少几(小于0)
|
* @return
|
*/
|
public long decr(String key, long delta) {
|
if (delta < 0) {
|
throw new RuntimeException("递减因子必须大于0");
|
}
|
return redisTemplate.opsForValue().increment(key, -delta);
|
}
|
|
//================================ Hash =================================
|
|
/**
|
* HashGet
|
*
|
* @param key 键 不能为null
|
* @param item 项 不能为null
|
* @return 值
|
*/
|
public Object hget(String key, String item) {
|
return redisTemplate.opsForHash().get(key, item);
|
}
|
|
/**
|
* 获取hashKey对应的所有键值
|
*
|
* @param key 键
|
* @return 对应的多个键值
|
*/
|
public Map<Object, Object> hmget(String key) {
|
return redisTemplate.opsForHash().entries(key);
|
}
|
|
/**
|
* HashSet
|
*
|
* @param key 键
|
* @param map 对应多个键值
|
* @return true 成功 false 失败
|
*/
|
public boolean hmset(String key, Map<String, Object> map) {
|
try {
|
redisTemplate.opsForHash().putAll(key, map);
|
return true;
|
} catch (Exception e) {
|
e.printStackTrace();
|
return false;
|
}
|
}
|
|
/**
|
* HashSet 并设置时间
|
*
|
* @param key 键
|
* @param map 对应多个键值
|
* @param time 时间(秒)
|
* @return true成功 false失败
|
*/
|
public boolean hmset(String key, Map<String, Object> map, long time) {
|
try {
|
redisTemplate.opsForHash().putAll(key, map);
|
if (time > 0) {
|
expire(key, time);
|
}
|
return true;
|
} catch (Exception e) {
|
e.printStackTrace();
|
return false;
|
}
|
}
|
|
/**
|
* 向一张hash表中放入数据,如果不存在将创建
|
*
|
* @param key 键
|
* @param item 项
|
* @param value 值
|
* @return true 成功 false失败
|
*/
|
public boolean hset(String key, String item, Object value) {
|
try {
|
redisTemplate.opsForHash().put(key, item, value);
|
return true;
|
} catch (Exception e) {
|
e.printStackTrace();
|
return false;
|
}
|
}
|
|
/**
|
* 向一张hash表中放入数据,如果不存在将创建
|
*
|
* @param key 键
|
* @param item 项
|
* @param value 值
|
* @param time 时间(秒) 注意:如果已存在的hash表有时间,这里将会替换原有的时间
|
* @return true 成功 false失败
|
*/
|
public boolean hset(String key, String item, Object value, long time) {
|
try {
|
redisTemplate.opsForHash().put(key, item, value);
|
if (time > 0) {
|
expire(key, time);
|
}
|
return true;
|
} catch (Exception e) {
|
e.printStackTrace();
|
return false;
|
}
|
}
|
|
/**
|
* 删除hash表中的值
|
*
|
* @param key 键 不能为null
|
* @param item 项 可以使多个 不能为null
|
*/
|
public void hdel(String key, Object... item) {
|
redisTemplate.opsForHash().delete(key, item);
|
}
|
|
/**
|
* 判断hash表中是否有该项的值
|
*
|
* @param key 键 不能为null
|
* @param item 项 不能为null
|
* @return true 存在 false不存在
|
*/
|
public boolean hHasKey(String key, String item) {
|
return redisTemplate.opsForHash().hasKey(key, item);
|
}
|
|
/**
|
* hash递增 如果不存在,就会创建一个 并把新增后的值返回
|
*
|
* @param key 键
|
* @param item 项
|
* @param by 要增加几(大于0)
|
* @return
|
*/
|
public double hincr(String key, String item, double by) {
|
return redisTemplate.opsForHash().increment(key, item, by);
|
}
|
|
/**
|
* hash递减
|
*
|
* @param key 键
|
* @param item 项
|
* @param by 要减少记(小于0)
|
* @return
|
*/
|
public double hdecr(String key, String item, double by) {
|
return redisTemplate.opsForHash().increment(key, item, -by);
|
}
|
|
//============================ set =============================
|
|
/**
|
* 根据key获取Set中的所有值
|
*
|
* @param key 键
|
* @return
|
*/
|
public Set<Object> sGet(String key) {
|
try {
|
return redisTemplate.opsForSet().members(key);
|
} catch (Exception e) {
|
e.printStackTrace();
|
return null;
|
}
|
}
|
|
/**
|
* 根据value从一个set中查询,是否存在
|
*
|
* @param key 键
|
* @param value 值
|
* @return true 存在 false不存在
|
*/
|
public boolean sHasKey(String key, Object value) {
|
try {
|
return redisTemplate.opsForSet().isMember(key, value);
|
} catch (Exception e) {
|
e.printStackTrace();
|
return false;
|
}
|
}
|
|
/**
|
* 将数据放入set缓存
|
*
|
* @param key 键
|
* @param values 值 可以是多个
|
* @return 成功个数
|
*/
|
public long sSet(String key, Object... values) {
|
try {
|
return redisTemplate.opsForSet().add(key, values);
|
} catch (Exception e) {
|
e.printStackTrace();
|
return 0;
|
}
|
}
|
|
/**
|
* 将set数据放入缓存
|
*
|
* @param key 键
|
* @param time 时间(秒)
|
* @param values 值 可以是多个
|
* @return 成功个数
|
*/
|
public long sSetAndTime(String key, long time, Object... values) {
|
try {
|
Long count = redisTemplate.opsForSet().add(key, values);
|
if (time > 0) {
|
expire(key, time);
|
}
|
return count;
|
} catch (Exception e) {
|
e.printStackTrace();
|
return 0;
|
}
|
}
|
|
/**
|
* 获取set缓存的长度
|
*
|
* @param key 键
|
* @return
|
*/
|
public long sGetSetSize(String key) {
|
try {
|
return redisTemplate.opsForSet().size(key);
|
} catch (Exception e) {
|
e.printStackTrace();
|
return 0;
|
}
|
}
|
|
/**
|
* 移除值为value的
|
*
|
* @param key 键
|
* @param values 值 可以是多个
|
* @return 移除的个数
|
*/
|
public long setRemove(String key, Object... values) {
|
try {
|
Long count = redisTemplate.opsForSet().remove(key, values);
|
return count;
|
} catch (Exception e) {
|
e.printStackTrace();
|
return 0;
|
}
|
}
|
//===============================list=================================
|
|
/**
|
* 获取list缓存的内容
|
*
|
* @param key 键
|
* @param start 开始
|
* @param end 结束 0 到 -1代表所有值
|
* @return
|
*/
|
public List<Object> lGet(String key, long start, long end) {
|
try {
|
return redisTemplate.opsForList().range(key, start, end);
|
} catch (Exception e) {
|
e.printStackTrace();
|
return null;
|
}
|
}
|
|
/**
|
* 获取list缓存的长度
|
*
|
* @param key 键
|
* @return
|
*/
|
public long lGetListSize(String key) {
|
try {
|
return redisTemplate.opsForList().size(key);
|
} catch (Exception e) {
|
e.printStackTrace();
|
return 0;
|
}
|
}
|
|
/**
|
* 通过索引 获取list中的值
|
*
|
* @param key 键
|
* @param index 索引 index>=0时， 0 表头，1 第二个元素，依次类推；index<0时，-1，表尾，-2倒数第二个元素，依次类推
|
* @return
|
*/
|
public Object lGetIndex(String key, long index) {
|
try {
|
return redisTemplate.opsForList().index(key, index);
|
} catch (Exception e) {
|
e.printStackTrace();
|
return null;
|
}
|
}
|
|
/**
|
* 将list放入缓存
|
*
|
* @param key 键
|
* @param value 值
|
* @return
|
*/
|
public boolean lSet(String key, Object value) {
|
try {
|
redisTemplate.opsForList().rightPush(key, value);
|
return true;
|
} catch (Exception e) {
|
e.printStackTrace();
|
return false;
|
}
|
}
|
|
/**
|
* 将list放入缓存
|
*
|
* @param key 键
|
* @param value 值
|
* @param time 时间(秒)
|
* @return
|
*/
|
public boolean lSet(String key, Object value, long time) {
|
try {
|
redisTemplate.opsForList().rightPush(key, value);
|
if (time > 0) {
|
expire(key, time);
|
}
|
return true;
|
} catch (Exception e) {
|
e.printStackTrace();
|
return false;
|
}
|
}
|
|
/**
|
* 将list放入缓存
|
*
|
* @param key 键
|
* @param value 值
|
* @return
|
*/
|
public boolean lSet(String key, List<Object> value) {
|
try {
|
redisTemplate.opsForList().rightPushAll(key, value);
|
return true;
|
} catch (Exception e) {
|
e.printStackTrace();
|
return false;
|
}
|
}
|
|
/**
|
* 将list放入缓存
|
*
|
* @param key 键
|
* @param value 值
|
* @param time 时间(秒)
|
* @return
|
*/
|
public boolean lSet(String key, List<Object> value, long time) {
|
try {
|
redisTemplate.opsForList().rightPushAll(key, value);
|
if (time > 0) {
|
expire(key, time);
|
}
|
return true;
|
} catch (Exception e) {
|
e.printStackTrace();
|
return false;
|
}
|
}
|
|
/**
|
* 根据索引修改list中的某条数据
|
*
|
* @param key 键
|
* @param index 索引
|
* @param value 值
|
* @return
|
*/
|
public boolean lUpdateIndex(String key, long index, Object value) {
|
try {
|
redisTemplate.opsForList().set(key, index, value);
|
return true;
|
} catch (Exception e) {
|
e.printStackTrace();
|
return false;
|
}
|
}
|
|
/**
|
* 移除N个值为value
|
*
|
* @param key 键
|
* @param count 移除多少个
|
* @param value 值
|
* @return 移除的个数
|
*/
|
public long lRemove(String key, long count, Object value) {
|
try {
|
Long remove = redisTemplate.opsForList().remove(key, count, value);
|
return remove;
|
} catch (Exception e) {
|
e.printStackTrace();
|
return 0;
|
}
|
}
|
|
/**
|
* 模糊查询获取key值
|
*
|
* @param pattern
|
* @return
|
*/
|
public Set keys(String pattern) {
|
try {
|
Set<?> s = redisTemplate.keys(pattern);
|
notifyRedisAvailable();
|
return s;
|
} catch (Exception e) {
|
enterFallbackIfNeeded();
|
log.info("Redis 不可用，从 JVM 内存匹配 keys，pattern={}，原因: {}", pattern, e.getMessage());
|
return localKeysMatching(pattern);
|
}
|
}
|
|
/**
|
* 使用Redis的消息队列
|
*
|
* @param channel
|
* @param message 消息内容
|
*/
|
public void convertAndSend(String channel, Object message) {
|
redisTemplate.convertAndSend(channel, message);
|
}
|
|
private void enterFallbackIfNeeded() {
|
synchronized (fallbackLock) {
|
if (!redisFallbackMode) {
|
redisFallbackMode = true;
|
log.warn("Redis 不可用，字符串相关缓存将暂存于 JVM 内存，待 Redis 恢复后自动切回 Redis 并清理上述键");
|
}
|
}
|
}
|
|
private void notifyRedisAvailable() {
|
if (!redisFallbackMode && fallbackLocalKeys.isEmpty()) {
|
return;
|
}
|
synchronized (fallbackLock) {
|
if (!redisFallbackMode && fallbackLocalKeys.isEmpty()) {
|
return;
|
}
|
int n = fallbackLocalKeys.size();
|
for (String k : new ArrayList<>(fallbackLocalKeys)) {
|
localCache.remove(k);
|
}
|
fallbackLocalKeys.clear();
|
redisFallbackMode = false;
|
if (n > 0) {
|
log.info("Redis 已恢复，已清理 JVM 内存中 {} 个因 Redis 不可用而暂存的键", n);
|
} else {
|
log.info("Redis 已恢复");
|
}
|
}
|
}
|
|
private void localPutFallback(String key, Object value, long ttlSeconds) {
|
if (key == null) {
|
return;
|
}
|
synchronized (fallbackLock) {
|
if (!redisFallbackMode) {
|
redisFallbackMode = true;
|
log.warn("Redis 不可用，字符串相关缓存将暂存于 JVM 内存，待 Redis 恢复后自动切回 Redis 并清理上述键");
|
}
|
fallbackLocalKeys.add(key);
|
localPut(key, value, ttlSeconds);
|
}
|
log.info("Redis 不可用，键已写入 JVM 内存: {}", key);
|
}
|
|
private void localPut(String key, Object value, long ttlSeconds) {
|
if (key == null) {
|
return;
|
}
|
long expireAt = ttlSeconds > 0
|
? System.currentTimeMillis() + TimeUnit.SECONDS.toMillis(ttlSeconds)
|
: LOCAL_NO_EXPIRE;
|
localCache.put(key, new LocalCacheEntry(value, expireAt));
|
}
|
|
private Object localGet(String key) {
|
LocalCacheEntry e = localCache.get(key);
|
if (e == null) {
|
return null;
|
}
|
if (e.expireAtMillis != LOCAL_NO_EXPIRE && System.currentTimeMillis() > e.expireAtMillis) {
|
localCache.remove(key, e);
|
return null;
|
}
|
return e.value;
|
}
|
|
private boolean localHasValid(String key) {
|
return localGet(key) != null;
|
}
|
|
private Set<String> localKeysMatching(String pattern) {
|
if (pattern == null) {
|
return new HashSet<>();
|
}
|
Pattern p = Pattern.compile(globToRegex(pattern));
|
Set<String> out = new HashSet<>();
|
for (String k : localCache.keySet()) {
|
if (localGet(k) == null) {
|
continue;
|
}
|
if (p.matcher(k).matches()) {
|
out.add(k);
|
}
|
}
|
return out;
|
}
|
|
private static String globToRegex(String glob) {
|
StringBuilder sb = new StringBuilder("^");
|
for (int i = 0; i < glob.length(); i++) {
|
char c = glob.charAt(i);
|
if (c == '*') {
|
sb.append(".*");
|
} else if (c == '?') {
|
sb.append('.');
|
} else if ("\\.[]{}()+-^$|".indexOf(c) >= 0) {
|
sb.append('\\').append(c);
|
} else {
|
sb.append(c);
|
}
|
}
|
sb.append('$');
|
return sb.toString();
|
}
|
|
private static final class LocalCacheEntry {
|
final Object value;
|
final long expireAtMillis;
|
|
LocalCacheEntry(Object value, long expireAtMillis) {
|
this.value = value;
|
this.expireAtMillis = expireAtMillis;
|
}
|
}
|
|
}
|
