# CyclicBarrier的使用
标签（空格分隔）： Java多线程
---
## 简介
CyclicBarrier的字面意思是可循环使用(Cyclic)的屏障(Barrier)。CyclicBarrier的作用是让一组线程之间相互等待，任何一个线程到达屏障点后就阻塞，直到最后一个线程到达，才都继续往下执行。个人理解：CyclicBarrier可以看成是一道大门或者关卡，先到的线程会被阻塞在大门口，直到最后一个线程到达屏障时，大门才被打开，所有被阻塞的线程才会继续干活。就像是朋友聚餐，只有最后一个朋友到达时，才会开吃！
## 屏障(Barrier)
```CyclicBarrier``` 的构造函数可以传入一个整数，其含义是屏障可拦截的线程数，每个线程都可调用await方法告诉CyclicBarrier“我已经到达了屏障前”，CyclicBarrier内部是执行+1操作，一旦屏障前阻塞的线程数等于构造函数传入的可拦截线程数时，所有被阻塞的线程都将被唤醒，继续往下执行。
### 常用API
``` java
//parties表示屏障前可阻塞的线程数，当阻塞的线程数到达parties时，屏障被打开，所有阻塞的线程将会被唤醒
public CyclicBarrier(int parties);
// 此构造方法不同于上面的是在屏障被打开时将优先执行barrierAction，方便处理更负责的业务场景
public CyclicBarrier(int parties, Runnable barrierAction) ;
// 等待屏障的打开
public int await() throws InterruptedException,BrokenBarrierException ;
//等待屏障的打开 超时会抛出 TimeoutException
public int await(long timeout, TimeUnit unit) throws
InterruptedException,
BrokenBarrierException,
TimeoutException ;
// 返回在屏障前等待的线程数
public int getNumberWaiting() ;
// 获取 当前屏障初始化时 可阻塞的线程数
public int getParties() ；
/**
* 作用:
* 1. 查询此屏障是否处于损坏状态。
* 产生损坏状态的原因:
* 1. 由于超时或者屏障重置(reset)
* 2. 某个屏障操作抛出异常
*/
public boolean isBroken() ;
```
### 使用举例
**模拟 聚餐场景**
``` java
public class CyclicBarrierTest {
public static void main(String[] args) throws Exception{
ExecutorService service = Executors.newFixedThreadPool(3) ;
CyclicBarrier cyclicBarrier = new CyclicBarrier(3,()->{
System.out.println("全都到了 【开吃!】");
}) ;
for(int i = 0 ; i < 3 ; i++) {
final int number = i ;
service.execute(()->{
try {
System.out.println("编号:" + number + "开始出发 【去聚餐】");
Thread.sleep((int)(Math.random() * 10000));
System.out.println("编号:" + number + " 【到达聚餐地点】");
cyclicBarrier.await();
} catch (Exception e) {
e.printStackTrace();
}
});
}
service.shutdown();
}
}
```
## 循环使用
循环使用指的是在大门被打开后，可以再次关闭；即再让之前指定数目的线程在屏障前阻塞等待，然后再次打开大门。
方法reset()的作用就是重置屏障，以保证循环使用。
### 常用API
``` java
// 将屏障重置为其初始化状态即重置为构造函数传入的parties值。
public void reset()
```
### 使用举例
``` java
import java.util.concurrent.CyclicBarrier;
import java.util.concurrent.Executors;
import java.util.concurrent.ThreadPoolExecutor;
/**
* Created by 58 on 2017-7-14.
*/
public class CyclicBarrierTest {
public static void main(String[] args) throws Exception{
ThreadPoolExecutor service = (ThreadPoolExecutor)Executors.newFixedThreadPool(3) ;
CyclicBarrier cyclicBarrier = new CyclicBarrier(3,()->{
System.out.println("全都到了 【开吃!】");
}) ;
for(int i = 0 ; i < 3 ; i++) {
final int number = i ;
service.execute(()->{
try {
System.out.println("编号:" + number + "开始出发 【去聚餐】");
Thread.sleep((number+2) * 1000);
System.out.println("编号:" + number + " 【到达聚餐地点】");
cyclicBarrier.await();
} catch (Exception e) {
e.printStackTrace();
}
});
}
Thread.sleep( 3 * 1000);
System.out.println(cyclicBarrier.getNumberWaiting());
cyclicBarrier.reset();
System.out.println(cyclicBarrier.getNumberWaiting());
}
}
```
**运行截图**
### 说明
**关于reset方法的说明** :
>
/**
* Resets the barrier to its initial state. If any parties are
* currently waiting at the barrier, they will return with a
* {@link BrokenBarrierException}. Note that resets <em>after</em>
* a breakage has occurred for other reasons can be complicated to
* carry out; threads need to re-synchronize in some other way,
* and choose one to perform the reset. It may be preferable to
* instead create a new barrier for subsequent use.
*/
>
上面是JDK中```reset```方法的注释，简单翻译成中文如下：
> 将屏障重置为其初始状态。此时，如果有任何的一个参与者正在屏障前等待，它将会返回一个 BrokenBarrierException异常。注意：如果因为其他原因使屏障发生损坏，此时屏障的重置将会变得很复杂；为了将来的使用，相比需要考虑使用其他方式重新同步线程，并选择其中一个线程来执行重置，更好的解决办法是创建一个新的屏障。
>
从上面的翻译，我们可以得出结论：
+ reset方法的作用是：将屏障重置为其初始状态。
+ 如果在将屏障重置时，有任何一个参与者正在屏障前等待，它将抛出一个```BrokenBarrierException``异常。
+ 如果屏障因为其他发送了损坏，最好的解决办法是创建一个新的屏障。
**关于```BrokenBarrierException```异常的说明**:
> /**
* Exception thrown when a thread tries to wait upon a barrier that is
* in a broken state, or which enters the broken state while the thread
* is waiting.
*/
>
上面是JDK中```BrokenBarrierException```方法的注释，简单翻译成中文如下：
> 当某个线程试图在一个已经处于损坏状态的屏障前等待或者在线程等待时屏障进入了损坏状态 将会抛出此异常。
>
### 与CountDownLatch的比较
#### 一对多与多对多
CountDownLatch一般用于某个线程A等待若干其他线程执行完任务之后，它才执行。而CyclicBarrier一般用于多个线程之间相互等待，比如需要在一个同时执行时间点上达成一致，然后同时开启一项工作；重点是“多个线程之间” 任何一个线程没有完成任务，则其他所有的线程都必须等待。
#### 循环使用
CyclicBarrier的*reset*方法可以重置屏障。
### CyclicBarrier的应用场景
CyclicBarrier可以用于多线程计算数据，最后合并计算结果的应用场景。比如我们用一个Excel保存了用户所有银行流水，每个sheet保存一个账户近一年的每笔银行流水，现在需要统计用户的日均银行流水，先用多线程处理每个sheet里的银行流水，都执行完之后，得到每个sheet的日均银行流水，最后，再用barrierAction来汇总这些线程的计算结果，计算出整个Excel的日均银行流水。
### barrierAction的执行时机
下面的注释片段是JDK源码中，关于CyclicBarrier的介绍。
>*A {@code CyclicBarrier} supports an optional {@link Runnable} command
* that is run once per barrier point, after the last thread in the party
* arrives, but before any threads are released.
* This <em>barrier action</em> is useful
* for updating shared-state before any of the parties continue.
*
>
**after the last thread in the party arrives , but before any threads are released** 这句明确说明barrierAction的执行时机：在最后一个线程到达后，但是在所有线程被释放运行前。
### 线程回收问题
