Redisson 分布式锁实现分析

Redisson 分布式锁实现分析

分布式锁常见问题

互斥

分布式系统中运行着多个节点，必须确保在同一时刻只能有一个节点的一个线程获得锁，这是最基本的一点。

死锁

分布式系统中，可能产生死锁的情况要相对复杂一些。分布式系统是处在复杂网络环境中的，当一个节点获取到锁，如果它在释放锁之前挂掉了，或者因网络故障无法执行释放锁的命令，都会导致其他节点无法申请到锁。
因此分布式锁有必要设置时效，确保在未来的一定时间内，无论获得锁的节点发生了什么问题，最终锁都能被释放掉。

性能

对于访问量大的共享资源，如果针对其获取锁时造成长时间的等待，导致大量节点阻塞，是绝对不能接受的。
所以设计分布式锁时要能够掌握锁持有者的动态，若判断锁持有者处于不活动状态，要能够强制释放其持有的锁。
此外，排队等待锁的节点如果不知道锁何时会被释放，则只能隔一段时间尝试获取一次锁，这样无法保证资源的高效利用，因此当锁释放时，要能够通知等待队列，使一个等待节点能够立刻获得锁。

重入

考虑到一些应用场景和资源的高效利用，锁要设计成可重入的，就像 JDK 中的 ReentrantLock 一样，同一个线程可以重复拿到同一个资源的锁。

RedissonLock 源码解析

分布式锁使用

// 1.获得锁对象实例
RLock lock = redisson.getLock("foobar"); 
// 2.获取分布式锁
lock.lock(); 
try {
     
    // do sth.
} finally {
     
   // 3.释放锁
    lock.unlock();
}

以上就是我们使用分布式锁的一个大致流程

下面我们先看第一步

getLock()

/**
 * RLock 是继承自 java.util.concurrent.locks.Lock 的一个 interface，getLock 返回的实际上是其实现类
 * RedissonLock 的实例
 */
@Override
public RLock getLock(String name) {
     
  												//commandExecutor: 与 Redis 节点通信并发送指令的真正实现。
  return new RedissonLock(commandExecutor,
                          //name: 锁的全局名称,具体业务中通常可能使用共享资源的唯一标识作为该名称
                          name,
                          //id: Redisson 客户端唯一标识，实际上就是一个 UUID.randomUUID()
                          id);
}

接下来，我们看下lock()

lock()

@Override
public void lock() {
     
  try {
     
    //直接进入子方法中
    lockInterruptibly();
  } catch (InterruptedException e) {
     
    Thread.currentThread().interrupt();
  }
}

@Override
public void lockInterruptibly() throws InterruptedException {
     
  lockInterruptibly(-1, null);
}

@Override
public void lockInterruptibly(long leaseTime, TimeUnit unit) throws InterruptedException {
     
    // 1.尝试获取锁，成功：返回 null，失败：返回锁的剩余存活时间
  	//先看下执行步骤，具体实现后面再说
    Long ttl = tryAcquire(leaseTime, unit);
    // 2.获得锁成功
    if (ttl == null) {
     
        return;
    }
    // 3.等待锁释放，并订阅锁
    long threadId = Thread.currentThread().getId();
    Future<RedissonLockEntry> future = subscribe(threadId);
    get(future);

    try {
     
        while (true) {
     
            // 4.重试获取锁
            ttl = tryAcquire(leaseTime, unit);
            // 5.成功获得锁
            if (ttl == null) {
     
                break;
            }
            // 6.等待锁释放
            if (ttl >= 0) {
     
                getEntry(threadId).getLatch().tryAcquire(ttl, TimeUnit.MILLISECONDS);
            } else {
     
                getEntry(threadId).getLatch().acquire();
            }
        }
    } finally {
     
        // 7.取消订阅
        unsubscribe(future, threadId);
    }
}

tryAcquire()

private Long tryAcquire(long leaseTime, TimeUnit unit) {
     
    // 1.将异步执行的结果以同步的形式返回
  	//Redis 命令都是异步的，但是它在异步的基础上提供了以同步的方式获得执行结果的封装
    return get(tryAcquireAsync(leaseTime, unit, Thread.currentThread().getId()));
}

private <T> Future<Long> tryAcquireAsync(long leaseTime, TimeUnit unit, long threadId) {
     
    if (leaseTime != -1) {
     
        return tryLockInnerAsync(leaseTime, unit, threadId, RedisCommands.EVAL_LONG);
    }
    // 2.用默认的锁超时时间(30s)去获取锁
    Future<Long> ttlRemainingFuture = tryLockInnerAsync(LOCK_EXPIRATION_INTERVAL_SECONDS,
                TimeUnit.SECONDS, threadId, RedisCommands.EVAL_LONG);
    ttlRemainingFuture.addListener(new FutureListener<Long>() {
     
        @Override
        public void operationComplete(Future<Long> future) throws Exception {
     
            if (!future.isSuccess()) {
     
                return;
            }
            Long ttlRemaining = future.getNow();
            // 成功获得锁
            if (ttlRemaining == null) {
     
                // 3.锁过期时间刷新任务调度
              	// 在成功获取到锁的情况下，为了避免业务中对共享资源的操作还未完成，锁就被释放掉了，
              	// 需要定期（锁失效时间的三分之一）刷新锁失效的时间，
              	// 这里 Redisson 使用了 Netty 的 TimerTask、Timeout 工具来实现该任务调度
                scheduleExpirationRenewal();
            }
        }
    });
    return ttlRemainingFuture;
}

