SpringBoot集成Lock4j 底层使用Redission 实现分布锁

怼烎@ 2023-10-14 08:58 24阅读 0赞

## Lock4j ##

![在这里插入图片描述][7374529dd1c64a88a4bef6b2638ea5d6.png]

在分布式系统中，实现锁的功能对于保证数据一致性和避免并发冲突是非常重要的。Lock4j是一个简单易用的分布式锁框架，而Redisson是一个功能强大的分布式解决方案，可以与Lock4j进行集成。

### 操作步骤 ###

#### 第一步：添加依赖 ####

首先，在你的Spring Boot项目的pom.xml文件中添加以下依赖：

<dependencies>
        
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>lock4j-redis-template-spring-boot-starter</artifactId>
            <version>${latest.version}</version>
        </dependency>
        
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>lock4j-redisson-spring-boot-starter</artifactId>
            <version>${latest.version}</version>
        </dependency>
        
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>lock4j-zookeeper-spring-boot-starter</artifactId>
            <version>${latest.version}</version>
        </dependency>
    </dependencies>

这些依赖将会引入Redisson和Lock4j以及它们的必要依赖。

#### 第二步：配置Redis ####

在src/main/resources目录下创建application.yml文件，并添加以下配置：

spring:
      redis:
        host: 127.0.0.1
        port: 6379
        password: ddz123
        database: 0

这是一个示例配置文件，你需要根据自己的实际情况修改Redis的连接信息，如地址、端口、密码等。

#### 第三步：使用@Lock4j注解实现分布式锁 ####

在你的Spring Boot应用程序中，创建一个测试类，用于ApiPost的调用两次第一个会获取到锁，第二个获取锁失败会抛出异常。

@GetMapping("/lock")
        @Lock4j(keys = {
        "#id"}, acquireTimeout = 100, expire = 10000
    //            , executor = RedissonLockExecutor.class
        )
        public String getLock(String id) throws InterruptedException {
        
            Thread.sleep(10000);
            return id;
        }

![在这里插入图片描述][82bf66be3a2747d88aac42a48f260e62.png]

### 自定义锁 ###

#### 自定义锁key的生成规则 ####

只需要实现`LockKeyBuilder`接口中 `buildKey()` 方法即可定义自己的生成规则。

@Component
    public class CustomKeyBuilder implements LockKeyBuilder {
        
        /**
         * 构建key
         *
         * @param invocation     invocation
         * @param definitionKeys 定义
         * @return key
         */
        @Override
        public String buildKey(MethodInvocation invocation, String[] definitionKeys) {
        
            // 自定义锁key的生成策略
            return null;
        }
    }

#### 自定义锁失败策略 ####

实现`LockFailureStrategy`接口中`onLockFailure()` 方法即可自定义获取锁失败返回策略。

@Component
    public class GrabLockFailureStrategy implements LockFailureStrategy {
        
        /**
         * 锁失败事件
         *
         * @param key       锁key
         * @param method    方法
         * @param arguments 自变量
         */
        @Override
        public void onLockFailure(String key, Method method, Object[] arguments) {
        
            throw new RuntimeException("获取锁失败了！");
        }
    }

#### 自定义加锁解锁逻辑 ####

@Component
    public class RedissonLockExecutor extends AbstractLockExecutor<RLock> {
        
        /**
         * 加锁
         *
         * @param lockKey        锁标识
         * @param lockValue      锁值
         * @param expire         锁有效时间
         * @param acquireTimeout 获取锁超时时间
         * @return 锁信息
         */
        @Override
        public RLock acquire(String lockKey, String lockValue, long expire, long acquireTimeout) {
        
            return null;
        }
    
        /**
         * 解锁
         *
         * <pre>
         * 为何解锁需要校验lockValue
         * 客户端A加锁，一段时间之后客户端A解锁，在执行releaseLock之前，锁突然过期了。
         * 此时客户端B尝试加锁成功，然后客户端A再执行releaseLock方法，则将客户端B的锁给解除了。
         * </pre>
         *
         * @param key          加锁key
         * @param value        加锁value
         * @param lockInstance 锁实例
         * @return 是否释放成功
         */
        @Override
        public boolean releaseLock(String key, String value, RLock lockInstance) {
        
            return false;
        }
    }

### 注意事项 ###

在使用Spring Boot集成Lock4j和Redisson时，需要注意以下事项：

*  确保Redisson的配置正确。在redisson.yaml文件（或application.properties）中，你需要提供正确的Redis连接信息，如地址、端口、密码等。确保你的Redis服务运行正常。
 *  注意锁的名称要保证唯一性。不同的锁需要使用不同的锁名称。使用相同名称的锁可能会导致不同方法之间的锁冲突。
 *  考虑对方法异常进行处理。为了确保锁能够被正确释放，你可以在方法中使用try-catch-finally结构，并在finally块中释放锁。这样即使方法出现异常，也能保证锁的守护不会因异常而中断。

通过以上步骤和注意事项，你可以轻松地在Spring Boot项目中集成Lock4j，并使用Redisson作为底层实现分布式锁。这样，你可以安全地处理分布式系统中的并发问题，并保证数据的一致性。

[7374529dd1c64a88a4bef6b2638ea5d6.png]: https://img-blog.csdnimg.cn/7374529dd1c64a88a4bef6b2638ea5d6.png
[82bf66be3a2747d88aac42a48f260e62.png]: https://img-blog.csdnimg.cn/82bf66be3a2747d88aac42a48f260e62.png