CountDownLatch浅析

背景

前边的文章中已经介绍了JAVA多线程并发工程实践中一批常用的类，比如最为核心的AQS（AbstractQueuedSynchronizer），基本上JAVA多线程并发实践中的常用类的实现都与它能扯上关系；比如ReentrantLock，它实现了可重入的锁，一定程度上弥补了synchronized关键字的不足；比如Condition，它与ReentrantLock相结合，实现了条件等待队列，并提供了线程挂起/唤醒机制。本文中，我们将简单介绍一下CountDownLatch。所谓CountDownLatch，在字面意思上为闭锁，但是在工程实践中，据我个人的体会，它更像是一座城门。

在使用CountDownLatch的时候，通常都要完成以下几步：

1. 设置配额，即需要countDown几次才可以开启城门；
2. 设置等待点，线程在等待点处await，即在预定的交通要道上设置城门；
3. 执行countDown操作，每当一个线程到达的时候，执行配额-1操作，直到配额为0，达成通过条件，开启城门，让在等待点处等待执行的线程继续向下执行。

CountDownLatch的使用场景通常都是需要在程序执行的过程中的某一个等待点，待部分或全部线程到达之后（根据CountDownLatch的配额），再进入下一步的使用场景。

主要方法分析

主要方法主要有await和countDown。

await方法

与之前分析的ReentrantLock和Condition的排他模式不同，CountDownLatch采用的是共享模式，从而拥有以下两个不同点：

1. 加入到线程同步队列中的节点是共享模式的（Node.SHARED）；
2. CountDownLatch内置了符合自身特点的Sync的实现，即线程在await方法中被唤醒之后，如果state为0了且是线程同步队列中的第一个等待的线程（即头节点之后的第一个节点，因为头节点为new Node），则需要将自身设置为线程同步队列的头节点，并唤醒队列中后边的线程。

下边我们来详细地看一下代码：

首先获取当前state，如果为0表示线程已全部到齐，可以进行下一步了，函数；如果为非0则进入doAcquireSharedInterruptibly方法，将线程park。doAcquireSharedInterruptibly方法与ReentrantLock执行lock方法的执行流程比较相似。先将自身包装成Node，加入到线程同步队列中，然后进入死循环。死循环中，检查其前置节点是否为head，如果为head那就说明当前线程有可执行的可能，获取当前state，如果state为0了，说明线程已全部到达等待点，则将当前节点设置为头节点，并将其后置节点对应的线程唤醒；否则将当前线程加入线程同步队列，并将其park。

    public void await() throws InterruptedException {
        sync.acquireSharedInterruptibly(1);
    }
public final void acquireSharedInterruptibly(int arg)
            throws InterruptedException {
        if (Thread.interrupted())
            throw new InterruptedException();
        if (tryAcquireShared(arg) < 0)
            doAcquireSharedInterruptibly(arg);
    }
protected int tryAcquireShared(int acquires) {
            return (getState() == 0) ? 1 : -1;
        }
private void doAcquireSharedInterruptibly(int arg)
        throws InterruptedException {
        final Node node = addWaiter(Node.SHARED);
        boolean failed = true;
        try {
            for (;;) {
                final Node p = node.predecessor();
                if (p == head) {
                    int r = tryAcquireShared(arg);
                    if (r >= 0) {
                        setHeadAndPropagate(node, r);
                        p.next = null; // help GC
                        failed = false;
                        return;
                    }
                }
                if (shouldParkAfterFailedAcquire(p, node) &&
                    parkAndCheckInterrupt())
                    throw new InterruptedException();
            }
        } finally {
            if (failed)
                cancelAcquire(node);
        }
    }

countDown方法

相对而言，countDown方法简单一些。其首先将state做减一操作，然后通过CAS操作设置新的state值。如果此时state值为0了，那么说明可以唤醒在等待点等待的线程了。在doReleaseShared方法中，进入死循环，从头节点开始，如果它的等待状态时SIGNAL，则通过CAS操作将其设置为0（初始状态），并唤醒其后继节点。

public void countDown() {
        sync.releaseShared(1);
    }
public final boolean releaseShared(int arg) {
        if (tryReleaseShared(arg)) {
            doReleaseShared();
            return true;
        }
        return false;
    }
protected boolean tryReleaseShared(int releases) {
            // Decrement count; signal when transition to zero
            for (;;) {
                int c = getState();
                if (c == 0)
                    return false;
                int nextc = c-1;
                if (compareAndSetState(c, nextc))
                    return nextc == 0;
            }
        }
private void doReleaseShared() {
        /*
         * Ensure that a release propagates, even if there are other
         * in-progress acquires/releases.  This proceeds in the usual
         * way of trying to unparkSuccessor of head if it needs
         * signal. But if it does not, status is set to PROPAGATE to
         * ensure that upon release, propagation continues.
         * Additionally, we must loop in case a new node is added
         * while we are doing this. Also, unlike other uses of
         * unparkSuccessor, we need to know if CAS to reset status
         * fails, if so rechecking.
         */
        for (;;) {
            Node h = head;
            if (h != null && h != tail) {
                int ws = h.waitStatus;
                if (ws == Node.SIGNAL) {
                    if (!compareAndSetWaitStatus(h, Node.SIGNAL, 0))
                        continue;            // loop to recheck cases
                    unparkSuccessor(h);
                }
                else if (ws == 0 &&
                         !compareAndSetWaitStatus(h, 0, Node.PROPAGATE))
                    continue;                // loop on failed CAS
            }
            if (h == head)                   // loop if head changed
                break;
        }
    }

我们假想一下，如果我们设置了一个state为1的CountDownLatch，线程1执行到等待点时调用await，按上述流程，它将被挂起（因为tryAcquireShared方法返回值小于0）；稍后，线程2也执行到了等待点，调用await，按上述流程，它将会被排在线程同步队列的线程1对应的Node的后边。之后，对CountDownLatch执行countDown操作，在countDown方法中，将state从1递减为0，取得头节点，并唤醒其后继节点，即线程1。线程1恢复运行，在await方法中，检查state是否为0，此时为0了，因此继续唤醒其后继节点，即线程2。从而实现两个线程在等待点同时被唤醒，继续执行后续操作的效果。