redis工具类

前言

Redis 是一个高性能的键值存储系统，广泛应用于缓存、消息队列、实时分析等场景。为了更高效地操作 Redis，许多开发者会选择使用 Redisson 客户端库。

依赖配置

首先确保您的项目中已经包含了 Redisson 的最新版本（如 3.44.0）以及相关依赖项。对于 Maven 项目，您需要在 pom.xml 文件中添加以下依赖：

<dependency><groupId>org.redisson</groupId><artifactId>redisson</artifactId><version>3.44.0</version>
</dependency>

对于 Gradle 项目，请在 build.gradle 中添加：

implementation 'org.redisson:redisson:3.44.0'

同时，确保 Spring 上下文已正确配置，以便通过 SpringUtils.getBean(RedissonClient.class) 获取 RedissonClient 实例。

---

RedisUtils 工具类详解

/*** redis 工具类**/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
@SuppressWarnings(value = {"unchecked", "rawtypes"})
public class RedisUtils {private static final RedissonClient CLIENT = SpringUtils.getBean(RedissonClient.class);/*** 限流** @param key          限流key* @param rateType     限流类型* @param rate         速率* @param rateInterval 速率间隔* @return -1 表示失败*/public static long rateLimiter(String key, RateType rateType, int rate, int rateInterval) {return rateLimiter(key, rateType, rate, rateInterval, 0);}/*** 限流** @param key          限流key* @param rateType     限流类型* @param rate         速率* @param rateInterval 速率间隔* @param timeout      超时时间* @return -1 表示失败*/public static long rateLimiter(String key, RateType rateType, int rate, int rateInterval, int timeout) {RRateLimiter rateLimiter = CLIENT.getRateLimiter(key);rateLimiter.trySetRate(rateType, rate, Duration.ofSeconds(rateInterval), Duration.ofSeconds(timeout));if (rateLimiter.tryAcquire()) {return rateLimiter.availablePermits();} else {return -1L;}}/*** 获取客户端实例*/public static RedissonClient getClient() {return CLIENT;}/*** 发布通道消息** @param channelKey 通道key* @param msg        发送数据* @param consumer   自定义处理*/public static <T> void publish(String channelKey, T msg, Consumer<T> consumer) {RTopic topic = CLIENT.getTopic(channelKey);topic.publish(msg);consumer.accept(msg);}/*** 发布消息到指定的频道** @param channelKey 通道key* @param msg        发送数据*/public static <T> void publish(String channelKey, T msg) {RTopic topic = CLIENT.getTopic(channelKey);topic.publish(msg);}/*** 订阅通道接收消息** @param channelKey 通道key* @param clazz      消息类型* @param consumer   自定义处理*/public static <T> void subscribe(String channelKey, Class<T> clazz, Consumer<T> consumer) {RTopic topic = CLIENT.getTopic(channelKey);topic.addListener(clazz, (channel, msg) -> consumer.accept(msg));}/*** 缓存基本的对象，Integer、String、实体类等** @param key   缓存的键值* @param value 缓存的值*/public static <T> void setCacheObject(final String key, final T value) {setCacheObject(key, value, false);}/*** 缓存基本的对象，保留当前对象 TTL 有效期** @param key       缓存的键值* @param value     缓存的值* @param isSaveTtl 是否保留TTL有效期(例如: set之前ttl剩余90 set之后还是为90)* @since Redis 6.X 以上使用 setAndKeepTTL 兼容 5.X 方案*/public static <T> void setCacheObject(final String key, final T value, final boolean isSaveTtl) {RBucket<T> bucket = CLIENT.getBucket(key);if (isSaveTtl) {try {bucket.setAndKeepTTL(value);} catch (Exception e) {long timeToLive = bucket.remainTimeToLive();if (timeToLive == -1) {setCacheObject(key, value);} else {setCacheObject(key, value, Duration.ofMillis(timeToLive));}}} else {bucket.set(value);}}/*** 缓存基本的对象，Integer、String、实体类等** @param key      缓存的键值* @param value    缓存的值* @param duration 时间*/public static <T> void setCacheObject(final String key, final T value, final Duration duration) {RBatch batch = CLIENT.createBatch();RBucketAsync<T> bucket = batch.getBucket(key);bucket.setAsync(value);bucket.expireAsync(duration);batch.execute();}/*** 如果不存在则设置 并返回 true 如果存在则返回 false** @param key   缓存的键值* @param value 缓存的值* @return set成功或失败*/public static <T> boolean setObjectIfAbsent(final String key, final T value, final Duration duration) {RBucket<T> bucket = CLIENT.getBucket(key);return bucket.setIfAbsent(value, duration);}/*** 如果存在则设置 并返回 true 如果存在则返回 false** @param key   缓存的键值* @param value 缓存的值* @return set成功或失败*/public static <T> boolean setObjectIfExists(final String key, final T value, final Duration duration) {RBucket<T> bucket = CLIENT.getBucket(key);return bucket.setIfExists(value, duration);}/*** 注册对象监听器* <p>* key 监听器需开启 `notify-keyspace-events` 等 redis 相关配置** @param key      缓存的键值* @param listener 监听器配置*/public static <T> void addObjectListener(final String key, final ObjectListener listener) {RBucket<T> result = CLIENT.getBucket(key);result.addListener(listener);}/*** 设置有效时间** @param key     Redis键* @param timeout 超时时间* @return true=设置成功；false=设置失败*/public static boolean expire(final String key, final long timeout) {return expire(key, Duration.ofSeconds(timeout));}/*** 设置有效时间** @param key      Redis键* @param duration 超时时间* @return true=设置成功；false=设置失败*/public static boolean expire(final String key, final Duration duration) {RBucket rBucket = CLIENT.getBucket(key);return rBucket.expire(duration);}/*** 获得缓存的基本对象。** @param key 缓存键值* @return 缓存键值对应的数据*/public static <T> T getCacheObject(final String key) {RBucket<T> rBucket = CLIENT.getBucket(key);return rBucket.get();}/*** 获得key剩余存活时间** @param key 缓存键值* @return 剩余存活时间*/public static <T> long getTimeToLive(final String key) {RBucket<T> rBucket = CLIENT.getBucket(key);return rBucket.remainTimeToLive();}/*** 删除单个对象** @param key 缓存的键值*/public static boolean deleteObject(final String key) {return CLIENT.getBucket(key).delete();}/*** 删除集合对象** @param collection 多个对象*/public static void deleteObject(final Collection collection) {RBatch batch = CLIENT.createBatch();collection.forEach(t -> {batch.getBucket(t.toString()).deleteAsync();});batch.execute();}/*** 检查缓存对象是否存在** @param key 缓存的键值*/public static boolean isExistsObject(final String key) {return CLIENT.getBucket(key).isExists();}/*** 缓存List数据** @param key      缓存的键值* @param dataList 待缓存的List数据* @return 缓存的对象*/public static <T> boolean setCacheList(final String key, final List<T> dataList) {RList<T> rList = CLIENT.getList(key);return rList.addAll(dataList);}/*** 追加缓存List数据** @param key  缓存的键值* @param data 待缓存的数据* @return 缓存的对象*/public static <T> boolean addCacheList(final String key, final T data) {RList<T> rList = CLIENT.getList(key);return rList.add(data);}/*** 注册List监听器* <p>* key 监听器需开启 `notify-keyspace-events` 等 redis 相关配置** @param key      缓存的键值* @param listener 监听器配置*/public static <T> void addListListener(final String key, final ObjectListener listener) {RList<T> rList = CLIENT.getList(key);rList.addListener(listener);}/*** 获得缓存的list对象** @param key 缓存的键值* @return 缓存键值对应的数据*/public static <T> List<T> getCacheList(final String key) {RList<T> rList = CLIENT.getList(key);return rList.readAll();}/*** 获得缓存的list对象(范围)** @param key  缓存的键值* @param form 起始下标* @param to   截止下标* @return 缓存键值对应的数据*/public static <T> List<T> getCacheListRange(final String key, int form, int to) {RList<T> rList = CLIENT.getList(key);return rList.range(form, to);}/*** 缓存Set** @param key     缓存键值* @param dataSet 缓存的数据* @return 缓存数据的对象*/public static <T> boolean setCacheSet(final String key, final Set<T> dataSet) {RSet<T> rSet = CLIENT.getSet(key);return rSet.addAll(dataSet);}/*** 追加缓存Set数据** @param key  缓存的键值* @param data 待缓存的数据* @return 缓存的对象*/public static <T> boolean addCacheSet(final String key, final T data) {RSet<T> rSet = CLIENT.getSet(key);return rSet.add(data);}/*** 注册Set监听器* <p>* key 监听器需开启 `notify-keyspace-events` 等 redis 相关配置** @param key      缓存的键值* @param listener 监听器配置*/public static <T> void addSetListener(final String key, final ObjectListener listener) {RSet<T> rSet = CLIENT.getSet(key);rSet.addListener(listener);}/*** 获得缓存的set** @param key 缓存的key* @return set对象*/public static <T> Set<T> getCacheSet(final String key) {RSet<T> rSet = CLIENT.getSet(key);return rSet.readAll();}/*** 缓存Map** @param key     缓存的键值* @param dataMap 缓存的数据*/public static <T> void setCacheMap(final String key, final Map<String, T> dataMap) {if (dataMap != null) {RMap<String, T> rMap = CLIENT.getMap(key);rMap.putAll(dataMap);}}/*** 注册Map监听器* <p>* key 监听器需开启 `notify-keyspace-events` 等 redis 相关配置** @param key      缓存的键值* @param listener 监听器配置*/public static <T> void addMapListener(final String key, final ObjectListener listener) {RMap<String, T> rMap = CLIENT.getMap(key);rMap.addListener(listener);}/*** 获得缓存的Map** @param key 缓存的键值* @return map对象*/public static <T> Map<String, T> getCacheMap(final String key) {RMap<String, T> rMap = CLIENT.getMap(key);return rMap.getAll(rMap.keySet());}/*** 获得缓存Map的key列表** @param key 缓存的键值* @return key列表*/public static <T> Set<String> getCacheMapKeySet(final String key) {RMap<String, T> rMap = CLIENT.getMap(key);return rMap.keySet();}/*** 往Hash中存入数据** @param key   Redis键* @param hKey  Hash键* @param value 值*/public static <T> void setCacheMapValue(final String key, final String hKey, final T value) {RMap<String, T> rMap = CLIENT.getMap(key);rMap.put(hKey, value);}/*** 获取Hash中的数据** @param key  Redis键* @param hKey Hash键* @return Hash中的对象*/public static <T> T getCacheMapValue(final String key, final String hKey) {RMap<String, T> rMap = CLIENT.getMap(key);return rMap.get(hKey);}/*** 删除Hash中的数据** @param key  Redis键* @param hKey Hash键* @return Hash中的对象*/public static <T> T delCacheMapValue(final String key, final String hKey) {RMap<String, T> rMap = CLIENT.getMap(key);return rMap.remove(hKey);}/*** 删除Hash中的数据** @param key   Redis键* @param hKeys Hash键*/public static <T> void delMultiCacheMapValue(final String key, final Set<String> hKeys) {RBatch batch = CLIENT.createBatch();RMapAsync<String, T> rMap = batch.getMap(key);for (String hKey : hKeys) {rMap.removeAsync(hKey);}batch.execute();}/*** 获取多个Hash中的数据** @param key   Redis键* @param hKeys Hash键集合* @return Hash对象集合*/public static <K, V> Map<K, V> getMultiCacheMapValue(final String key, final Set<K> hKeys) {RMap<K, V> rMap = CLIENT.getMap(key);return rMap.getAll(hKeys);}/*** 设置原子值** @param key   Redis键* @param value 值*/public static void setAtomicValue(String key, long value) {RAtomicLong atomic = CLIENT.getAtomicLong(key);atomic.set(value);}/*** 获取原子值** @param key Redis键* @return 当前值*/public static long getAtomicValue(String key) {RAtomicLong atomic = CLIENT.getAtomicLong(key);return atomic.get();}/*** 递增原子值** @param key Redis键* @return 当前值*/public static long incrAtomicValue(String key) {RAtomicLong atomic = CLIENT.getAtomicLong(key);return atomic.incrementAndGet();}/*** 递减原子值** @param key Redis键* @return 当前值*/public static long decrAtomicValue(String key) {RAtomicLong atomic = CLIENT.getAtomicLong(key);return atomic.decrementAndGet();}/*** 获得缓存的基本对象列表(全局匹配忽略租户 自行拼接租户id)* <P>* limit-设置扫描的限制数量(默认为0,查询全部)* pattern-设置键的匹配模式(默认为null)* chunkSize-设置每次扫描的块大小(默认为0,本方法设置为1000)* type-设置键的类型(默认为null,查询全部类型)* </P>* @see KeysScanOptions* @param pattern 字符串前缀* @return 对象列表*/public static Collection<String> keys(final String pattern) {return  keys(KeysScanOptions.defaults().pattern(pattern).chunkSize(1000));}/*** 通过扫描参数获取缓存的基本对象列表* @param keysScanOptions 扫描参数* <P>* limit-设置扫描的限制数量(默认为0,查询全部)* pattern-设置键的匹配模式(默认为null)* chunkSize-设置每次扫描的块大小(默认为0)* type-设置键的类型(默认为null,查询全部类型)* </P>* @see KeysScanOptions*/public static Collection<String> keys(final KeysScanOptions keysScanOptions) {Stream<String> keysStream = CLIENT.getKeys().getKeysStream(keysScanOptions);return keysStream.collect(Collectors.toList());}/*** 删除缓存的基本对象列表(全局匹配忽略租户 自行拼接租户id)** @param pattern 字符串前缀*/public static void deleteKeys(final String pattern) {CLIENT.getKeys().deleteByPattern(pattern);}/*** 检查redis中是否存在key** @param key 键*/public static Boolean hasKey(String key) {RKeys rKeys = CLIENT.getKeys();return rKeys.countExists(key) > 0;}
}

