简洁易懂:源码+实战讲解Redisson并发锁及看门狗自动续期

1 缘起

有一次同事问Redisson存储的键是否为hash?
我当时,没有看Redisson的相关源码,只知道应用,
所以没有办法回答,于是开始看看Redisson实现的源码,
顺便写了一个单机Redisson测试,
发现Redisson有看门狗功能,但是,不是所有的方法都会触发,
只有lock()方法才会触发看门狗,其他的方法不会触发看门狗功能,
如lock(long, TimeUnit),tryLock(),
本文从结果触发,先理论分析,然后,代码实践验证。
先从源码讲解Redisson相关的知识,包括如何新建锁、释放锁、看门狗功能,
然后代码实战,验证这些功能,
感兴趣的同学可以手动调试。
帮助读者轻松应对知识交流与考核。

版本信息:
SpringBoot:2.1.7
Redisson:3.7.5

2 Redisson属性源码分析与验证

2.1 新建锁

位置:org.redisson.RedissonLock#tryLockInnerAsync
新建锁和可重入源码如下图所示,由源码可知,
Redisson使用Lua脚本新建锁。

  • 为什么?
    保证操作原子性。
    因为新建数据和添加过期时间是两步操作,不能保证原子性,
    因此使用Lua实现,保证新建锁时是原子操作。

Redisson实现的锁是可重入的。同一个线程获取锁,无需重新排队申请,只需增加锁的持有次数。

  • 怎么做?
    判断锁是的属性是否存在。
    通过hexists判断锁的属性是否存在(UUID:threadId),如果存在,值+1,同时,更新锁过期时间,
    使用Lua脚本,保证原子性。

在这里插入图片描述

Lua脚本中的参数KEYS[1],ARGV[1], ARGV[2],

  • 分别对应哪些参数呢?
    KEYS[1]:Collections.singletonList(getName()),即锁的键名;
    ARGV[1]:internalLockLeaseTime,即锁过期时间;
    ARGV[2]:getLockName(threadId),即锁(Hash)属性的键,UUDI:threadId。
    其中,getLockName源码如下图所示,由图可知,UUID拼接threadId作为锁属性的键。
    顺便补充一下,Hash结构,键名,即获取该Hash的键,属性键名,即Hash内部数据的键。

在这里插入图片描述

下面看一下新建锁的调试过程,如下图所示,
(单步调试,如果操作不及时或者有其他时延,会导致Redis数据过期,因此,选择单步调试)
由图可知,新建的锁,键名称为redisLockKey,
默认锁过期时间为30秒,UUID为edb0f8cb-ec11-4b29-a107-12be152c4a5e,
threadId为71,锁属性的键为:edb0f8cb-ec11-4b29-a107-12be152c4a5e:71,属性键的值为1。
在这里插入图片描述
新建锁之后,会在Redis生成对应的数据,
如下图所示,由图可知,Redisson新建的锁键为redisLockKey,
锁属性名称为:edb0f8cb-ec11-4b29-a107-12be152c4a5e:71,属性值为1。
过期时间TTL已经开始倒计时了,实时的值为17秒。
在这里插入图片描述

2.2 获取锁

Redisson获取锁有两种方式:lock获取和tryLock获取。
lock()获取锁,如果得不到,会一直等,同时,lock()会开启看门狗功能,在看门狗巡查期间,锁不会过期;
lock(long, java.util.concurrent.TimeUnit)获取锁,会一直等,当锁过期后,即可自动获取;
tryLock()获取锁,得不到会一直等,当锁过期后,可自动获取到;
tryLock(long, long, java.util.concurrent.TimeUnit)获取锁,有两个时间参数,可以同时指定等待锁的最大时间,以及锁过期时间,如果等待最大时间大于锁过期时间,则锁被提前释放,重新生成锁;

2.2.1 lock

位置:java.util.concurrent.locks.Lock#lock

