AQS家族的“外门弟子”：CyclicBarrier

朴灿烈づ我的快乐病毒、 2023-10-12 18:31 39阅读 0赞

今天我们来学习AQS家族的“外门弟子”：CyclicBarrier。

为什么说CyclicBarrier是AQS家族的“外门弟子”呢？那是因为CyclicBarrier自身和内部类Generation并没有继承AQS，但在源码的实现中却深度依赖AQS家族的成员ReentrantLock。就像修仙小说中，大家族会区分外门和内门，外门弟子通常会借助内门弟子的名声行事，CyclicBarrier正是这样，因此算是AQS家族的“外门弟子”。**在实际的面试中，CyclicBarrier的出现的次数较少，通常会出现在与CountDownLatch比较的问题当中**。

今天我们就逐步拆解CyclicBarrier，来看看它与CountDownLatch之间到底有什么差别。

### CyclicBarrier是什么？ ###

先从CyclicBarrier的名字开始入手，Cyclic是形容词，译为“循环的，周期的”，Barrier是名词，译为“屏障，栅栏”，组合起来就是“循环的屏障”，那么该怎么理解“循环的屏障”呢？我们来看CyclicBarrier的注释是怎么解释的：

> A synchronization aid that allows a set of threads to all wait for each other to reach a common barrier point. CyclicBarrier是一种同步辅助工具，允许一组线程等待彼此到达共同的屏障点。

The barrier is called cyclic because it can be re-used after the waiting threads are released. 因为在等待线程释放后可以重复使用，所以屏障被称为循环屏障。

看起来与CountDownLatch有些相似，我们通过一张图来展示下CyclicBarrier是怎样工作的：

![format_png][]

部分线程到达屏障后，会在屏障处等待，只有全部线程都到达屏障后，才会继续执行。如果以[CountDownLatch][]中越野徒步来举例的话，把老板拿掉，选手之间的互相等待，就是CyclicBarrier了。

另外，注释中说CyclicBarrier是“re-used”，即可重复使用的。回想一下CountDownLatch的实现，并未做任何重置计数器的工作，即**当CountDownLatch的计数减为0后不能恢复，也就是说CountDownLatch的功能是一次性的**。

**Tips**：实际上，可以用CountDownLatch实现类似于CyclicBarrier的功能。

### CyclicBarrier怎么用？ ###

我们用没有老板参加的越野徒步来举例，部分先到的选手要等待后到的选手一起吃午饭，用CyclicBarrier来实现的代码是这样的：

Java

复制代码

`// 初始化CyclicBarrier CyclicBarrier cyclicBarrier = new CyclicBarrier(10); for (int i = 0; i < 10; i++) { int finalI = i; new Thread(() -> { try { TimeUnit.SECONDS.sleep((finalI + 1)); } catch (InterruptedException e) { throw new RuntimeException(e); } try { System.out.println("选手[" + finalI + "]到达终点,等待其他选手！！！"); // 线程在屏障点处等待 cyclicBarrier.await(); System.out.println("选手[" + finalI + "]开始吃午饭啦！！！"); } catch (InterruptedException | BrokenBarrierException e) { throw new RuntimeException(e); } }).start(); }`

用法和CountDownLatch很相似，**构造函数设置CyclicBarrier需要多少个线程达到屏障后统一行动**，区别是CyclicBarrier在每个线程中都调用了`CyclicBarrier#await`，而我们在使用CountDownLatch时只在主线程中调用了一次`CountDownLatch#await`。

那CountDownLatch可以在线程中调用`CountDownLatch#await`吗？答案是可以的，这样使用的效果和CyclicBarrier是一样的：

Java

复制代码

`CountDownLatch countDownLatch = new CountDownLatch(10); for (int i = 0; i < 10; i++) { int finalI = i; new Thread(() -> { try { TimeUnit.SECONDS.sleep((finalI + 1)); } catch (InterruptedException e) { throw new RuntimeException(e); } System.out.println("选手[" + finalI + "]到达终点！！！"); countDownLatch.countDown(); try { countDownLatch.await(); System.out.println("选手[" + finalI + "]开始吃午饭啦！！！"); } catch (InterruptedException e) { throw new RuntimeException(e); } }).start(); }`

通过上面的例子，我们不难想到`CyclicBarrier#await`方法是同时具备了`CountDownLatch#countDown`方法和`CountDownLatch#await`方法的能力，**即执行了计数减1，又执行了暂停线程**。

### CyclicBarrier是怎么实现的？ ###

我们先整体认识一下CyclicBarrier：

![format_png 1][]

CyclicBarrier的内部结构比CountDownLatch复杂一些，除了我们前面提到的借助AQS的“内门弟子”ReentrantLock类型的`lock`和Condition类型的`trip`外，CyclicBarrier还有两个“特别”的地方：

