CountDownLatch原始碼解析

zhang-minglei發表於2020-04-06
CountDownLatch原始碼

CountDownLatch是Java併發包下的一個工具類，latch是門閂的意思，顧名思義，CountDownLatch就是有一個門閂擋住了裡面的人（執行緒）出來，當count減到0的時候，門閂就開啟了，人（執行緒）就可以出來了。下面從原始碼的角度看看CountDownLatch究竟是如何實現的。

內部類

CountDownLatch類中有一個靜態內部類 Sync ，它繼承自 AbstractQueuedSynchronizer ，所以可以看出，CountDownLatch的功能還是通過AQS來實現的。

建構函式

public CountDownLatch(int count) {
    if (count < 0) throw new IllegalArgumentException("count < 0");
    this.sync = new Sync(count);
}
複製程式碼

可以看出要使用CountDownLatch就需要指定count值，且必須大於0，而這個count值最終是賦值給了AQS的state，可以看下面 new Sync(count)的原始碼，它實際上是set的state值，而這個state是AQS中的屬性

Sync(int count) {
	setState(count);
}
複製程式碼

方法

countDown方法

它是呼叫內部類Sync的releaseShared方法，這個方法會先去通過cas的方式修改state值，如果state修改之前就是0或者修改之後不等於0，那就什麼都不需要操作了；如果修改之後state=0，那麼就去執行doReleaseShared方法。

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) {
    // state=0或者修改之後state<>0，返回false
    for (;;) {
        int c = getState();
        if (c == 0)
          	return false;
        int nextc = c-1;
        //修改之後state值=0，返回true
        if (compareAndSetState(c, nextc))
        		return nextc == 0;
    }
}
複製程式碼
//這個方法countDown會呼叫，await方法在被喚醒後也會呼叫doReleaseShared
private void doReleaseShared() {
    for (;;) {
        Node h = head;
        if (h != null && h != tail) {
            int ws = h.waitStatus;
            // 如果狀態是signal(-1)，cas的方式把它改為0
            if (ws == Node.SIGNAL) {
                if (!compareAndSetWaitStatus(h, Node.SIGNAL, 0))
                    continue;            // loop to recheck cases
                //cas成功修改的話，則去喚醒h的下一個節點
                unparkSuccessor(h);
            }
            else if (ws == 0 &&
            				!compareAndSetWaitStatus(h, 0, Node.PROPAGATE))
            		continue;                // loop on failed CAS
        }
        //如果h和head相同了，則跳出迴圈
        if (h == head)                   // loop if head changed
        		break;
    }
}
複製程式碼
await方法

await方法是呼叫該方法的執行緒處於等待狀態（state>0），下面從原始碼分心一下await方法是如何實現的。

await方法最終呼叫到了AQS的acquireSharedInterruptibly方法

public final void acquireSharedInterruptibly(int arg)
    throws InterruptedException {
    if (Thread.interrupted())
      	throw new InterruptedException();
    //如果state=0，則tryAcquireShared方法返回1，則不用等待（也就驗證了countdown減到0，才釋放執行緒）
    if (tryAcquireShared(arg) < 0)
      	doAcquireSharedInterruptibly(arg);
}
複製程式碼
private void doAcquireSharedInterruptibly(int arg)
  throws InterruptedException {
    //把新node加到node的尾部
    final Node node = addWaiter(Node.SHARED);
    boolean failed = true;
    try {
      for (;;) {
        final Node p = node.predecessor();
        //如果node的prev是head的話
        if (p == head) {
          //看state是否=0，如果等於0，則r=1，否則r=-1
          int r = tryAcquireShared(arg);
          if (r >= 0) {
            //state=0的時候，把node置為head，然後去喚醒head的下一個節點
            //setHeadAndPropagate方法參照下面的解析
            setHeadAndPropagate(node, r);
            p.next = null; // help GC
            failed = false;
            return;
          }
        }
        //如果p的status是signal（-1）的話，則執行parkAndCheckInterrupt方法，將該執行緒掛起
        if (shouldParkAfterFailedAcquire(p, node) &&
            parkAndCheckInterrupt())
          throw new InterruptedException();
      }
    } finally {
      if (failed)
        cancelAcquire(node);
    }
}
複製程式碼
private void setHeadAndPropagate(Node node, int propagate) {
    Node h = head; 
    setHead(node);

    if (propagate > 0 || h == null || h.waitStatus < 0 ||
          (h = head) == null || h.waitStatus < 0) {
        Node s = node.next;
        if (s == null || s.isShared())
            //呼叫doReleaseShared，去喚醒新head的下一個節點
          	doReleaseShared();
    }
}
複製程式碼

例子

下面舉個例子說明CountDownLatch的用法，而且如果大家是想通過debug的方式跟蹤CountDownLatch是如何實現的，那麼在斷點處的suspend一定要改為Thread，因為在await的時候，執行緒掛起，而在countDown的時候，首先把head的next節點(暫時稱作A節點)喚醒，而此時A節點在await掛起的執行緒就被喚醒了，繼續往下執行，由於await方法會呼叫setHeadAndPropagate方法，setHeadAndPropagate方法會呼叫doReleaseShared（countDown也是呼叫這個方法喚醒執行緒）,所以除了呼叫countDown的執行緒，被喚醒的執行緒也會去喚醒它的下一個節點，所以doReleaseShared方法是被多執行緒呼叫的，因此在debug的時候一定要把suspend改為Thread才能看到效果。

public void test() throws InterruptedException {
    CountDownLatch countDownLatch = new CountDownLatch(1);

    for (int i = 0; i < 5; i++) {
        new Thread(() -> {
            try {
                System.out.println("子執行緒" + Thread.currentThread().getName() + "await 前");
                countDownLatch.await();
                System.out.println("子執行緒" + Thread.currentThread().getName() + "await 後");
            } catch (InterruptedException e) {
              	e.printStackTrace();
            }
        }).start();
    }

    Thread.sleep(30000);
    countDownLatch.countDown();
    System.out.println("完成");
}
複製程式碼

相關文章