适用Java SpringBoot项目的分布式锁

news2024/10/7 18:24:20

在分布式系统中，常用到分布式锁，它有多中实现方式，如：基于redis，database，zookeeper等。Spring integration组件有这三种服务的分布式锁实现，今天来看看用的比较多的redis和database实现方式。

第一种：Spring原生-基于Redis的分布式锁：

1. 需要加入以下依赖，第一个是spring boot integration模块，一个是integration redis实现模块。

<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-integration</artifactId>
</dependency>
<dependency>
     <groupId>org.springframework.integration</groupId>
     <artifactId>spring-integration-redis</artifactId>
</dependency>

2. 配置RedisLockRegistry Bean，有了这个Bean之后，就可以用来加锁、解锁了，Spring框架中有继承redis的实现和异常处理，我们可以方便且稳定的使用。

@Configuration
public class LockConfig {

     @Bean
     public RedisLockRegistry redisLockRegistry(RedisConnectionFactory redisConnectionFactory) {
         return new RedisLockRegistry(redisConnectionFactory, "test",60);
     }
}

3. 加锁、解锁。在需要分布式加锁的时候，先通过redisLockRegistry获取到lock对象，然后用lock对象加锁（可以设置等待尝试时间，到点自动放弃，不加时间默认立即放弃），处理完业务之后一定要记得解锁。

Lock lock = redisLockRegistry.obtain(lockKey);

if (lock.tryLock(0L, TimeUnit.SECONDS)) {

    log.info("获取到锁，执行业务代码...");

} else {
    log.info("很遗憾没获取到锁。");
}

lock.unlock();

第二种：Spring原生-基于DB的分布式锁：

1. 需要加入以下依赖，第一个是spring boot integration模块，一个是integration jdbc实现模块。

<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-integration</artifactId>
</dependency>
<dependency>
     <groupId>org.springframework.integration</groupId>
     <artifactId>spring-integration-jdbc</artifactId>
</dependency>

2. 配置JdbcLockRegistry Bean，有了这个Bean之后，就可以用来加锁、解锁了，Spring框架中有继承redis的实现和异常处理，我们可以方便且稳定的使用。

@Configuration
public class LockConfig {

     @Bean
    public JdbcLockRegistry getJdbcLockRegistry(DataSource dataSource, ApplicationContext applicationContext) {
        DefaultLockRepository lockRepository = new DefaultLockRepository(dataSource);
        lockRepository.setApplicationContext(applicationContext); //必须设置applicationContext
        lockRepository.afterSingletonsInstantiated(); //在LockRepository实例化后必须调用这个方法，否则后面会报事务对象空指针错误
        lockRepository.setPrefix("spring_"); //分布式锁表前缀，自定义
        lockRepository.setTimeToLive(60000); //锁存活时间60s
        lockRepository.afterPropertiesSet(); //属性设置结束后必须调用此方法，格式化加锁、解锁SQL语句
        return new JdbcLockRegistry(lockRepository);
    }
}

3. 加锁、解锁。在需要分布式加锁的时候，先通过jdbcLockRegistry获取到lock对象，然后用lock对象加锁（可以设置等待尝试时间，到点自动放弃，不加时间默认立即放弃），处理完业务之后一定要记得解锁。

Lock lock = jdbcLockRegistry.obtain(lockKey);

if (lock.tryLock(0L, TimeUnit.SECONDS)) {

    log.info("获取到锁，执行业务代码...");

} else {
    log.info("很遗憾没获取到锁。");
}

lock.unlock();