分布式锁实现原理解析（Redis & WLock）

语言: CN / TW / HK
时间 2022-05-13 12:02:32
主题:
2022中国 DevOps 现状调查全面启动！>>>

1

单机锁

1. Java原生锁

在Java中每个对象都有一把锁，如普通的Object对象及类的Class对象。线程可以使用synchronized关键字来获取对象上的锁。synchronized关键字可以应用在方法级别（粗粒度）或代码块级别（细粒度），在JDK1.6以前，使用synchronized只有一种方式即重量级锁，而在JDK1.6以后，引入了偏向锁与轻量级锁，来减少竞争带来的上下文切换。

2. Java并发包（JUC）提供的锁


2

分布式锁

1. 为什么我们需要分布式锁？

单机锁主要是为了同步同一进程中各个线程之间的操作。大多数互联网系统都是分布式部署的，当某个资源在多系统之间具有共享性的时候，为了保证大家访问这个资源数据是一致的，那么就必须要求在同一时刻只能被一个客户端处理，不能并发的执行，否者就会出现同一时刻有人写有人读，大家访问到的数据就不一致了。分布式锁，是指在分布式的部署环境下，通过锁机制来让多客户端互斥的对共享资源进行访问。

2. 分布式锁需要具备的条件？

排他性：在同一时间只会有一个客户端能获取到锁，其它客户端无法同时获取

避免死锁：这把锁在一段有限的时间之后，一定会被释放（正常释放或异常释放）

高可用：获取或释放锁的机制必须高可用且性能佳


3

使用Redis实现分布式锁

使用Redis实现分布式锁是一个比较常见的方案，利用Redis提供的SETNX命令，由于Redis使用单线程处理客户端发送的命令，所以可以保证排他性，加锁时设置锁过期时间可以避免死锁，Redis是纯内存操作，所以可以保证高效的获取与释放锁。当Redis为单机部署时无法保证高可用，而使用Redis的主从模式也会存在一个问题：当主Redis宕机之后，从Redis还未同步保存在主Redis上的锁，此时将导致锁丢失。

直接使用SETNX命令进行加锁操作是最简单的方式，但是在实际的生产环境中分布式锁的实现还必须要考虑其他很多因素，如锁重入，锁续期，阻塞与非阻塞获取锁等等。Redisson是一个高级的分布式协调Redis客户端，使用Netty进行网络通信，其基于Redis实现了多种类型的锁，如下：

RedissonLock

可重入锁

RedissonFairLock

可重入公平锁

RedissonMultiLock

连锁，可把一组锁当作一个锁来加锁和释放

RedissonReadLock

读锁

RedissonWriteLock

写锁

RedissonTransactionalLock

事务锁，在RedissonLock基础上记录了transactionId

RedissonRedLock

红锁，在多Redis（非集群环境）下获取锁，防止Redis单点故障

在开发中我们一般会使用RedissonLock来使用分布式锁，其支持锁重入，阻塞与非阻塞获取锁及锁续期等功能，基本可以满足大部分业务场景。

PS：锁重入的意思是一个客户端在获取到锁之后可以再次去获取同一把锁，防止出现死锁；阻塞获取的意思是如果当前客户端尝试获取锁失败之后会一直等待，直到成功获取到锁或超时之后才会返回，而非阻塞式获取表示不管尝试获取锁结果是成功或失败都会立刻返回；进行锁续期是防止出现由于加锁时间过短，在业务代码尚未执行完毕的情况下锁提前被释放。

1. 源码分析RedissonLock（3.11.1版本）加解锁流程