RedisUtils 类是一个封装了 Redis 常用操作的工具类，提供了限流、发布/订阅、缓存管理等多种功能。

1. 限流机制（Rate Limiting）

方法签名：

public static long rateLimiter(String key, RateType rateType, int rate, int rateInterval)
public static long rateLimiter(String key, RateType rateType, int rate, int rateInterval, int timeout)

参数说明：

• key: 限流规则的唯一标识。
• rateType: 限流类型（例如 RATE 表示固定速率，BURST 表示突发流量）。
• rate: 单位时间内允许的最大请求数量。
• rateInterval: 速率间隔时间（秒）。
• timeout: 超时时间（秒），默认为0表示无超时。

示例代码：

long result = RedisUtils.rateLimiter("api:rateLimit", RateType.RATE, 10, 60);
if (result == -1) {System.out.println("请求过于频繁，请稍后再试");
} else {System.out.println("请求成功");
}

此功能常用于限制 API 请求频率，防止服务器过载。

2. 发布/订阅消息

方法签名：

public static <T> void publish(String channelKey, T msg)
public static <T> void publish(String channelKey, T msg, Consumer<T> consumer)
public static <T> void subscribe(String channelKey, Class<T> clazz, Consumer<T> consumer)

参数说明：

• channelKey: 频道名称。
• msg: 发送的消息内容。
• consumer: 自定义处理逻辑。

