springboot redisson 工具类

### 关于 Spring Boot 和 Redisson 的工具类实现 在开发基于 Spring Boot 和 Redisson 的项目时，创建一个通用的工具类可以简化对 Redisson 功能的操作。以下是针对该需求的一个典型工具类设计示例。 #### 工具类功能概述 此工具类主要提供以下功能： - 初始化 Redisson 客户端实例。 - 提供常用操作方法（如获取锁、发布订阅等）。 - 确保线程安全以及资源释放。 --- ### 示例代码：Redisson 工具类实现 ```java import org.redisson.api.RLock; import org.redisson.api.RedissonClient; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; @Component public class RedissonUtils { @Autowired private RedissonClient redissonClient; /** * 获取分布式锁对象 * * @param lockName 锁名称 * @return RLock 对象 */ public RLock getLock(String lockName) { return redissonClient.getLock(lockName); } /** * 尝试加锁，默认超时时间 10 秒钟 * * @param lockName 锁名称 * @return 是否成功获得锁 */ public boolean tryLock(String lockName) { RLock lock = getLock(lockName); try { return lock.tryLock(); } catch (Exception e) { throw new RuntimeException("尝试加锁失败：" + e.getMessage()); } } /** * 带有自定义等待时间和租约时间的加锁逻辑 * * @param lockName 锁名称 * @param waitTime 最大等待时间（单位：秒） * @param leaseTime 锁持有时间（单位：秒） * @return 是否成功获得锁 */ public boolean tryLockWithTimeout(String lockName, int waitTime, int leaseTime) { RLock lock = getLock(lockName); try { return lock.tryLock(waitTime, leaseTime, java.util.concurrent.TimeUnit.SECONDS); } catch (InterruptedException e) { Thread.currentThread().interrupt(); // 设置中断状态 throw new RuntimeException("尝试带超时的加锁失败：" + e.getMessage()); } } /** * 解锁指定的锁 * * @param lockName 锁名称 */ public void unlock(String lockName) { RLock lock = getLock(lockName); if (lock.isLocked() && lock.isHeldByCurrentThread()) { lock.unlock(); } } /** * 发布消息到指定频道 * * @param channel 频道名 * @param message 消息内容 */ public void publishMessage(String channel, String message) { redissonClient.getTopic(channel).publish(message); } /** * 订阅指定频道的消息 * * @param channel 频道名 * @param listener 消息监听器 */ public void subscribeToChannel(String channel, org.redisson.api.listener.MessageListener<String> listener) { redissonClient.getTopic(channel).addListener(listener); } } ``` --- ### 说明 上述 `RedissonUtils` 类提供了以下几个核心功能： 1. **分布式锁管理** - 方法 `getLock()` 返回一个分布式锁对象。 - 方法 `tryLock()` 可用于简单场景下的锁获取。 - 方法 `tryLockWithTimeout()` 支持更复杂的锁控制策略，允许设置最大等待时间和锁持有时间[^2]。 2. **解锁机制** - 方法 `unlock()` 负责释放锁，并确保只有当前线程持有的锁才能被正确释放。 3. **发布/订阅模式支持** - 方法 `publishMessage()` 用于向指定频道发送消息。 - 方法 `subscribeToChannel()` 用于注册监听器并接收来自特定频道的消息。 通过以上工具类的设计，开发者可以在业务层更加方便地调用 Redisson 提供的功能，而无需频繁处理底层细节。 --- ### Maven 依赖配置 为了使上述工具类正常工作，请确保已在项目的 `pom.xml` 文件中引入了正确的 Redisson 依赖项。例如： ```xml <dependency> <groupId>org.redisson</groupId> <artifactId>redisson-spring-boot-starter</artifactId> <version>${redisson.version}</version> </dependency> ``` 其中 `${redisson.version}` 应替换为实际使用的版本号，比如 `3.16.3`[^3]。 --- ### 注意事项 - 如果遇到 `ClassNotFoundException` 或者其他类似的运行时异常，请检查是否已按照文档要求正确添加了 Redisson 的依赖，并确认其版本与 Spring Boot 兼容[^1]。 - 在生产环境中使用分布式锁时，建议合理调整锁的超时参数以避免死锁风险。 ---