*  内部类Generation，直译过来是“代”，它起到什么作用？
 *  Runnable类型的成员变量`barrierCommand`，它又做了些什么？

其余的部分，大部分可以在CountDownLatch中找到对应的方法，或者通过名称我们就很容易得知它们的作用。

CyclicBarrier的构造方法

CyclicBarrier提供了两个（实际是一个）构造方法：

Java

复制代码

`// 需要到达屏障的线程数 private final int parties; // 所有线程都到达后执行的动作 private final Runnable barrierCommand; // 计数器 private int count; public CyclicBarrier(int parties) { this(parties, null); } public CyclicBarrier(int parties, Runnable barrierAction) { if (parties <= 0) { throw new IllegalArgumentException(); } this.parties = parties; this.count = parties; this.barrierCommand = barrierAction; }`

第二个构造函数接收了两个参数：

*  `parties`：表示需要多少个线程到达屏障处调用`CyclicBarrier#await`；
 *  `barrierAction`：所有线程到达屏障后执行的动作。

构造方法的代码一如既往的简单，只有一处比较容易产生疑惑，`parties`和`count`有什么区别？

首先来看成员变量的声明，`parties`使用了`final`，表明它是不可变的对象，代表CyclicBarrier需要几个线程共同到达屏障处；而`count`是计数器，初始值是`parties`，随着到达屏障处的线程数量增多`count`会逐步减少至0。

CyclicBarrier的内部类Generation

Java

复制代码

`private static class Generation { Generation() {} boolean broken; }`

Generation用于标记CyclicBarrier的当前代，Doug Lea是这么解释它的作用的：

> Each use of the barrier is represented as a generation instance. The generation changes whenever the barrier is tripped, or is reset. 每次使用屏障（CyclicBarrier）都需要一个Generation实例。无论是通过屏障还是重置屏障，Generation都会发生改变。

Generation中的`broken`用于标记当前的CyclicBarrier是否被打破，默认为false，值为true时表示当前CyclicBarrier已经被打破，此时CyclicBarrier不能正常使用，需要调用`CyclicBarrier#reset`方法重置CyclicBarrier的状态。

CyclicBarrier\#await方法

前面我们猜测`CyclicBarrier#await`方法**即实现了计数减1，又实现了线程等待的功能**，下面我们就通过源码来验证我们的想法：

Java

复制代码

`public int await() throws InterruptedException, BrokenBarrierException { try { return dowait(false, 0L); } catch (TimeoutException toe) { throw new Error(toe); } } public int await(long timeout, TimeUnit unit) throws InterruptedException, BrokenBarrierException, TimeoutException { return dowait(true, unit.toNanos(timeout)); }`

两个重载方法都指向了`CyclicBarrier#dowait`方法：

Java

复制代码

`private int dowait(boolean timed, long nanos) throws InterruptedException, BrokenBarrierException, TimeoutException { // 使用ReentrantLock final ReentrantLock lock = this.lock; lock.lock(); try { // 第2部分 // 获取CyclicBarrier的当前代，并检查CyclicBarrier是否被打破 final Generation g = generation; if (g.broken) { throw new BrokenBarrierException(); } // 线程被中断时，调用breakBarrier方法 if (Thread.interrupted()) { breakBarrier(); throw new InterruptedException(); } // 第3部分 //计数器减1 int index = --count; // 计数器为0时表示所有线程都到达了，此时要做的就是唤醒等待中的线程 if (index == 0) { boolean ranAction = false; try { // 执行唤醒前的操作 final Runnable command = barrierCommand; if (command != null) { command.run(); } ranAction = true; // CyclicBarrier进入下一代 nextGeneration(); return 0; } finally { if (!ranAction) { breakBarrier(); } } } // 第4部分 // 只有部分线程到达屏障处的情况 for (;;) { try { //调用等待逻辑） if (!timed) { trip.await(); } else if (nanos > 0L) { nanos = trip.awaitNanos(nanos); } } catch (InterruptedException ie) { // 线程被中断时，调用breakBarrier方法 if (g == generation && ! g.broken) { breakBarrier(); throw ie; } else { Thread.currentThread().interrupt(); } } if (g.broken) { throw new BrokenBarrierException(); } // 如果不是当前代，返回计数器的值 if (g != generation) { return index; } // 如果等待超时，调用breakBarrier方法 if (timed && nanos <= 0L) { breakBarrier(); throw new TimeoutException(); } } } finally { lock.unlock(); } }`

`CyclicBarrier#dowait`方法看起来很长，但如果拆成3部分来看逻辑并不复杂：

*  第1部分：CyclicBarrier与线程的状态校验；
 *  第2部分：当计数器减1后值为0时，唤醒所有等待中的线程；
 *  第3部分：当计数器减1后值不为0时，线程进入等待状态。