（1）获取锁（阻塞式）：

 //leaseTime表示设置的锁过期时间，unit表示时间单位，interruptibly表示获取锁期间是否响应中断    private void lock(long leaseTime, TimeUnit unit, boolean interruptibly) throws InterruptedException {        long threadId = Thread.currentThread().getId();        //尝试获取锁，获取失败返回锁的剩余过期时间        Long ttl = this.tryAcquire(leaseTime, unit, threadId);        if (ttl != null) {            //如果获取失败则订阅释放锁的消息（注意当锁是因为自动过期而被释放时不会发布消息，只有客户端手动释放锁才会发布消息）            RFuture<RedissonLockEntry> future = this.subscribe(threadId);            this.commandExecutor.syncSubscription(future);
            try {                //循环，直到成功获取到锁或线程发生了中断                while(true) {                    ttl = this.tryAcquire(leaseTime, unit, threadId);                    //成功获取到锁直接返回                    if (ttl == null) {                        return;                    }
                    //ttl大于等于0表示锁设置了过期时间，否则表示未设置过期时间                    if (ttl >= 0L) {                        try {                            //当锁设置了过期时间时，阻塞等待（Latch为Semaphore,其初始信号量为0），等待时间为锁的剩余生存时间                            //注意当某个客户端手动释放锁之后将发布锁释放的消息，此时阻塞在Semaphore中的第一个线程将会被唤醒                            this.getEntry(threadId).getLatch().tryAcquire(ttl, TimeUnit.MILLISECONDS);                        } catch (InterruptedException var13) {                            //若需要响应中断，直接抛出中断异常，否则继续阻塞等待                            if (interruptibly) {                                throw var13;                            }
                            this.getEntry(threadId).getLatch().tryAcquire(ttl, TimeUnit.MILLISECONDS);                        }                    } else if (interruptibly) {                        //当锁未设置过期时间且需要响应中断时，一直阻塞等待，且在等待过程中响应中断                        this.getEntry(threadId).getLatch().acquire();                    } else {                        //当锁未设置过期时间且不需要响应中断时，一直阻塞等待，且在等待过程中不响应中断                        this.getEntry(threadId).getLatch().acquireUninterruptibly();                    }                }            } finally {                //不管是成功获取到锁还是抛出了中断异常都需要取消订阅                this.unsubscribe(future, threadId);            }        }    }

上述代码为阻塞式获取锁的主干逻辑，实际获取锁的逻辑在 tryAcquire 方法中，如下：

private Long tryAcquire(long leaseTime, TimeUnit unit, long threadId) {        //将异步调用变成同步调用        return (Long)this.get(this.tryAcquireAsync(leaseTime, unit, threadId));    }
    public <V> V get(RFuture<V> future) {        //若异步任务尚未执行完毕，需要阻塞等待        if (!future.isDone()) {            CountDownLatch l = new CountDownLatch(1);
            //设置任务执行完毕后的回调方法            future.onComplete((res, e) -> {                //当任务执行完毕唤醒因为调用l.await()而阻塞的线程                l.countDown();            });            boolean interrupted = false;
            while(!future.isDone()) {                try {                    //当任务尚未完成时阻塞等待                    l.await();                } catch (InterruptedException var5) {                    interrupted = true;                    break;                }            }
            //若在等待过程中发生了线程中断，需要重新设置中断标志，因为线程在抛出中断异常之前会先清除中断标志            if (interrupted) {                Thread.currentThread().interrupt();            }        }
        //若任务成功执行返回执行结果，否则抛出异常        if (future.isSuccess()) {            return future.getNow();        } else {            throw this.convertException(future);        }    }
    private <T> RFuture<Long> tryAcquireAsync(long leaseTime, TimeUnit unit, long threadId) {        if (leaseTime != -1L) {            //如果自定了锁过期时间，直接使用该过期时间作为锁的过期时间            return this.tryLockInnerAsync(leaseTime, unit, threadId, RedisCommands.EVAL_LONG);        } else {            //如果未设置锁过期时间，过期时间使用Watchdog的默认时间30秒            RFuture<Long> ttlRemainingFuture = this.tryLockInnerAsync(this.commandExecutor.getConnectionManager().getCfg().getLockWatchdogTimeout(),                 TimeUnit.MILLISECONDS, threadId, RedisCommands.EVAL_LONG);            //设置加锁任务执行之后的回调            ttlRemainingFuture.onComplete((ttlRemaining, e) -> {                if (e == null) {                    //成功获取到锁后另起线程进行锁定时续期，续期任务执行间隔为Watchdog默认时间的三分之一（10秒）                    //定时续期内部使用了Netty的HashedWheelTime实现，其基于时间轮算法                    if (ttlRemaining == null) {                        this.scheduleExpirationRenewal(threadId);                    }
                }            });            return ttlRemainingFuture;        }    }

最终加锁逻辑在 tryLockInnerAsync 方法中，其核心是一段 Lua 脚本，如下：

//执行lua脚本获取锁    <T> RFuture<T> tryLockInnerAsync(long leaseTime, TimeUnit unit, long threadId, RedisStrictCommand<T> command) {        internalLockLeaseTime = unit.toMillis(leaseTime);        return commandExecutor.evalWriteAsync(getName(), LongCodec.INSTANCE, command,                "if (redis.call('exists', KEYS[1]) == 0) then " +    //判断指定的key是否存在                        "redis.call('hset', KEYS[1], ARGV[2], 1); " +    //新增key，value为hash结构                        "redis.call('pexpire', KEYS[1], ARGV[1]); " +    //设置过期时间                        "return nil; " +    //直接返回null，表示加锁成功                        "end; " +                        "if (redis.call('hexists', KEYS[1], ARGV[2]) == 1) then " +    //判断hash中是否存在指定的建                        "redis.call('hincrby', KEYS[1], ARGV[2], 1); " +    //hash中指定键的值+1                        "redis.call('pexpire', KEYS[1], ARGV[1]); " +    //重置过期时间                        "return nil; " +   //返回null，表示加锁成功                        "end; " +                        "return redis.call('pttl', KEYS[1]);",    //返回key的剩余过期时间，表示加锁失败                Collections.<Object>singletonList(getName()), internalLockLeaseTime, getLockName(threadId));    }

上面这段Lua脚本的逻辑如下：首先判断指定的key是否存在，若不存在则添加新key，value为hash结构，其保存了客户端标识（可理解为进程+线程信息组成）到加锁次数的映射；若指定的key已存在，判断key对应的value中是否存在当前客户端标识，若存在，对应的加锁次数+1表示当前为锁重入；其他情况直接返回当前key的剩余过期时间，表示本次加锁失败。下图为Redis端储存的锁信息：                       

加锁流程总结：线程首先使用Lua脚本尝试获取锁，若获取成功直接返回，否则需要订阅锁释放的消息，之后使用Semaphore阻塞等待TTL（加锁失败时返回的锁剩余过期时间），同一个进程中不同的线程若使用同一个key进行加锁，在加锁失败后都会阻塞在同一个Semaphore上。在此期间若接受到锁被释放的消息（由其他客户端手动释放锁而非锁自动过期），将从Semaphore中唤醒一个线程，该线程再次使用Lua脚本尝试获取锁，一直重复该过程，直到该线程成功获取到锁。

（2）释放锁：

 public void unlock() {        try {            //同步获取释放锁结果            get(unlockAsync(Thread.currentThread().getId()));        } catch (RedisException e) {            if (e.getCause() instanceof IllegalMonitorStateException) {                throw (IllegalMonitorStateException) e.getCause();            } else {                throw e;            }        }    }
    public RFuture<Void> unlockAsync(long threadId) {        RPromise<Void> result = new RedissonPromise<Void>();        //执行Lua脚本释放锁        RFuture<Boolean> future = unlockInnerAsync(threadId);
        future.onComplete((opStatus, e) -> {            //取消锁续约            cancelExpirationRenewal(threadId);
            if (e != null) {                result.tryFailure(e);                return;            }
            //释放一个尚未获取到的锁，需要抛出异常            if (opStatus == null) {                IllegalMonitorStateException cause = new IllegalMonitorStateException("attempt to unlock lock, not locked by current thread by node id: "+ id + " thread-id: " + threadId);                result.tryFailure(cause);                return;            }
            result.trySuccess(null);        });
        return result;    }

和加锁时类似，最终解锁逻辑在 unLockInnerAsync 方法中，其核心也是一段 Lua 脚本，如下：

 protected RFuture<Boolean> unlockInnerAsync(long threadId) {        return commandExecutor.evalWriteAsync(getName(), LongCodec.INSTANCE, RedisCommands.EVAL_BOOLEAN,                "if (redis.call('hexists', KEYS[1], ARGV[3]) == 0) then " +                         "return nil;" +    //判断当前客户端之前是否已获取到锁，若没有直接返回null                        "end; " +                        "local counter = redis.call('hincrby', KEYS[1], ARGV[3], -1); " +    //锁重入次数-1                        "if (counter > 0) then " +    //若锁尚未完全释放，需要重置过期时间(默认为Watchdog默认时间30秒)                        "redis.call('pexpire', KEYS[1], ARGV[2]); " +                        "return 0; " +    //返回0表示锁未完全释放                        "else " +                        "redis.call('del', KEYS[1]); " +    //若锁已完全释放，删除当前key                        "redis.call('publish', KEYS[2], ARGV[1]); " +  //释已完全释放，发布锁已释放的消息                        "return 1; "+    //返回1表示锁已完全释放                        "end; " +                        "return nil;",                Arrays.<Object>asList(getName(), getChannelName()), LockPubSub.UNLOCK_MESSAGE, internalLockLeaseTime, getLockName(threadId));
    }
解锁流程总结：线程直接执行Lua脚本进行锁释放，锁重入次数-1，若已完全释放需要发布锁已释放的消息并取消锁续约。

（3）加解锁流程总结：

  1. RedissionLock使用Lua脚本进行加解锁操作，保证了操作的原子性。
  2. RedissionLock的重入信息保存在服务端，客户端不保存任何锁信息。
  3. RedissionLock的所有同步操作其实都是调用的异步操作，只不过使用了CountDownLatch进行了同步。
  4. 加锁时若传递了锁的过期时间则锁会在指定时间后过期，否则使用Watchdog默认超时时间30秒，并会进行自动续期，周期为10秒，也就是说不会设置不过期的锁，防止客户端挂掉锁一直得不到释放。
  5. 获取锁失败后会订阅锁释放的消息，之后会阻塞等待，等待的最大时间为锁的剩余过期时间，若在等待期间收到了锁释放的消息将从阻塞中被唤醒（前提是当前线程在当前锁的竞争中排在队列的最前面，也可以理解成当前线程需要和本进程中的其他线程再做竞争，胜出的才会被唤醒），这里引入了等待通知机制，类似于单机锁中的LockSupport的park与unpark。若未接受到锁被释放的消息，线程也会在锁过期后自动被唤醒，之后再次尝试获取锁。

2、Redisson中的RedLock：

（1）为什么需要RedLock？

上述提到的RedissonLock及其他类似的衍生锁（如RedissonFairLock等）都是在Redis单机或主从模式下使用的。单机模式下存在单点故障，而主从模式也有一个缺点：当主Redis宕机之后，从Redis还未同步保存在主Redis上的锁，此时将导致锁丢失。对此Redisson提供了RedissonRedLock，RedissonRedLock实现了RedLock算法，RedLock使用多Redis节点，理论上可以解决单点故障问题。

（2）RedLock加解锁流程


  1. 获取当前时间戳。

  2. client尝试按照顺序使用相同的key-value获取所有redis服务的锁，在获取锁的过程中，锁的获取时间需要远小于锁的过期时间，这是为了避免过长时间等待已经关闭的redis服务。之后试着获取下一个redis实例上的锁。比如：TTL为5s，设置获取锁最多用1s，所以如果一秒内无法获取锁，就放弃获取这个锁，从而尝试获取下个锁。

  3. client获取所有能获取到的锁之后再使用当前的时间减去第一步的时间，这个时间差要小于TTL时间并且至少有（N/2+1）个redis实例成功获取锁，才算真正的获取锁成功。

  4. 如果成功获取锁，则锁的真正有效时间是 TTL减去第三步的时间差 的时间；比如：TTL 是5s,获取所有锁用了3s,则真正锁有效时间为2s。

  5. 如果客户端由于某些原因获取锁失败（没有在至少N/2+1个Redis实例获取到锁或者取锁时间已经超过了有效时间），客户端应该在所有Redis实例上进行解锁（即便某些Redis实例根本就没有加锁成功也需要解锁，防止某些节点由于网络抖动等原因实际已经获取到了锁，但是客户端没有得到响应而导致接下来的一段时间不能被重新获取到锁）。

（3）RedLock的缺点？

严重依赖时钟，在分布式系统中N（Network网络）、P（Process进程）、C（Clock时钟）三者都是不可靠的，如果某个Redis服务出现时钟跳跃（走的比其他机器快），那么可能会出现某个Redis节点的key提前过期，这样另外一个客户端就可能再次在N/2+1个Redis节点加锁成功（多个客户端同时获取到锁，不满足排他性）。其实由于对各个Redis是进行同步顺序加锁，这也会导致每个Redis上锁的过期时间不一致。一般生产环境很少使用RedLock。如果对可靠性要求不是很高的场景下，RedissonLock完全够用了，而对可靠性有高要求的场景下可以使用Zookeeper这种满足强一致性的分布式协调组件实现分布式锁。
PS：RedLock由Redis作者提出，而该算法在刚被提出来就受到了分布式系统大神 Martin Kleppmann的质疑，两人在网上进行了多次PK（打口水仗），感兴趣的同学可以查询下这方面的资料。


4

58自研分布式锁WLock

1. WLock与其他实现对比：


PS：上图来自WLock官方文档

2. 主要特性：

WLock基于WPaxos实现分布式锁服务，引入RocksDB实现锁状态持久化存储，封装TTL和续约机制以及watch异步通知功能，同时提供可视化监管平台，提供了一套完备的分布式锁实现方案；

（1）WPaxos简述：

WPaxos为58集团参照微信团队开源的PhxPaxos（C++）采用Java语言实现的分布式一致性组件，其将Multi-Paxos算法与Basic-Paxos算法结合，支持多Paxos分组，有序确定多个值，相比于ZAB和Raft等一致性算法更加灵活（Raft、Zab在Multi-Paxos基础上添加了Leader选举限制，简化了实现更易让人理解，但强依赖Leader使灵活性略逊于Multi-Paxos，目前Multi-Paxos较为成熟的开源实现是微信团队C++语言开发的PhxPaxos生产级类库）。


PS：上图来自WLock官方文档

（2）RocksDB简述：

LevelDB是由Google开源的，基于LSM Tree的单机KV数据库，其特点是高效，代码简洁而优美，Rocksdb则是Facebook基于LevelDB改造的。RocksDB 和LevelDB 是一个库，嵌入在用户的程序中，用户程序直接调用接口读写数据，相对于Redis不需要建立连接才能发起请求，读写数据。

3. WLock加锁方式：

WLock不像Redisson提供了多种类型的锁，其只提供了WDistributedLock，但同样支持互斥锁、可重入锁、公平锁及带权重优先级锁，可通过同步阻塞或者异步非阻塞方式获取到锁。所有对分布式锁的操作都通过该对象进行，在获取锁时可以传递以下参数：

waitAcquire

是否阻塞等待获取到锁，true为阻塞，false为非阻塞

expireTime

锁过期时间，单位毫秒，默认值为5分钟，最大取值5分钟，最小值5秒

maxWaitTime

最长等待获取锁的时间，单位毫秒，最大值Long.MAX_VALUE

weight

锁权重，默认都为1，取值范围[1, 10]，权重越高，获取到锁概率越高

renewInterval

自动续约间隔，单位毫秒(默认为Integer.MAX_VALUE，不自动续租，最小自动续租间隔为1000ms,最大自动续租间隔不能超过过期时间，由业务控制)。

renewListener

续约Listener回调

lockExpireListener

锁过期Listener回调

watchListener

异步监听事件回调

4. WLock（1.0.8版本）源码分析：

（1）获取锁（阻塞式）：

public AcquireLockResult tryAcquireLock(String lockkey, InternalLockOption lockOption) throws ParameterIllegalException {    AcquireLockResult result = new AcquireLockResult();    result.setRet(false);    long startTimestamp = System.currentTimeMillis();    //进行参数校验，若参数错误将抛出异常    this.lockParameterCheck(lockOption);    //如果已经获取到锁且还未过期，本地也会储存一份锁信息，这里先从本地判断是否获取到锁    //若已经获取到了锁，表示本次为锁重入，lockContext中的aquiredCount进行+1操作    if (this.lockManager.acquiredLockLocal(lockkey, lockOption)) {        LockContext lockContext = this.lockManager.getLocalLockContext(lockkey, lockOption.getThreadID());        //如果从本地获取到了锁，重新设置锁过期时间为本次设置的过期时间        this.renewLock(lockkey, lockContext.getLockVersion(), lockOption.getExpireTime(), lockOption.getThreadID());        result.setOwner(new LockOwner(InetAddressUtil.getIpInt(), lockOption.getThreadID(), lockOption.getPID()));        result.setResponseStatus(ResponseStatus.SUCCESS);        result.setRet(true);        result.setLockVersion(lockContext.getLockVersion());        return result;    } else {        int timeout = (int)Math.min((long)this.wlockClient.getDefaultTimeoutForReq(), lockOption.getMaxWaitTime());        WatchEvent watchEvent = null;        //如果是以阻塞方式获取锁，首先注册ACQUIRE类型的watchEvent，用于异步接收到服务器返回的消息时可以根据映射关系唤醒阻塞等待的线程        if (lockOption.isWaitAcquire()) {            //watchEvent内置了CountDownLatch            watchEvent = new WatchEvent(lockkey, lockOption.getThreadID(), lockOption.getWatchID(), WatchType.ACQUIRE, startTimestamp);            watchEvent.setLockOption(lockOption);            watchEvent.setTimeout(lockOption.getMaxWaitTime());            //注册的本质为在本地的Map里面保存watchId -> watchEvent及lockKey -> watchIdSet的映射关系            this.watchManager.registerWatchEvent(lockkey, watchEvent);        }        //该groupId用于Multi-group-Paxos        int groupId = this.wlockClient.getRegistryKey().getGroupId();        AcquireLockRequest acquireLockReq = this.protocolFactory.createAcquireReq(lockkey, groupId, lockOption);
        try {            //同步请求加锁，若请求失败（注意不是加锁失败）会进行重试，默认重试次数为2次            SendReqResult sendReqResult = this.serverPoolHandler.syncSendRequest(acquireLockReq, timeout, "tryAcquireLock " + lockkey);            if (sendReqResult != null) {                AcquireLockResponse resp = new AcquireLockResponse();                resp.fromBytes(sendReqResult.getData());                result.setResponseStatus(resp.getStatus());                AcquireLockResult var13;                if (resp.getStatus() == ResponseStatus.LOCK_WAIT) {                    //如果获取锁失败，服务端返回LOCK_WAIT表示客户端需要阻塞等待锁获取的消息                    //内部会使用上面创建的watchEvent内部的CountDownLatch进行同步阻塞等待，当接受到服务器返回的消息后将会被唤醒                    NotifyEvent notifyEvent = this.watchManager.waitNotifyEvent(lockOption.getWatchID(), lockOption.getMaxWaitTime());                    if (notifyEvent != null && notifyEvent.getEventType() == EventType.LOCK_ACQUIRED.getType()) {                        //若成功获取到锁，将锁信息保存到本地                        this.lockManager.updateLockLocal(lockkey, notifyEvent.getFencingToken(), lockOption, true);                        //注销保存在本地的watchId -> watchEvent及lockKey -> watchIdSet的映射关系                        EventCachedHandler.getInstance(this.wlockClient).unRegisterWatchEvent(lockkey, notifyEvent.getWatchID());                        AcquireEvent acquireEvent = new AcquireEvent(lockkey, resp.getFencingToken(), lockOption, lockOption.getThreadID());                        EventCachedHandler.getInstance(this.wlockClient).registerAcquireEvent(acquireEvent);                        result.setRet(true);                        result.setLockVersion(notifyEvent.getFencingToken());                        result.setOwner(new LockOwner(acquireLockReq.getHost(), acquireLockReq.getThreadID(), acquireLockReq.getPid()));                        result.setResponseStatus(ResponseStatus.SUCCESS);                    } else {                        //超时返回锁获取失败                        result.setRet(false);                    }
                    var13 = result;                    return var13;                }              //加锁成功之后，将锁信息保存在本地                //若设置了续约时间会使用ScheduledExecutorService进行定时续约（续约逻辑在updateLockLocal里面）                if (resp.getStatus() == ResponseStatus.SUCCESS) {                    this.lockManager.updateLockLocal(lockkey, resp.getFencingToken(), lockOption, false);                    result.setRet(true);                    result.setLockVersion(resp.getFencingToken());                    result.setOwner(new LockOwner(resp.getOwnerHost(), resp.getThreadID(), resp.getPid()));                    AcquireEvent acquireEvent = new AcquireEvent(lockkey, resp.getFencingToken(), lockOption, lockOption.getThreadID());                    EventCachedHandler.getInstance(this.wlockClient).registerAcquireEvent(acquireEvent);                    var13 = result;                    return var13;                }                //超时直接返回                if (resp.getStatus() != ResponseStatus.TIMEOUT) {                    result.setRet(false);                    AcquireLockResult var12 = result;                    return var12;                }
                result.setRet(false);            }        } catch (Exception var17) {            logger.error(Version.INFO + ", tryAcquireLock error.", var17);        } finally {            //不管是成功获取到锁还是抛出了异常都需要注销watchEvent            this.watchManager.unRegisterWatchEvent(lockkey, lockOption.getWatchID());        }
        return result;    }}

加锁流程总结：线程首先尝试从本地进行加锁，如果加锁成功表示本次是锁重入，本地锁重入次数+1后直接返回，否则尝试从远程加锁，若加锁成功将锁信息保存在本地。若加锁失败会使用异步竞争锁方式，同步阻塞等待获取锁的消息，在等待过程中发生超时返回锁获取失败。

（2）释放锁：

public LockResult releaseLock(String lockkey, long lockVersion, boolean forced, long threadID) {   int timeout = this.wlockClient.getDefaultTimeoutForReq();   //从本地获取锁信息，若没获取到说明锁已释放(这里使用本地内存当机器重启时信息会丢失)   LockContext lockContext = lockManager.getLocalLockContext(lockkey, threadID);   if (lockContext == null) {      return new LockResult(false, ResponseStatus.LOCK_DELETED);   }
   long ownerThreadID = threadID;   if (lockVersion == -1) {      lockVersion = lockContext.getLockVersion();   }   if (ownerThreadID == -1) {      ownerThreadID = lockContext.getLockOption().getThreadID();   }
   //释放本地锁，将重入次数-1，若已到0删除本地锁并取消定时续约   int releaseRet = this.lockManager.releaseLockLocal(lockkey, ownerThreadID, forced);
   //releaseRet大于0表示锁未完全释放，本地解锁是重入次数-1，直接返回   if (releaseRet > 0) {      return new LockResult(true, ResponseStatus.SUCCESS);   }   //因为线程ID不匹配或释放一个尚未获取到的锁（也可以表现为锁已被删除或已过期）返回释放失败   if (releaseRet < 0) {      return new LockResult(false, ResponseStatus.LOCK_DELETED);   }
   //releaseRet等于0表示当前锁已完全释放，重入次数为0，需要释放服务器上的锁   int groupId = this.wlockClient.getRegistryKey().getGroupId();   ReleaseLockRequest releaseLockReq = protocolFactory.createReleaseLockReq(lockkey, groupId, this.registryKey, lockVersion, ownerThreadID, WLockClient.currentPid);   try {      //同步发送释放锁的请求      SendReqResult sendReqResult = this.serverPoolHandler.syncSendRequest(releaseLockReq, timeout, "releaseLock " + lockkey);      if (sendReqResult != null) {         ReleaseLockResponse resp = new ReleaseLockResponse();         resp.fromBytes(sendReqResult.getData());         if (resp.getStatus() == ResponseStatus.SUCCESS) {            //若锁释放成功，注销保存在本地的锁已获取事件            EventCachedHandler.getInstance(wlockClient).unRegisterAcquireEvent(lockkey, ownerThreadID);            return new LockResult(true, ResponseStatus.SUCCESS);         } else if (resp.getStatus() == ResponseStatus.TIMEOUT) {    //超时及其他返回失败            logger.error(Version.INFO + ", releaseLock status : " + ResponseStatus.toStr(resp.getStatus()) + ", lockkey : " + lockkey + ", server : " + sendReqResult.getServer() + ", timeout : " + timeout);         } else {            logger.error(Version.INFO + ", releaseLock status : " + ResponseStatus.toStr(resp.getStatus()) + ", lockkey : " + lockkey);         }
         return new LockResult(false, resp.getStatus());      }   } catch (Exception e) {      logger.error(Version.INFO + ", releaseLock error.", e);   }
   return new LockResult(false, ResponseStatus.TIMEOUT);}

解锁流程总结：首先从本地获取锁信息，若本地无锁信息表示锁已删除，否则进行锁重入次数-1，当锁已完全释放时（重入次数为0），进行远程解锁。

（3）加解锁流程总结：

  1. WLock的客户端及服务端都有加锁逻辑，首次加锁时使用服务端加锁，之后的锁重入都在客户端进行。

  2. 如果设置了自动续约间隔，在加锁成功之后客户端会自动进行锁续约（前提是在WLock服务管理平台设置了开启自动续约功能）。

  3. 阻塞式获取锁可以设置超时时间（RedissonLock的lock方法不可设置，但在非阻塞式的tryLock方法中可以设置超时时间）。
  4. 阻塞获取锁时如果获取锁失败会使用异步竞争锁方式，注册ACQUIRE类型的watchEvent后阻塞等待锁已获取的消息，服务端加锁结果异步通知的线程与客户端同步阻塞等待的线程使用watchEvent内部的CountDownLatch进行通信。
  5. WLock在本地保存锁重入信息而非在服务端保存锁重入信息（RedissonLock是在服务端保存），是因为锁放在服务端的话 可能会有网络等不确定因素导致加锁次数与释放锁次数不一致，比如客户端发起了三次加锁请求，在服务端都已经加锁成功，但是由于网络抖动某次请求发生了超时，这将导致客户端认为只加锁成功了两次，于是在释放锁时只调用了两次释放锁动作，实际上这时锁尚未完全释放（与WLock负责人沟通所知）。

5

死锁问题补充

不管是RedissonLock还是WLock都使用了客户端定时续约的方式延长锁过期时间，如果处理不当将造成死锁：由于加锁和锁续约在两个线程中执行，若加锁线程在释放锁之前异常退出将导致续约线程一直执行续约操作，造成死锁，此时只能使用重启进程的方式进行锁释放。所以业务在加锁处理逻辑的上层一定添加try catch 异常获，在finally逻辑中释放锁。加解锁操作参照阿里开发规范：

正例：  Lock lock = new XxxLock();  // ...  lock.lock();  try {      doSomething();      doOthers();  } finally {      lock.unlock();  }
反例：  Lock lock = new XxxLock();  // ...  try {      // 如果此处抛出异常，则直接执行 finally 代码块      doSomething();      // 无论加锁是否成功，finally 代码块都会执行      lock.lock();      doOthers();  } finally {      lock.unlock();  }


6

WLock使用工具类

目前我们部门的服务使用分布式锁的场景已全部切换至WLock，为了更加方便地使用WLock，我参照RedissonLock的API风格封装了一个工具类，可以帮助业务系统快速的接入，工具类源码如下：

/** * @author Archi Liu * @version 1.0 * @date 2021/11/10 3:20 下午 * 分布式锁服务 */@Slf4j@Service//@Conditional(WLockCondition.class)public class LockService {    /**     * WLock的秘钥文件名(秘钥文件从WLock管理平台下载)     */    @Value("${wlock.key.file:}")    private String keyName;
    /**     * 客户端请求失败重试次数，底层默认重试2次，可修改该值提升性能     */    @Value("${wlock.retryNum:-1}")    private Integer retryNum;
    /**     * 若未设置过期锁时间，则使用该过期时间（30秒）     */    private final int defaultExpireTime = 30 * 1000;
    /**     * 自动续期时间为过期时间的1/3     */    private final int defaultRenewIntervalTime = 10 * 1000;
    /**     * 配置文件路径，需要兼容WF及SCF项目在容器环境和本地环境上的路径     */    private static String configPath;
    /**     * WLock秘钥文件名称(优先级高于keyName)     */    private static String keyFileName;
    /**     * 操作WLock的客户端，使用懒加载单例模式（使用volatile禁止指令重排序）     */    private volatile WLockClient wLockClient;
    /**     * 如果是WF及SCF项目，需要调用该方法初始化WLock配置文件目录（scf-springboot项目做了兼容处理）     *     * @param path     */    public static void initConfigPath(String path) {        log.info("[LockUtil] preProcessConfigPath configPath:{}", path);        configPath = path;    }
    /**     * 如果项目未将yml/properties里面的键值对放入spring的PropertySourcesPlaceholderConfigurer中，需要使用此方法设置文件路径+文件名     *     * @param path     */    public static void initConfigPath(String path,String fileName) {        log.info("[LockUtil] preProcessConfigPath configPath:{}，fileName={}", path,fileName);        configPath = path;        keyFileName = fileName;    }
    /**     * 获取WLock配置文件所在路径，如果项目中未配置则先检查是否为scf-springboot项目容器部署环境，如果不是默认读取本地配置     *     * @return     */    private String getConfigPath() {        if (configPath != null) {            return configPath;        }
        //如果是在容器环境上发布的scf-springboot类型项目将会有该配置值        configPath = System.getProperty("scf.config.location");        if (StringUtils.isEmpty(configPath)) {            configPath = Thread.currentThread().getContextClassLoader().getResource("").getPath();        }        log.info("[LockUtil] postProcessConfigPath configPath:{}", configPath);
        return configPath;    }
    /**     * 获取单例WLockClient     *     * @return     */    private WLockClient getWLockClient() {        //使用局部变量减少读写volatile变量带来的性能损耗（参考spring单例实现模式）        WLockClient wLockClient = this.wLockClient;        if (wLockClient != null) {            return wLockClient;        }
        synchronized (WLockClient.class) {            wLockClient = this.wLockClient;            if (wLockClient != null) {                return wLockClient;            }
            try {                String realFileName = StringUtils.isNotEmpty(keyFileName) ? keyFileName : keyName;                wLockClient = new WLockClient(getConfigPath() + realFileName);                //如果设置了重试次数需要重置默认重试次数，默认重试次数为2次(defaultRetry默认值为3，WLock内部将首次发请求也算作一次retry)                if (retryNum >= 0) {                    wLockClient.setDefaultRetries(retryNum + 1);                }                this.wLockClient = wLockClient;            } catch (Exception e) {                log.error("[LockUtil] WLockClient init failed！exception:{}", ExceptionUtil.getStackTrace(e));                throw new DistributedLockException(ResponseCodeEnum.LOCK_CLIENT_INIT_FAIL);            }        }
        return wLockClient;    }

    /**     * 使用非阻塞方式尝试获取分布式锁，若获取成功返回true，否则返回false。初始锁过期时间为30秒，成功获取到锁之后将自动进行锁续期。     *     * @param lockName 锁名称     * @return     */    public boolean tryGetDistributedLock(String lockName) {        AcquireLockResult lockResult;
        try {            WDistributedLock wLock = getWLockClient().newDistributeLock(lockName);            lockResult = wLock.tryAcquireLockUnblocked(defaultExpireTime, defaultRenewIntervalTime, getRenewListener(), getLockExpireListener());        } catch (ParameterIllegalException e) {            log.error("[LockUtil] tryGetDistributedLock error! parameter illegal, lockName={}，lockExpireTime={},renewInterval={},exception:{}",                    lockName, defaultExpireTime, defaultRenewIntervalTime, ExceptionUtil.getStackTrace(e));            return false;        }
        log.info("[LockUtil] tryGetDistributedLock lockName={},result={}", lockName, lockResult.toString());        return lockResult.isSuccess();    }
    /**     * 使用非阻塞方式尝试获取分布式锁，若获取成功返回true，否则返回false。成功获取到锁之后锁将在指定过期时间之后过期     *     * @param lockName   锁名称     * @param expireTime 锁过期时间     * @param unit       锁过期时间单位     * @return     */    public boolean tryGetDistributedLock(String lockName, int expireTime, TimeUnit unit) {        //锁过期时间        int lockExpireTime = (int) unit.toMillis(expireTime);        AcquireLockResult lockResult;
        try {            WDistributedLock wdLock = getWLockClient().newDistributeLock(lockName);            lockResult = wdLock.tryAcquireLockUnblocked(lockExpireTime, getLockExpireListener());        } catch (ParameterIllegalException e) {            log.error("[LockUtil] tryGetDistributedLock error! parameter illegal, lockName={}，lockExpireTime={},exception:{}",                    lockName, lockExpireTime, ExceptionUtil.getStackTrace(e));            return false;        }
        log.info("[LockUtil] tryGetDistributedLock lockName={},result={}", lockName, lockResult.toString());        return lockResult.isSuccess();    }
    /**     * 使用阻塞方式尝试获取分布式锁，若未获取到将一直阻塞等待，初始锁过期时间为30秒，成功获取到锁之后将自动进行锁续期。     *     * @param lockName     */    public void getDistributedLock(String lockName) {        //锁自动续期间隔（过期时间的三分之一）        AcquireLockResult lockResult;
        try {            WDistributedLock wLock = getWLockClient().newDistributeLock(lockName);            lockResult = wLock.tryAcquireLock(defaultExpireTime, Integer.MAX_VALUE, defaultRenewIntervalTime, getRenewListener(), getLockExpireListener());        } catch (ParameterIllegalException e) {            log.error("[LockUtil] getDistributedLock error! parameter illegal, lockName={}，lockExpireTime={},lockMaxWaitTime={},renewInterval={},exception:{}",                    lockName, defaultExpireTime, Integer.MAX_VALUE, defaultRenewIntervalTime, ExceptionUtil.getStackTrace(e));            throw new DistributedLockException(ResponseCodeEnum.GET_LOCK_PARAM_ERROR);        }
        log.info("[LockUtil] getDistributedLock lockName={},lockResult={}", lockName, lockResult.toString());        if (!lockResult.isSuccess()) {            throw new DistributedLockException(ResponseCodeEnum.GET_LOCK_FAIL);        }    }
    /**     * 使用阻塞方式尝试获取分布式锁，若未获取到将一直阻塞等待，成功获取到锁之后锁将在指定过期时间之后过期     *     * @param lockName   锁名称     * @param expireTime 锁过期时间     * @param unit       锁过期时间单位     * @return     */    public void getDistributedLock(String lockName, int expireTime, TimeUnit unit) {        //锁过期时间        int lockExpireTime = (int) unit.toMillis(expireTime);        AcquireLockResult lockResult;
        try {            WDistributedLock wdLock = getWLockClient().newDistributeLock(lockName);            lockResult = wdLock.tryAcquireLock(lockExpireTime, Integer.MAX_VALUE, getLockExpireListener());        } catch (ParameterIllegalException e) {            log.error("[LockUtil] getDistributedLock error! parameter illegal, lockName={}，lockExpireTime={},lockMaxWaitTime={},exception:{}",                    lockName, lockExpireTime, Integer.MAX_VALUE, ExceptionUtil.getStackTrace(e));            throw new DistributedLockException(ResponseCodeEnum.GET_LOCK_PARAM_ERROR);        }
        log.info("[LockUtil] getDistributedLock lockName={},lockResult={}", lockName, lockResult.toString());        if (!lockResult.isSuccess()) {            throw new DistributedLockException(ResponseCodeEnum.GET_LOCK_FAIL);        }    }
    /**     * 使用阻塞方式尝试获取分布式锁，最多等待maxWaitTime时间，成功获取到锁之后锁将在指定过期时间之后过期     *     * @param lockName   锁名称     * @param expireTime 锁过期时间     * @param expireTime 最长等待时间     * @param unit       锁过期时间单位     * @return     */    public void getDistributedLock(String lockName, int expireTime, int maxWaitTime, TimeUnit unit) {        //锁过期时间        int lockExpireTime = (int) unit.toMillis(expireTime);        //获取锁最大等待时间        int lockMaxWaitTime = (int) unit.toMillis(maxWaitTime);        AcquireLockResult lockResult;
        try {            WDistributedLock wdLock = getWLockClient().newDistributeLock(lockName);            lockResult = wdLock.tryAcquireLock(lockExpireTime, lockMaxWaitTime, getLockExpireListener());        } catch (ParameterIllegalException e) {            log.error("[LockUtil] getDistributedLock error! parameter illegal, lockName={}，lockExpireTime={},lockMaxWaitTime={},exception:{}",                    lockName, lockExpireTime, lockMaxWaitTime, ExceptionUtil.getStackTrace(e));            throw new DistributedLockException(ResponseCodeEnum.GET_LOCK_PARAM_ERROR);        }
        log.info("[LockUtil] getDistributedLock lockName={},lockResult={}", lockName, lockResult.toString());        if (!lockResult.isSuccess()) {            //修改成获取分布式锁失败的异常            throw new DistributedLockException(ResponseCodeEnum.GET_LOCK_FAIL);        }    }
    /**     * 释放分布式锁，若释放成功返回true，否则返回false，锁释放失败不会抛出异常     *     * @param lockName 锁名称     * @return     */    public boolean releaseDistributedLock(String lockName) {        LockResult lockResult;        try {            WDistributedLock wdLock = getWLockClient().newDistributeLock(lockName);            lockResult = wdLock.releaseLock();        } catch (ParameterIllegalException e) {            log.error("[LockUtil] releaseDistributedLock error! parameter illegal,lockName={},exception:{}", lockName, ExceptionUtil.getStackTrace(e));            throw new DistributedLockException(ResponseCodeEnum.GET_LOCK_PARAM_ERROR);        }
        log.info("[LockUtil] releaseDistributedLock, lockName={}, result={}", lockName, lockResult.toString());        return lockResult.isSuccess();    }
    /**     * 锁续约回调通知     *     * @return     */    private RenewListener getRenewListener() {        RenewListener renewListener = new RenewListener() {            @Override            public void onRenewSuccess(String s) {                log.info("[LockUtil] renewSuccess! info={}", s);            }
            @Override            public void onRenewFailed(String s) {                log.info("[LockUtil] renewFailed! info={}", s);            }        };
        return renewListener;    }
    /**     * 锁过期回调通知     *     * @return     */    private LockExpireListener getLockExpireListener() {        LockExpireListener lockExpireListener = new LockExpireListener() {            @Override            public void onExpire(String s) {                log.info("[LockUtil] lock Expired! info={}", s);            }        };
        return lockExpireListener;    }}

本文分享自微信公众号 - 58技术（architects_58）。
如有侵权，请联系 [email protected] 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一起分享。

「」