Jan 28, 2022

ZooKeeper框架Curator分布式锁实现及源代码分析

第四章 ZooKeeper框架Curator分布式锁实现及源代码分析

上一篇文章中，我们使用zookeeper的java api实现了分布式排他锁。其实zookeeper有一个优秀的框架---Curator，提供了各种分布式协调的服务。Curator中有着更为标准、规范的分布式锁实现。与其我们自己去实现，不如直接使用Curator。通过学习Curator的源代码，我们也能了解实现分布式锁的最佳实践。

Curator中有各种分布式锁，本文挑选其中一个---InterProcessMutex进行讲解。

我们先看一下Curator代码中对于InterProcessMutex的注释：

可重入的互斥锁，跨JVM工作。使用ZooKeeper来控制锁。所有JVM中的任何进程，只要使用同样的锁路径，将会成为跨进程的一部分。此外，这个排他锁是“公平的”，每个用户按照申请的顺序得到排他锁。

可见InterProcessMutex和我们自己实现的例子都是一个排他锁，此外还可以重入。

如何使用InterProcessMutex

在分析InterProcessMutex代码前，我们先看一下它是如何使用的，下面代码简单展示了InterProcessMutex的使用：

    public static void soldTickWithLock(CuratorFramework client) throws Exception {
        //创建分布式锁, 锁空间的根节点路径为/curator/lock
        InterProcessMutex mutex = new InterProcessMutex(client, "/curator/locks");
        mutex.acquire();
 
        //获得了锁, 进行业务流程
        //代表复杂逻辑执行了一段时间
        int sleepMillis = (int) (Math.random() * 2000);
        Thread.sleep(sleepMillis);
 
        //完成业务流程, 释放锁
        mutex.release();
    }

使用方式和我们自己编写的锁是一样的，首先通过mutex.acquire()获取锁，该方法会阻塞进程，直到获取锁，然后执行你的业务方法，最后通过 mutex.release()释放锁。

接下来我们进入正题，展开分析Curator关于分布式锁的实现。

实现思路

Curator设计方式和之前我们自己实现的方式是类似的：

1、创建有序临时节点

2、触发“尝试取锁逻辑”，如果自己是临时锁节点序列的第一个，则取得锁，获取锁成功。

3、如果自己不是序列中第一个，则监听前一个锁节点变更。同时阻塞线程。

4、当前一个锁节点变更时，通过watcher恢复线程，然后再次到步骤2“尝试取锁逻辑”

如下图所示：

代码实现概述

Curator对于排它锁的顶层实现逻辑在InterProcessMutex类中，它对客户端暴露锁的使用方法，如获取锁和释放锁等。但锁的上述实现逻辑，是由他持有的LockInternals对象来具体实现的。LockInternals使用StandardLockInternalsDriver类中的方法来做一些处理。

简单点解释，我们打个比方，Curator好比是一家公司承接各种业务，InterProcessMutex是老板，收到自己客户（client）的需求后，分配给自己的下属LockInternals去具体完成，同时给他一个工具StandardLockInternalsDriver，让他在做任务的过程中使用。如下图展示：

接下来我们将深入分析InterProcessMutex、LockInternals及StandardLockInternalsDriver类。

InterProcessMutex源码分析

InterProcessMutex类是curator中的排它锁类，客户端直接打交道的就是InterProcessMutex。所以我们从顶层开始，先分析InterProcessMutex。

实现接口

InterProcessMutex实现了两个接口:

public class InterProcessMutex implements InterProcessLock, Revocable<InterProcessMutex>

InterProcessLock是分布式锁接口，分布式锁必须实现接口中的如下方法：

1、获取锁，直到锁可用

public void acquire() throws Exception;

2、在指定等待的时间内获取锁。

public boolean acquire(long time, TimeUnit unit) throws Exception;

3、释放锁

public void release() throws Exception;

4、当前线程是否获取了锁

boolean isAcquiredInThisProcess();

以上方法也是InterProcessMutex暴露出来，供客户端在使用分布式锁时调用。

Revocable,实现该接口的锁，锁是可以被撤销的。本编文章重点讲解锁的实现机制，关于撤销部分不做讨论。

属性

InterProcessMutex属性如下：

类型	名称	说明
LockInternals	internals	锁的实现都在该类中，InterProcessMutex通过此类的方法实现锁
String	basePath	锁节点在zk中的根路径
ConcurrentMap<Thread, LockData>	threadData	线程和自己的锁相关数据映射
String	LOCK_NAME	表示锁节点的前缀

