package com.ruoyi.common.core.redis;
|
|
import java.util.*;
|
import java.util.concurrent.TimeUnit;
|
import org.springframework.beans.factory.annotation.Autowired;
|
import org.springframework.data.redis.core.BoundSetOperations;
|
import org.springframework.data.redis.core.HashOperations;
|
import org.springframework.data.redis.core.RedisTemplate;
|
import org.springframework.data.redis.core.ValueOperations;
|
import org.springframework.data.redis.core.script.DefaultRedisScript;
|
import org.springframework.data.redis.core.script.RedisScript;
|
import org.springframework.stereotype.Component;
|
|
/**
|
* spring redis 工具类
|
*
|
* @author ruoyi
|
**/
|
@SuppressWarnings(value = { "unchecked", "rawtypes" })
|
@Component
|
public class RedisCache
|
{
|
private static final String LOCK_PREFIX = "lock:";
|
private static final RedisScript<Long> UNLOCK_SCRIPT = new DefaultRedisScript<>(
|
"if redis.call('get', KEYS[1]) == ARGV[1] then " +
|
" return redis.call('del', KEYS[1]) " +
|
"else " +
|
" return 0 " +
|
"end",
|
Long.class
|
);
|
@Autowired
|
public RedisTemplate redisTemplate;
|
|
/**
|
* 缓存基本的对象，Integer、String、实体类等
|
*
|
* @param key 缓存的键值
|
* @param value 缓存的值
|
*/
|
public <T> void setCacheObject(final String key, final T value)
|
{
|
redisTemplate.opsForValue().set(key, value);
|
}
|
|
/**
|
* 缓存基本的对象，Integer、String、实体类等
|
*
|
* @param key 缓存的键值
|
* @param value 缓存的值
|
* @param timeout 时间
|
* @param timeUnit 时间颗粒度
|
*/
|
public <T> void setCacheObject(final String key, final T value, final Integer timeout, final TimeUnit timeUnit)
|
{
|
redisTemplate.opsForValue().set(key, value, timeout, timeUnit);
|
}
|
|
/**
|
* 设置有效时间
|
*
|
* @param key Redis键
|
* @param timeout 超时时间
|
* @return true=设置成功；false=设置失败
|
*/
|
public boolean expire(final String key, final long timeout)
|
{
|
return expire(key, timeout, TimeUnit.SECONDS);
|
}
|
|
/**
|
* 设置有效时间
|
*
|
* @param key Redis键
|
* @param timeout 超时时间
|
* @param unit 时间单位
|
* @return true=设置成功；false=设置失败
|
*/
|
public boolean expire(final String key, final long timeout, final TimeUnit unit)
|
{
|
return redisTemplate.expire(key, timeout, unit);
|
}
|
|
/**
|
* 获取有效时间
|
*
|
* @param key Redis键
|
* @return 有效时间
|
*/
|
public long getExpire(final String key)
|
{
|
return redisTemplate.getExpire(key);
|
}
|
|
/**
|
* 判断 key是否存在
|
*
|
* @param key 键
|
* @return true 存在 false不存在
|
*/
|
public Boolean hasKey(String key)
|
{
|
return redisTemplate.hasKey(key);
|
}
|
|
/**
|
* 获得缓存的基本对象。
|
*
|
* @param key 缓存键值
|
* @return 缓存键值对应的数据
|
*/
|
public <T> T getCacheObject(final String key)
|
{
|
ValueOperations<String, T> operation = redisTemplate.opsForValue();
|
return operation.get(key);
|
}
|
|
/**
|
* 删除单个对象
|
*
|
* @param key
|
*/
|
public boolean deleteObject(final String key)
|
{
|
return redisTemplate.delete(key);
|
}
|
|
/**
|
* 删除集合对象
|
*
|
* @param collection 多个对象
|
* @return
|
*/
|
public boolean deleteObject(final Collection collection)
|
{
|
return redisTemplate.delete(collection) > 0;
|
}
|
|
/**
|
* 缓存List数据
|
*
|
* @param key 缓存的键值
|
* @param dataList 待缓存的List数据
|
* @return 缓存的对象
|
*/
|
public <T> long setCacheList(final String key, final List<T> dataList)
|
{
|
Long count = redisTemplate.opsForList().rightPushAll(key, dataList);
|
return count == null ? 0 : count;
|
}
|
|
/**
|
* 获得缓存的list对象
|
*
|
* @param key 缓存的键值
|
* @return 缓存键值对应的数据
|
*/
|
public <T> List<T> getCacheList(final String key)
|
{
|
return redisTemplate.opsForList().range(key, 0, -1);
|
}
|
|
/**
|
* 缓存Set
|
*
|
* @param key 缓存键值
|
* @param dataSet 缓存的数据
|
* @return 缓存数据的对象
|
*/
|
public <T> BoundSetOperations<String, T> setCacheSet(final String key, final Set<T> dataSet)
|
{
|
BoundSetOperations<String, T> setOperation = redisTemplate.boundSetOps(key);
|
Iterator<T> it = dataSet.iterator();
|
while (it.hasNext())
|
{
|
setOperation.add(it.next());
|
}
|
return setOperation;
|
}
|
|
/**
|
* 获得缓存的set
|
*
|
* @param key
|
* @return
|
*/
|
public <T> Set<T> getCacheSet(final String key)
|
{
|
return redisTemplate.opsForSet().members(key);
|
}
|
|
/**
|
* 缓存Map
|
*
|
* @param key
|
* @param dataMap
|
*/
|
public <T> void setCacheMap(final String key, final Map<String, T> dataMap)
|
{
|
if (dataMap != null) {
|
redisTemplate.opsForHash().putAll(key, dataMap);
|
}
|
}
|
|
/**
|
* 获得缓存的Map
|
*
|
* @param key
|
* @return
|
*/
|
public <T> Map<String, T> getCacheMap(final String key)
|
{
|
return redisTemplate.opsForHash().entries(key);
|
}
|
|
/**
|
* 往Hash中存入数据
|
*
|
* @param key Redis键
|
* @param hKey Hash键
|
* @param value 值
|
*/
|
public <T> void setCacheMapValue(final String key, final String hKey, final T value)
|
{
|
redisTemplate.opsForHash().put(key, hKey, value);
|
}
|
|
/**
|
* 获取Hash中的数据
|
*
|
* @param key Redis键
|
* @param hKey Hash键
|
* @return Hash中的对象
|
*/
|
public <T> T getCacheMapValue(final String key, final String hKey)
|
{
|
HashOperations<String, String, T> opsForHash = redisTemplate.opsForHash();
|
return opsForHash.get(key, hKey);
|
}
|
|
/**
|
* 获取多个Hash中的数据
|
*
|
* @param key Redis键
|
* @param hKeys Hash键集合
|
* @return Hash对象集合
|
*/
|
public <T> List<T> getMultiCacheMapValue(final String key, final Collection<Object> hKeys)
|
{
|
return redisTemplate.opsForHash().multiGet(key, hKeys);
|
}
|
|
/**
|
* 删除Hash中的某条数据
|
*
|
* @param key Redis键
|
* @param hKey Hash键
|
* @return 是否成功
|
*/
|
public boolean deleteCacheMapValue(final String key, final String hKey)
|
{
|
return redisTemplate.opsForHash().delete(key, hKey) > 0;
|
}
|
|
/**
|
* 获得缓存的基本对象列表
|
*
|
* @param pattern 字符串前缀
|
* @return 对象列表
|
*/
|
public Collection<String> keys(final String pattern)
|
{
|
return redisTemplate.keys(pattern);
|
}
|
|
/**
|
* 尝试加锁
|
*
|
* @param lockKey 锁的key
|
* @param requestId 锁的持有者标识符（如UUID）
|
* @param expireTime 锁的过期时间（秒）
|
* @return 加锁成功返回true，否则返回false
|
*/
|
public boolean tryLock(String lockKey, String requestId, long expireTime) {
|
String lockKeyWithPrefix = LOCK_PREFIX + lockKey;
|
// 使用SET命令的NX和PX选项来加锁
|
Boolean result = redisTemplate.opsForValue().setIfAbsent(lockKeyWithPrefix, requestId, expireTime, TimeUnit.SECONDS);
|
return result != null && result;
|
}
|
|
/**
|
* 尝试加锁
|
*
|
* @param lockKey 锁的key
|
* @param requestId 锁的持有者标识符（如UUID）
|
* @param expireTime 锁的过期时间（秒）
|
* @return 加锁成功返回true，否则返回false
|
*/
|
public boolean trylockLoop(String lockKey, String requestId,long expireTime) {
|
String lockKeyWithPrefix = LOCK_PREFIX + lockKey;
|
// 使用SET命令的NX和PX选项来加锁
|
Boolean result = false;
|
int num = 50;
|
while (num>0){
|
result = redisTemplate.opsForValue().setIfAbsent(lockKeyWithPrefix, requestId, expireTime, TimeUnit.SECONDS);
|
if (result){
|
break;
|
}
|
try {
|
TimeUnit.MILLISECONDS.sleep(200);
|
} catch (InterruptedException e) {
|
throw new RuntimeException(e);
|
}
|
num--;
|
}
|
return result;
|
}
|
|
|
/**
|
* 解锁
|
*
|
* @param lockKey 锁的key
|
* @param requestId 锁的持有者标识符（如UUID）
|
* @return 解锁成功返回true，否则返回false
|
*/
|
public boolean unlock(String lockKey, String requestId) {
|
String lockKeyWithPrefix = LOCK_PREFIX + lockKey;
|
// 使用Lua脚本来验证锁的持有者并解锁
|
Long result = (Long) redisTemplate.execute(UNLOCK_SCRIPT, Collections.singletonList(lockKeyWithPrefix), requestId);
|
return result != null && result == 1L;
|
}
|
|
/**
|
* 自增
|
* @param key 要加一的键
|
*/
|
public int increment(String key) {
|
// +1 操作
|
return redisTemplate.opsForValue().increment(key).intValue();
|
}
|
|
}
|