示例代码：

// 订阅消息
RedisUtils.subscribe("newsChannel", String.class, message -> {System.out.println("Received message: " + message);
});// 发布消息
RedisUtils.publish("newsChannel", "Breaking News!");

此功能可用于构建基于事件驱动的应用架构，如通知系统或即时通讯应用。

3. 缓存管理

提供了多种缓存对象的方法，支持设置有效期、检查缓存存在性、删除缓存等。

方法签名：

public static <T> void setCacheObject(final String key, final T value)
public static <T> T getCacheObject(final String key)
public static boolean deleteObject(final String key)

示例代码：

// 设置缓存
RedisUtils.setCacheObject("user:1001:name", "Alice");// 获取缓存
String userName = RedisUtils.getCacheObject("user:1001:name");// 删除缓存
RedisUtils.deleteObject("user:1001:name");

这些方法非常适合于实现数据缓存，减少数据库查询压力。

4. 数据类型操作

针对不同的 Redis 数据类型（如列表、集合、映射），提供了相应的操作方法。

方法签名：

public static <T> boolean setCacheList(final String key, final List<T> dataList)
public static <T> Set<T> getCacheSet(final String key)
public static <T> void setCacheMap(final String key, final Map<String, T> dataMap)

示例代码：

// 设置列表缓存
RedisUtils.setCacheList("user:1001:tags", Arrays.asList("developer", "blogger"));// 获取集合缓存
Set<String> tags = RedisUtils.getCacheSet("user:1001:tags");// 设置映射缓存
Map<String, String> profile = new HashMap<>();
profile.put("name", "Alice");
profile.put("age", "30");
RedisUtils.setCacheMap("user:1001:profile", profile);

这些方法使得对复杂数据结构的操作变得简单而直观。

---

如何在项目中使用 RedisUtils

确保上述依赖和配置完成后，可以直接在代码中调用 RedisUtils 类中的静态方法来执行 Redis 操作。例如，在服务层或控制器中调用 setCacheObject 方法来缓存用户信息。

示例：

@RestController
public class UserController {@GetMapping("/cacheUser")public String cacheUser() {User user = new User();user.setId(1001);user.setName("Alice");// 使用 RedisUtils 缓存用户信息RedisUtils.setCacheObject("user:" + user.getId(), user);return "User cached successfully";}
}

注意事项

1. 慎用通配符删除：误操作可能导致数据丢失。
2. 测试环境验证：在生产环境执行删除操作前，务必在测试环境中验证。
3. 监控与备份：定期备份数据，使用监控工具（如 RedisInsight）跟踪键的变化。