<T> Future<T> tryLockInnerAsync(long leaseTime, TimeUnit unit, long threadId,
                RedisStrictCommand<T> command) {
     
    internalLockLeaseTime = unit.toMillis(leaseTime);
    // 4.使用 EVAL 命令执行 Lua 脚本获取锁
    return commandExecutor.evalWriteAsync(getName(), LongCodec.INSTANCE, command,
                // exists 命令发现当前 key 不存在，即锁没被占用
               "if (redis.call('exists', KEYS[1]) == 0) then " +
               //hset 写入 Hash 类型数据 key:全局锁名称（例如共享资源ID）, 
               //field:锁实例名称（Redisson客户端ID:线程ID）, value:1
                  "redis.call('hset', KEYS[1], ARGV[2], 1); " +
               //并执行 pexpire 对该 key 设置失效时间，
                  "redis.call('pexpire', KEYS[1], ARGV[1]); " +
               //返回空值 nil，至此获取锁成功
                  "return nil; " +
              "end; " +
              		// hexists 命令发现 Redis 中已经存在当前 key 和 field 的 Hash 数据，
              		//说明当前线程之前已经获取到锁，因为这里的锁是可重入的
              "if (redis.call('hexists', KEYS[1], ARGV[2]) == 1) then " +
              		//执行 hincrby 对当前 key field 的值加 1
                  "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.<Object>singletonList(getName()), internalLockLeaseTime,
                        getLockName(threadId));
}

unlock()

@Override
public void unlock() {
     
    // 1.通过 EVAL 和 Lua 脚本执行 Redis 命令释放锁
    Boolean opStatus = commandExecutor.evalWrite(getName(), LongCodec.INSTANCE,
                    RedisCommands.EVAL_BOOLEAN,
                    //key 不存在，说明锁已释放，直接执行 publish 命令发布释放锁消息并返回 1
                    "if (redis.call('exists', KEYS[1]) == 0) then " +
                        "redis.call('publish', KEYS[2], ARGV[1]); " +
                        "return 1; " +
                    "end;" +
                    //key 存在，但是 field 在 Hash 中不存在，说明自己不是锁持有者，无权释放锁，返回 nil
                    "if (redis.call('hexists', KEYS[1], ARGV[3]) == 0) then " +
                        "return nil;" +
                    "end; " +
                    //因为锁可重入，所以释放锁时不能把所有已获取的锁全都释放掉,
                    //一次只能释放一把锁，因此执行 hincrby 对锁的值减一
                    "local counter = redis.call('hincrby', KEYS[1], ARGV[3], -1); " +
                    //如果还有剩余的锁，则刷新锁的失效时间并返回 0
                    "if (counter > 0) then " +
                        "redis.call('pexpire', KEYS[1], ARGV[2]); " +
                        "return 0; " +
                    //不剩余锁了，执行 del 命令删除锁的 key，并发布锁释放消息，返回 1
                    "else " +
                        "redis.call('del', KEYS[1]); " +
                        "redis.call('publish', KEYS[2], ARGV[1]); " +
                        "return 1; "+
                    "end; " +
                    "return nil;",
                    Arrays.<Object>asList(getName(), getChannelName()), 
                            LockPubSub.unlockMessage, internalLockLeaseTime, 
                            getLockName(Thread.currentThread().getId()));
    // 2.非锁的持有者释放锁时抛出异常
    if (opStatus == null) {
     
        throw new IllegalMonitorStateException(
                "attempt to unlock lock, not locked by current thread by node id: "
                + id + " thread-id: " + Thread.currentThread().getId());
    }
    // 3.释放锁后取消刷新锁失效时间的调度任务
    if (opStatus) {
     
      	//执行结果返回 1 的情况，该锁的所有实例都已全部释放，所以不需要再刷新锁的失效时间
        cancelExpirationRenewal();
    }
}

以上就是 redisson 分布式锁的源码了，最主要逻辑都在lua脚本里面了，而由于 redis 的 setNX特性，同一时间点只能有一个线程执行该命令，则是分布式锁的重中之重，也是最核心最基础的一个前提。

注意

Redisson缺省的CommandExecutor 实现是通过 eval 命令来执行 Lua 脚本，所以要求 Redis 的版本必须为 2.6 或以上，否则你可能要自己来实现 CommandExecutor。

参考

https://link.jianshu.com/?t=https%3A%2F%2Fgithub.com%2Fangryz%2Fmy-blog%2Fissues%2F4