1. 概况

栅栏:多个线程一起等待,直到任务都完成

使用场景:

将问题细分为 N 个小部分,当 N 个小部分全部完成任务时,await() 后面的方法才能运行

2. 类定义

3. 成员变量

只有一个成员变量 Sync ,同步逻辑主要由内部类 Sync 实现

  1. private final Sync sync;

4. 构造方法

构造方法直接调用内部类 Sync 的构造方法

  1. public CountDownLatch(int count) {
  2. if (count < 0) throw new IllegalArgumentException("count < 0");
  3. this.sync = new Sync(count);
  4. }

5. 成员方法

5.1 await

当前线程等待 latch == 0 才返回;此时线程可响应中断,并抛出 InterruptedException

latch 的值由 countDown 方法控制,sync.acquireSharedInterruptibly(1) 方法将调用 AQS 的 acquireSharedInterruptibly 方法,里面又调用到子类的 tryAcquireShared() 方法。

线程等待方法,具体实现就是查看 AQS 的 state 值是不是 0,如果不是 0,那么执行 AQS 里面的
doAcquireSharedInterruptibly 逻辑,死循环去获取共享锁。

  1. public void await() throws InterruptedException {
  2. sync.acquireSharedInterruptibly(1);
  3. }
  4. // AbstractQueuedSynchronizer 的 acquireSharedInterruptibly 实现
  5. public final void acquireSharedInterruptibly(int arg)
  6. throws InterruptedException {
  7. if (Thread.interrupted())
  8. throw new InterruptedException();
  9. if (tryAcquireShared(arg) < 0)
  10. doAcquireSharedInterruptibly(arg);
  11. }
  12. // 内部类 Sync 获取共享锁逻辑
  13. protected int tryAcquireShared(int acquires) {
  14. return (getState() == 0) ? 1 : -1;
  15. }

5.2 await(long timeout, TimeUnit unit)

等待超过时长就不再等待,若等待期间 count == 0,方法将返回 true,否则超过时长返回 false,等待期间被中断抛出 InterruptedException

  1. public boolean await(long timeout, TimeUnit unit)
  2. throws InterruptedException {
  3. return sync.tryAcquireSharedNanos(1, unit.toNanos(timeout));
  4. }
  5. // AbstractQueuedSynchronizer 中的方法
  6. public final boolean tryAcquireSharedNanos(int arg, long nanosTimeout)
  7. throws InterruptedException {
  8. if (Thread.interrupted())
  9. throw new InterruptedException();
  10. // tryAcquireShared 由子类实现
  11. return tryAcquireShared(arg) >= 0 ||
  12. doAcquireSharedNanos(arg, nanosTimeout); // 当 state == 0 或者 doAcquireSharedNanos 指定时间内获取锁成功返回 true,否则返回 false
  13. }

5.3 countDown

CountDownLatch 只用复写 tryReleaseShared,就可以完成释放锁的操作

  1. public void countDown() {
  2. sync.releaseShared(1);
  3. }
  4. // 内部类 Sync 的方法
  5. public final boolean releaseShared(int arg) {
  6. if (tryReleaseShared(arg)) {
  7. doReleaseShared(); // AQS 自己实现
  8. return true;
  9. }
  10. return false;
  11. }

5.4 getCount

返回 Sync 的 count

  1. public long getCount() {
  2. return sync.getCount();
  3. }

6. 内部类

根据 await,countDown 方法可知,CountDownLatch 获取共享锁以及释放共享锁的方法均由内部类 Sync 实现,它只用复写 tryAcquireShared,tryReleaseShared 逻辑,就可以完成共享锁的加锁与释放锁,其它的锁同步操作 AQS 都帮做了。

  1. private static final class Sync extends AbstractQueuedSynchronizer {
  2. private static final long serialVersionUID = 4982264981922014374L;
  3. // 初始化 设定 state 值
  4. Sync(int count) {
  5. setState(count);
  6. }
  7. int getCount() {
  8. return getState();
  9. }
  10. // 如果 state 不为 0,表示还可以获取,并不是独占的
  11. protected int tryAcquireShared(int acquires) {
  12. return (getState() == 0) ? 1 : -1;
  13. }
  14. // 将 state 的值减 1
  15. protected boolean tryReleaseShared(int releases) {
  16. // Decrement count; signal when transition to zero
  17. for (;;) {
  18. int c = getState();
  19. if (c == 0) // 锁已经释放
  20. return false;
  21. int nextc = c-1;
  22. if (compareAndSetState(c, nextc)) // 以 CAS 方式将 state 减 1
  23. return nextc == 0;
  24. }
  25. }
  26. }