无参的lock方法来自JUC接口,
Redisson自身实现lock,并加入看门狗功能。
无返回值。
在这里插入图片描述
Redisson的实现源码如下图所示,这里给出路径,感兴趣可自行查看。
位置:org.redisson.RedissonLock#lock()

在这里插入图片描述

有参的lock源码如下图所示,
这个lock来自Redisson的RLock,添加了锁过期时间,
可以自定义锁的过期时间,这个获取锁的方法不会触发看门狗。
无返回值。

位置:org.redisson.api.RLock#lock
在这里插入图片描述
Redisson实现源码如下,这里给出路径,感兴趣可自行查看。
位置:org.redisson.RedissonLock#lock(long, java.util.concurrent.TimeUnit)
在这里插入图片描述

2.2.2 tryLock

位置:java.util.concurrent.locks.Lock#tryLock()
获取锁,无法获取时等待,当锁自动过期后,可自动获取。
有返回值,可通过返回值判断是否获得锁。
true:成功获取锁;
false:未获取锁。
在这里插入图片描述
Redisson实现tryLock源码如下图所示。
位置:org.redisson.RedissonLock#tryLock()
在这里插入图片描述

有参数的tryLock源码下图所示,有源码可知,
可指定最大等待锁时间、锁过期时间,
如果等待锁的最大时间小于锁过期时间,返回false,标识未得到锁。
如果等待锁的最大时间大于锁过期时间,等锁释放后,可自动获取锁,返回true,标识得到锁。
有返回值,可通过返回值判断是否获得锁。
true:成功获取锁;
false:未获取锁。
位置:org.redisson.api.RLock#tryLock

在这里插入图片描述

获取锁的实现源码如下图所示,这里给出路径,感兴趣可自行查看。
位置:org.redisson.RedissonLock#tryLock(long, long, java.util.concurrent.TimeUnit)
在这里插入图片描述

2.3 释放锁

位置:org.redisson.RedissonLock#unlockInnerAsync
释放锁源码如下图所示,由图可知,释放锁时会将锁属性的值-1,(加-1),
当释放的锁存在时,会将锁属性的值减1,减后的值大于零,重置锁的过期时间,保证锁的过期时间周期,
如果减1之后,锁属性值为0,即没有线程再持有锁,则删除该锁(del)。
在这里插入图片描述

2.4 锁续期

看门狗
位置:org.redisson.config.Config#lockWatchdogTimeout
看门狗的默认超时时间为30秒,即锁过期时间的续期为30秒,
看门狗的巡查周期为10秒,即每10秒更新一次锁的过期时间,设置为30秒。
两个是独立的时间系统。
30秒:锁的过期时间;
10秒:看门狗巡查周期。
这个10秒是如何得到的:30/3=10。

在这里插入图片描述

位置:org.redisson.RedissonLock#scheduleExpirationRenewal
看门狗进行锁续期的源码如下图所示,由源码可知,
当锁存在时,会延迟10秒执行更新锁过期时间,过期时间为30秒,
看门狗的巡查周期就是这个延迟时间:10秒。
在这里插入图片描述
当然,好奇的同学会问,锁的默认过期时间怎么就是30秒,
这个30秒是从哪里来的呢?
过期时间(internalLockLeaseTime)默认值取自看门狗的超时时间:30秒,上文有看门狗的默认值源码。
在这里插入图片描述

3 实战

版本信息:
SpringBoot:2.1.7
Redisson:3.7.5

3.1 依赖

<!--Redisson-->
<dependency>
	<groupId>org.redisson</groupId>
	<artifactId>redisson</artifactId>
	<version>3.7.5</version>
</dependency>

3.2 配置

3.2.1 Redis配置

application-dev.yml

spring:
  profiles: dev
  redis:
    host: localhost
    port: 6379
    # 连接超时时间:毫秒
    timeout: 60000
    database: 0
    lettuce:
      pool:
        # 连接池最大连接数量
        max-active: 8
        # 连接池最大阻塞等待时间:-1无限制
        max-wait: 60000
        # 连接池最大空闲连接数量
        max-idle: 8
        # 连接池最小空闲连接数量
        min-idle: 0