它还有一个内部静态类LockData，也是threadData中保存的value，它定义了锁的相关数据，包括锁所属线程，锁的全路径，和该线程加锁的次数（InterProcessMutex为可重入锁）。代码如下：

private static class LockData
{
    final Thread owningThread;
    final String lockPath;
    final AtomicInteger lockCount = new AtomicInteger(1);
 
    private LockData(Thread owningThread, String lockPath)
    {
        this.owningThread = owningThread;
        this.lockPath = lockPath;
    }
}

构造方法

InterProcessMutex有三个构造方法，根据入参不同，嵌套调用，最终调用的构造方法如下：

InterProcessMutex(CuratorFramework client, String path, String lockName, int maxLeases, LockInternalsDriver driver)
{
    basePath = PathUtils.validatePath(path);
    internals = new LockInternals(client, driver, path, lockName, maxLeases);
}

可见构造方法最终初始化了两个属性，basePath被设置为我们传入的值 "/curator/lock"，这是锁的根节点。此外就是初始化了internals，前面说过internals是真正实现锁功能的对象。真正干活的是internals。

构造完InterProcessMutex对象后，我们看看它是如何工作的。

方法

InterProcessMutex实现InterProcessLock接口，关于分布式锁的几个方法都在这个接口中，我们看看InterProcessMutex是如何实现的。

获得锁

获得锁有两个方法，区别为是否限定了等待锁的时间长度。其实最终都是调用的私有方法internalLock()。不限定等待时长的代码如下：

public void acquire() throws Exception
{
    if ( !internalLock(-1, null) )
    {
        throw new IOException("Lost connection while trying to acquire lock: " + basePath);
    }
}

可以看到internalLock()返回false时，只可能因为连接超时，否则会一直等待获取锁。

internalLock逻辑如下：

取得当前线程在threadData中的lockData
如果存在该线程的锁数据，说明是锁重入， lockData.lockCount加1，直接返回true。获取锁成功
如果不存在该线程的锁数据，则通过internals.attemptLock()获取锁，此时线程被阻塞，直至获得到锁
锁获取成功后，把锁的信息保存到threadData中。
如果没能获取到锁，则返回false。

完整代码如下：

private boolean internalLock(long time, TimeUnit unit) throws Exception
{
    /*
       Note on concurrency: a given lockData instance
       can be only acted on by a single thread so locking isn't necessary
    */
 
    Thread currentThread = Thread.currentThread();
 
    LockData lockData = threadData.get(currentThread);
    if ( lockData != null )
    {
        // re-entering
        lockData.lockCount.incrementAndGet();
        return true;
    }
 
    String lockPath = internals.attemptLock(time, unit, getLockNodeBytes());
    if ( lockPath != null )
    {
        LockData newLockData = new LockData(currentThread, lockPath);
        threadData.put(currentThread, newLockData);
        return true;
    }
 
    return false;
}

可以看到获取锁的核心代码是internals.attemptLock

释放锁

释放锁的方法为release()，逻辑如下：

从threadData中取得当前线程的锁数据，有如下情况：

不存在，抛出无此锁的异常
存在，而且lockCount-1后大于零，说明该线程锁重入了，所以直接返回，并不在zk中释放。
存在，而且lockCount-1后小于零，说明有某种异常发生，直接抛异常
存在，而且lockCount-1等于零，这是无重入的正确状态，需要做的就是从zk中删除临时节点，通过internals.releaseLock()，不管结果如何，在threadData中移除该线程的数据。

InterProcessMutex小结

分布式锁主要用到的是上面两个方法，InterProcessMutex还有些其他的方法，这里就不做具体讲解，可以自己看一下，实现都不复杂。

通过对InterProcessMutex的讲解，相信我们已经对锁的获得和释放有了了解，应该也意识到真正实现锁的是LockInternals类。接下来我们将重点讲解LockInternals。

LockInternals源码分析

Curator通过zk实现分布式锁的核心逻辑都在LockInternals中，我们按获取锁到释放锁的流程为指引，逐步分析LockInternals的源代码。

获取锁

在InterProcessMutex获取锁的代码分析中，可以看到它是通过internals.attemptLock(time, unit, getLockNodeBytes());来获取锁的，那么我们就以这个方法为入口。此方法的逻辑比较简单，如下：

