作者 | bravoban
来源 | tech.lede.com/2017/03/08/rd/server/Redisson针对项目中使用的分布式锁进行简单的示例配置以及源码解析,并列举源码中使用到的一些基础知识点,但是没有对redisson中使用到的netty知识进行解析。
本篇主要是对以下几个方面进行了探索
Maven配置
RedissonLock简单示例
源码中使用到的Redis命令
源码中使用到的lua脚本语义
源码分析
Maven配置
<dependency>
<groupId>org.redissongroupId>
<artifactId>redissonartifactId>
<version>2.2.12version>
dependency>
<dependency>
<groupId>com.fasterxml.jackson.coregroupId>
<artifactId>jackson-annotationsartifactId>
<version>2.6.0version>
dependency>
RedissonLock简单示例
redission支持4种连接redis方式,分别为单机、主从、Sentinel、Cluster 集群,项目中使用的连接方式是Sentinel。
redis服务器不在本地的同学请注意权限问题。
Sentinel配置
Config config = new Config();
config.useSentinelServers().addSentinelAddress("127.0.0.1:6479", "127.0.0.1:6489").setMasterName("master").setPassword("password").setDatabase(0);
RedissonClient redisson = Redisson.create(config);
简单使用
RLock lock = redisson.getLock("test_lock");
try{
boolean isLock=lock.tryLock();
if(isLock){
doBusiness();
}
}catch(exception e){
}finally{
lock.unlock();
}
源码中使用到的Redis命令
分布式锁主要需要以下redis命令,这里列举一下。在源码分析部分可以继续参照命令的操作含义。
EXISTS key :当 key 存在,返回1;若给定的 key 不存在,返回0。
GETSET key value:将给定 key 的值设为 value ,并返回 key 的旧值 (old value),当 key 存在但不是字符串类型时,返回一个错误,当key不存在时,返回nil。
GET key:返回 key 所关联的字符串值,如果 key 不存在那么返回 nil。
DEL key [KEY …]:删除给定的一个或多个 key ,不存在的 key 会被忽略,返回实际删除的key的个数(integer)。
HSET key field value:给一个key 设置一个{field=value}的组合值,如果key没有就直接赋值并返回1,如果field已有,那么就更新value的值,并返回0.
HEXISTS key field:当key中存储着field的时候返回1,如果key或者field至少有一个不存在返回0。
HINCRBY key field increment:将存储在key中的哈希(Hash)对象中的指定字段field的值加上增量increment。如果键key不存在,一个保存了哈希对象的新建将被创建。如果字段field不存在,在进行当前操作前,其将被创建,且对应的值被置为0,返回值是增量之后的值
PEXPIRE key milliseconds:设置存活时间,单位是毫秒。expire操作单位是秒。
PUBLISH channel message:向channel post一个message内容的消息,返回接收消息的客户端数。
源码中使用到的lua脚本语义
Redisson源码中,执行redis命令的是lua脚本,其中主要用到如下几个概念。
redis.call() 是执行redis命令.
KEYS[1] 是指脚本中第1个参数
ARGV[1] 是指脚本中第一个参数的值
返回值中nil与false同一个意思。
需要注意的是,在redis执行lua脚本时,相当于一个redis级别的锁,不能执行其他操作,类似于原子操作,也是redisson实现的一个关键点。
另外,如果lua脚本执行过程中出现了异常或者redis服务器直接宕掉了,执行redis的根据日志回复的命令,会将脚本中已经执行的命令在日志中删除。
源码分析
RLOCK结构
public interface RLock extends Lock, RExpirable {
void lockInterruptibly(long leaseTime, TimeUnit unit) throws InterruptedException;
boolean tryLock(long waitTime, long leaseTime, TimeUnit unit) throws InterruptedException;
void lock(long leaseTime, TimeUnit unit);
void forceUnlock();
boolean isLocked();
boolean isHeldByCurrentThread();
int getHoldCount();
Future unlockAsync();
Future tryLockAsync();
Future lockAsync();
Future lockAsync(long leaseTime, TimeUnit unit);
Future tryLockAsync(long waitTime, TimeUnit unit);
Future tryLockAsync(long waitTime, long leaseTime, TimeUnit unit);
}
该接口主要继承了Lock接口, 并扩展了部分方法, 比如:boolean tryLock(long waitTime, long leaseTime, TimeUnit unit)新加入的leaseTime主要是用来设置锁的过期时间, 如果超过leaseTime还没有解锁的话, redis就强制解锁. leaseTime的默认时间是30s
RedissonLock获取锁 tryLock源码
Future tryLockInnerAsync(long leaseTime, TimeUnit unit, long threadId) {
internalLockLeaseTime = unit.toMillis(leaseTime);
return commandExecutor.evalWriteAsync(getName(), LongCodec.INSTANCE, RedisCommands.EVAL_LONG,
"if (redis.call('exists', KEYS[1]) == 0) then " +
"redis.call('hset', KEYS[1], ARGV[2], 1); " +
"redis.call('pexpire', KEYS[1], ARGV[1]); " +
"return nil; " +
"end; " +
"if (redis.call('hexists', KEYS[1], ARGV[2]) == 1) then " +
"redis.call('hincrby', KEYS[1], ARGV[2], 1); " +
"redis.call('pexpire', KEYS[1], ARGV[1]); " +
"return nil; " +
"end; " +
"return redis.call('pttl', KEYS[1]);",
Collections.