3.2.2 绑定Redis配置

package com.hardsoft.monkeyrun.common.lock;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

/**
 * Redis连接参数.
 *
 * @author xindaqi
 * @since 2021/4/2 11:41
 */
@Configuration
@ConfigurationProperties(prefix="spring.redis")
public class RedisConnectionParams {
    
    

    /**
     * 主机名
     */
    private String host;

    /**
     * 主机端口
     */
    private String port;

    /**
     * Redis连接超时时间:毫秒
     */
    private int timeout;

    /**
     * Redis数据库编号
     */
    private int database;

    public void setHost(String host) {
    
    
        this.host = host;
    }

    public String getHost() {
    
    
        return host;
    }

    public void setPort(String port) {
    
    
        this.port = port;
    }

    public String getPort() {
    
    
        return port;
    }

    public void setTimeout(int timeout) {
    
    
        this.timeout = timeout;
    }

    public int getTimeout() {
    
    
        return timeout;
    }

    public void setDatabase(int database) {
    
    
        this.database = database;
    }

    public int getDatabase() {
    
    
        return database;
    }

    @Override
    public String toString() {
    
    
        return "RedisConnectionParams{" +
                "host='" + host + '\'' +
                ", port='" + port + '\'' +
                ", timeout=" + timeout +
                ", database=" + database +
                '}';
    }
}

3.2.3 Redisson配置

package com.hardsoft.monkeyrun.common.config;

import com.hardsoft.monkeyrun.common.lock.RedisConnectionParams;
import com.hardsoft.monkeyrun.common.lock.RedissonLocker;
import org.redisson.Redisson;
import org.redisson.api.RedissonClient;
import org.redisson.config.Config;
import org.redisson.config.SingleServerConfig;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.annotation.Resource;

import static com.hardsoft.monkeyrun.common.constrant.StringConstant.COLON;
import static com.hardsoft.monkeyrun.common.constrant.StringConstant.REDISSON_SCHEMA;

/**
 * Redisson配置.
 *
 * @author xindaqi
 * @since 2021/4/2 11:34
 */
@Configuration
public class RedissonConfig {
    
    

    @Resource
    RedisConnectionParams redisConnectionParams;

    /**
     * 单机模式RedissonClient
     *
     * @return
     */
    @Bean(destroyMethod = "shutdown")
    public RedissonClient redissonClient() {
    
    
        Config config = new Config();
        SingleServerConfig singleServerConfig = config.useSingleServer();
        StringBuilder redisAddress = new StringBuilder();
        redisAddress.append(REDISSON_SCHEMA).append(redisConnectionParams.getHost()).append(COLON).append(redisConnectionParams.getPort());
        singleServerConfig.setAddress(redisAddress.toString());
        return Redisson.create(config);
    }

    @Bean
    public RedissonLocker redissonLocker(RedissonClient redissonClient) {
    
    
        return new RedissonLocker(redissonClient);
    }

}

3.2.4 Redisson获取锁封装

package com.hardsoft.monkeyrun.common.lock;

import com.hardsoft.monkeyrun.common.constrant.BooleanConstant;
import org.redisson.api.RLock;
import org.redisson.api.RedissonClient;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import java.util.concurrent.TimeUnit;

/**
 * Redisson锁
 *
 * @author xindaqi
 * @since 2021/3/30 19:01
 */
@Component
public class RedissonLocker {
    
    

    RedissonClient redissonClient;

    public RedissonLocker(RedissonClient redissonClient) {
    
    
        this.redissonClient = redissonClient;
    }

    /**
     * 获取锁
     * 如果锁不可用,则当前线程处于休眠状态,直到获得锁为止
     *
     * @param lockKey 锁键
     */
    public void lock(String lockKey) {
    
    
        RLock lock = redissonClient.getLock(lockKey);
        lock.lock();
    }