先来看第1部分，CyclicBarrier与线程的状态校验的部分，先是判断CyclicBarrier是否被打破，接着判断当前线程是否为中断状态，如果是则调用`CyclicBarrier#breakBarrier`方法：

Java

复制代码

`private void breakBarrier() { generation.broken = true; count = parties; trip.signalAll(); }`

`CyclicBarrier#breakBarrier`方法非常简单，只做了3件事：

*  标记CyclicBarrier被打破；
 *  重置CyclicBarrier的计数器；
 *  唤醒全部等待中的线程。

也就是说，一旦有个线程标记为中断状态，都会直接打破CyclicBarrier的屏障。

我们先跳过第2部分的唤醒逻辑，直接来看第3部分线程进入等待状态的逻辑。根据`timed`参数选择调用Condition不同的等待方法，随后是对异常的处理和线程中断状态的处理，同样是调用`CyclicBarrier#breakBarrier`，标记CyclicBarrier不可用。线程进入等待状态的逻辑并不复杂，本质上是通过AQS的Condition来实现的。

最后来看第2部分唤醒所有等待中线程的操作，根据计数器是否为0判断是否需要进行唤醒。如果需要唤醒，最后一个执行`CyclicBarrier#await`的线程执行`barrierCommand`（此时尚未执行任何线程唤醒的操作），做通过屏障前的处理操作，接着调用`CyclicBarrier#nextGeneration`方法：

Java

复制代码

`private void nextGeneration() { trip.signalAll(); count = parties; generation = new Generation(); }`

`CyclicBarrier#nextGeneration`方法也做了3件事：

*  唤醒所有Condition上等待的线程；
 *  重置CyclicBarrier的计数器；
 *  创建新的Generation对象。

很符合进入“下一代”的名字，先唤醒“上一代”所有等待中的线程，然后重置CyclicBarrier的计数器，最后更新CyclicBarrier的Generation对象，对CyclicBarrier进行重置工作，让CyclicBarrier进入下一个纪元。

到这里我们不难发现，**CyclicBarrier自身只做了维护计数器和重置计数器的工作，而保证互斥性和线程的等待与唤醒则是依赖AQS家族的成员完成的：**

*  ReentrantLock保证了同一时间只有一个线程可以执行`CyclicBarrier#await`，即同一时间只有一个线程可以维护计数器；
 *  Condition为CyclicBarrier提供了条件等待队列，完成了线程的等待与唤醒的工作。

CyclicBarrier\#reset方法

最后我们来看`CyclicBarrier#reset`方法：

Java

复制代码

`public void reset() { final ReentrantLock lock = this.lock; lock.lock(); try { // 主动打破CyclicBarrier breakBarrier(); // 使CyclicBarrier进入下一代 nextGeneration(); } finally { lock.unlock(); } }`

`CyclicBarrier#reset`方法都是老面孔，先是`CyclicBarrier#breakBarrier`打破上一代CyclicBarrier，既然要重新开始就不要再“怀念”过去了；最后调用`CyclicBarrier#nextGeneration`开始新的时代。需要注意的是，这里加锁的目的是为了保证执行`CyclicBarrier#reset`时，没有任何线程正在执行`CyclicBarrier#await`方法。

好了，到这里CyclicBarrier的核心内容我们就一起分析完了，剩下的方法就非常简单了，相信通过名字大家就可以了解它们的作用，并猜到它们的实现了。

**Tips**：`CyclicBarrier#getNumberWaiting`中加了锁，这是为什么？

### CountDownLatch和Cyclicbarrier有什么区别？ ###

最后的部分，我们来解答下开篇时的面试题，CountDownLatch和Cyclicbarrier有什么区别？

第1点：**CyclicBarrier可以重复使用，CountDownLatch不能重复使用**。

无论是正常使用结束，还是调用`CyclicBarrier#reset`方法，Cyclicbarrier都可以重置内部的计数器

第2点：**Cyclicbarrier只阻塞调用**`CyclicBarrier#await`**方法的线程，而CountDownLatch可以阻塞任意一个或多个线程**。

CountDownLatch将计数减1与阻塞拆分成了`CountDownLatch#countDown`和`CountDownLatch#await`两个方法，而Cyclicbarrier只通过`CyclicBarrier#await`完成两步操作。如果在同一个线程中连续`CountDownLatch#countDown`和`CountDownLatch#await`则实现了与`CyclicBarrier#await`方法相同的功能。

###  ###

[format_png]: https://img-blog.csdnimg.cn/img_convert/b979ad642f5fa0e788970f1a35ffb7a5.webp?x-oss-process=image/format,png
[CountDownLatch]: https://link.juejin.cn/?target=https%3A%2F%2Fmp.weixin.qq.com%2Fs%2FDYoabXep2F2xid5Ghw3GFA
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/d8b27249e8f15eaae9a3319e26a9d96c.webp?x-oss-process=image/format,png