通过driver在zk上创建锁节点，获得锁节点路径。通过internalLockLoop()方法阻塞进程，直到获取锁成功。核心代码如下：

ourPath = driver.createsTheLock(client, path, localLockNodeBytes);
hasTheLock = internalLockLoop(startMillis, millisToWait, ourPath);

我们继续分析internalLockLoop方法，获取锁的核心逻辑在此方法中。 internalLockLoop中通过while自旋，判断锁如果没有被获取，将不断的去尝试获取锁。

while循环中逻辑如下：

通过driver查看当前锁节点序号是否排在第一位，如果排在第一位，说明取锁成功，跳出循环
如果没有排在第一位，则监听自己的前序锁节点，然后阻塞线程。

当前序节点释放了锁，监听会被触发，恢复线程，此时主线程又回到while中第一步。

重复以上逻辑，直至获取到锁（自己锁的序号排在首位）。

internalLockLoop方法核心代码如下：

while ( (client.getState() == CuratorFrameworkState.STARTED) && !haveTheLock )
{
    List<String>        children = getSortedChildren();
    String              sequenceNodeName = ourPath.substring(basePath.length() + 1); // +1 to include the slash
 
    PredicateResults    predicateResults = driver.getsTheLock(client, children, sequenceNodeName, maxLeases);
    if ( predicateResults.getsTheLock() )
    {
        haveTheLock = true;
    }
    else
    {
        String  previousSequencePath = basePath + "/" + predicateResults.getPathToWatch();
 
        synchronized(this)
        {
            try 
            {
                // use getData() instead of exists() to avoid leaving unneeded watchers which is a type of resource leak
                client.getData().usingWatcher(watcher).forPath(previousSequencePath);
                if ( millisToWait != null )
                {
                    millisToWait -= (System.currentTimeMillis() - startMillis);
                    startMillis = System.currentTimeMillis();
                    if ( millisToWait <= 0 )
                    {
                        doDelete = true;    // timed out - delete our node
                        break;
                    }
 
                    wait(millisToWait);
                }
                else
                {
                    wait();
                }
            }
            catch ( KeeperException.NoNodeException e ) 
            {
                // it has been deleted (i.e. lock released). Try to acquire again
            }
        }
    }
}

获取锁的主要代码逻辑我们到这就已经分析完了，可见和我们自己的实现还是基本一样的。此外上面提到了driver对象，也就是StandardLockInternalsDriver类，它提供了一些辅助的方法，比如说在zk创建锁节点，判断zk上锁序列第一位是否为当前锁，锁序列的排序逻辑等。我们就不具体讲解了。

释放锁

释放锁的逻辑很简单，移除watcher，删除锁节点。代码如下：

final void releaseLock(String lockPath) throws Exception
 
{
 
client.removeWatchers();
 
revocable.set(null);
 
deleteOurPath(lockPath);
 
}

总结

至此，Curator中InterProcessMutex的源代码分析全部完成。简单回顾下，InterProcessMutex类封装上层逻辑，对外暴露锁的使用方法。而真正的锁实现逻辑在LockInternals中，它通过对zk临时有序锁节点的创建和监控，判断自己的锁序号是否在首位，来实现锁的获取。此外它还结合StandardLockInternalsDriver提供的方法，共同实现了排他锁。 ———————————————— 版权声明：本文为CSDN博主「爱码叔（稀有气体）」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。原文链接：https://blog.csdn.net/liyiming2017/article/details/83896169

Except where otherwise noted, content on this page is copyrighted.

爱码叔-iCodeBook

专注于软件设计、系统架构。让编程学习如此简单。

ZooKeeper框架Curator分布式锁实现及源代码分析

第四章 ZooKeeper框架Curator分布式锁实现及源代码分析

如何使用InterProcessMutex

实现思路

代码实现概述

InterProcessMutex源码分析

LockInternals源码分析

Read This

ZooKeeper分布式锁实现java例子，附完整可运行源代码

爱码叔-iCodeBook

专注于软件设计、系统架构。让编程学习如此简单。

ZooKeeper框架Curator分布式锁实现及源代码分析

第四章 ZooKeeper框架Curator分布式锁实现及源代码分析

如何使用InterProcessMutex

实现思路

代码实现概述

InterProcessMutex源码分析

LockInternals源码分析

Subscribe

Read This

ZooKeeper分布式锁实现java例子，附完整可运行源代码