    /**
     * 获取锁
     * 如果锁不可用,则当前线程处于休眠状态,直到获得锁为止,
     * 如果获取到锁后,执行结束后解锁或达到超时时间后自动释放锁
     *
     * @param lockKey 锁键
     * @param timeout 超时时间
     */
    public void lock(String lockKey, int timeout) {
    
    
        RLock lock = redissonClient.getLock(lockKey);
        lock.lock(timeout, TimeUnit.SECONDS);
    }

    /**
     * 获得锁
     * 如果锁不可用,则当前线程处于休眠状态,直到获得锁后,
     * 执行结束后解锁或达到超时时间后会自动释放锁
     *
     * @param lockKey 锁键
     * @param unit 时间单位
     * @param timeout 超时时间
     */
    public void lock(String lockKey, TimeUnit unit, int timeout) {
    
    
        RLock lock = redissonClient.getLock(lockKey);
        lock.lock(timeout, unit);
    }

    /**
     * 释放锁
     *
     * @param lockKey 锁键
     */
    public void unlock(String lockKey) {
    
    
        RLock lock = redissonClient.getLock(lockKey);
        lock.unlock();
    }

    /**
     * 尝试获取锁
     * 获取到立即返回True
     * 未获取到返回False
     *
     * @param lockKey 锁键
     * @return 获取锁标志位,True:成功获取锁,False:未获取锁
     */
    public boolean tryLock(String lockKey) {
    
    
        RLock lock = redissonClient.getLock(lockKey);
        return lock.tryLock();
    }

    /**
     * 尝试获取锁
     * 在等待时间内获取到锁则返回True,否则返回False
     * 获取到锁,两种执行逻辑:
     * 1.执行之后,释放锁
     * 2.达到释放时间leaseTime后,释放锁
     *
     * @param lockKey 锁键
     * @param waitTime 等待时间
     * @param leaseTime 释放时间
     * @param unit 时间单位
     * @return 获取锁标志位,True:成功获取锁,False:未获取锁
     * @throws InterruptedException
     */
    public boolean tryLock(String lockKey, long waitTime, long leaseTime, TimeUnit unit) throws InterruptedException {
    
    
        RLock lock = redissonClient.getLock(lockKey);
        return lock.tryLock(waitTime, leaseTime, unit);
    }

    /**
     * 判断锁是否被任意一个线程持有
     *
     * @param lockKey 锁键
     * @return 锁持有标志位,True:锁被线程持有,False:锁没有被线程持有
     */
    public boolean isLocked(String lockKey) {
    
    
        RLock lock = redissonClient.getLock(lockKey);
        return lock.isLocked();
    }

    public void setRedissonClient(RedissonClient redissonClient) {
    
    
        this.redissonClient = redissonClient;
    }
}

3.3 接口测试

package com.hardsoft.monkeyrun.api.facade.lock;

import com.hardsoft.monkeyrun.common.constrant.BooleanConstant;
import com.hardsoft.monkeyrun.common.constrant.DigitalConstant;
import com.hardsoft.monkeyrun.common.enums.BizExceptionCodeEnums;
import com.hardsoft.monkeyrun.common.exception.BizException;
import com.hardsoft.monkeyrun.common.lock.RedissonLocker;
import com.hardsoft.monkeyrun.common.response.Response;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.concurrent.TimeUnit;

import static com.hardsoft.monkeyrun.common.constrant.StringConstant.REDIS_LOCK_KEY;

/**
 * 锁测试
 *
 * @author xindaqi
 * @since 2021-04-03 11:28:18
 */
@RestController
@RequestMapping("/v1/lock")
public class LockTest {
    
    

    private static final Logger logger = LoggerFactory.getLogger(LockTest.class);

    private final String STOCK_WITH_REDISSON = "stock_with_redisson";

    private final String STOCK_WITHOUT_REDISSON = "stock_without_redisson";

    @Resource
    RedissonLocker redissonLocker;

    /**
     * 测试Redisson锁tryLock,不会激活看门狗,锁过期后,直接被清除
     * 
     * @return 响应
     */
    @GetMapping("/redisson/try-lock/test")
    public Response<String> testRedissonTryLock() {
    
    
        try {
    
    
            boolean lock1 = redissonLocker.tryLock(REDIS_LOCK_KEY, 100, 10, TimeUnit.SECONDS);
            if (lock1) {
    
    
                logger.info(">>>>>>>>得到锁");
                Thread.sleep(70000);
                return Response.success();
            } else {
    
    
                logger.info(">>>>>>>>未得到锁");
                return Response.fail();
            }
        } catch(Exception ex) {
    
    
            logger.error(">>>>>>>>Redisson异常:", ex);
            throw new BizException(BizExceptionCodeEnums.FAIL);
        } finally {
    
    
            logger.info(">>>>>>>释放Redisson锁");
            redissonLocker.unlock(REDIS_LOCK_KEY);
        }
    }

    /**
     * 测试Redisson看门狗功能:使用lock()获取锁,激活看门狗功能,每10秒自动续期30秒过期时间。
     * 
     * @return 响应
     */
    @GetMapping("/redisson/lock/test")
    public Response<String> testRedissonLock() {
    
    
        try {
    
    
            redissonLocker.lock(REDIS_LOCK_KEY);
            Thread.sleep(70000);
            return Response.success();
        } catch(Exception ex) {
    
    
            logger.error(">>>>>>>>Redisson异常:", ex);
            throw new BizException(BizExceptionCodeEnums.FAIL);
        } finally {
    
    
            logger.info(">>>>>>>释放Redisson锁");
            redissonLocker.unlock(REDIS_LOCK_KEY);
        }
    }
}

Redis结果:

在这里插入图片描述

4 结论

(1)Redisson锁存储使用Hash,Hash键为锁的键名,属性的键为UUID拼接ThreadId,格式:UUID:ThreadID,如xxx-xxx:30,属性的值为同一个线程获取锁的次数,Redisson的锁是可重入的,同一个线程获取锁,锁的数量+1,释放锁,数量减1;
(2)Redisson获取锁有两种方式,lock获取和tryLock获取,其中:
(2.1)lock获取锁时,如果第一次尝试获取获取失败,会一直等待,直到获取锁。Redisson的lock获取锁时,会为锁配置过期时间,当锁超过过期时间后,会自动释放,避免死锁,可以重新获得锁;
(2.2)lock()原始方法获取(不自定义超时(过期)时间)会激活看门狗。即通过lock()方法成功获取锁后,逻辑执行的时间超过看门狗超时时间:10秒,会自动为锁续期(增加)10秒的过期时间,使锁的过期时间保持在30秒(默认的锁过期时间);
(2.3)lock(long, TimeUnit)带参方法可以指定锁过期时间,但是,不会触发看门狗自动续期;锁过期后,自动释放锁;
(2.4)tryLock方法返回标识位,获取成功,返回true,获取失败,返回false;tryLock尝试获取锁,无法获取锁时会等待,同时,tryLock有最大的等待时间,如果获取锁的等待时间超过最大等待时间,会放弃获取锁,并返回false;tryLock不会触发看门狗,无法自动为锁续期;
(2.5)tryLock可以同时指定等待锁的最大时间,以及锁过期时间,如果等待最大时间大于锁过期时间,则锁被提前释放,重新生成锁;
(3)Redisson看门狗默认巡查周期为10秒,锁续期时间(过期时间)30秒;
(4)Redisson看门口生效的方法为:lock(),其他方法均不会触发看门狗。

猜你喜欢

转载自blog.csdn.net/Xin_101/article/details/128950698
今日推荐