1. 簡介
CyclicBarrier，一個同步輔助類，在API中是這麼介紹的：它允許一組線程互相等待，直到到達某個公共屏障點 (common barrier point)。在涉及一組固定大小的線程的程序中，這些線程必須不時地互相等待，此時 CyclicBarrier很有用。因爲該barrier在釋放等待線程後可以重用，所以稱它爲循環的 barrier。
通俗點講就是：讓一組線程到達一個屏障時被阻塞，直到最後一個線程到達屏障時，屏障纔會開門，所有被屏障攔截的線程纔會繼續幹活。
2. 實現分析
2.1 構造方法
通過上圖我們可以看到CyclicBarrier的內部是使用重入鎖ReentrantLock和Condition。它有兩個構造函數：
public CyclicBarrier(int parties) {
this(parties, null);
}
CyclicBarrier(int parties)創建一個新的 CyclicBarrier，它將使定數量的參與者（線程）處於等待狀態時啓動，但它不會在啓動 barrier 時執行預定義的操作。
public CyclicBarrier(int parties, Runnable barrierAction) {
if (parties <= 0) throw new IllegalArgumentException();
this.parties = parties;
this.count = parties;
this.barrierCommand = barrierAction;
}
創建一個新的 CyclicBarrier，它將使給定數量的參與者（線程）處於等待狀態時啓動，並在啓動 barrier 時執行給定的屏障操作，該操作由最後一個進入barrier 的線程執行。
parties表示攔截線程的數量，barrierAction 爲CyclicBarrier接收的Runnable命令，用於在線程到達屏障時，優先執行barrierAction ，用於處理更加複雜的業務場景。
當 count 計數器值變爲0後，會將 parties 的值賦給 count，從而進行復用。
2.2 await()
在CyclicBarrier中最重要的方法莫過於await()方法，在所有參與者都已經在此 barrier 上調用 await 方法之前，將一直等待。如下：
public int await() throws InterruptedException, BrokenBarrierException {
try {
return dowait(false, 0L);//不超時等待
} catch (TimeoutException toe) {
throw new Error(toe); // cannot happen
}
}
await()方法內部調用dowait(boolean timed, long nanos)方法：
private int dowait(boolean timed, long nanos) throws InterruptedException, BrokenBarrierException, TimeoutException {
//獲取鎖
final ReentrantLock lock = this.lock;
lock.lock();
try {
//分代
final Generation g = generation;
//當前generation“已損壞”，拋出BrokenBarrierException異常
//拋出該異常一般都是某個線程在等待某個處於“斷開”狀態的CyclicBarrie、
if (g.broken)
// 當某個線程試圖等待處於斷開狀態的 barrier 時，或者 barrier 進入斷開狀態而線程處於等待狀
// 態時，拋出該異常
throw new BrokenBarrierException();
//如果線程中斷，終止CyclicBarrier
if (Thread.interrupted()) {
breakBarrier();
throw new InterruptedException();
}
//進來一個線程 count - 1
int index = --count;
//count == 0 表示所有線程均已到位，觸發Runnable任務
if (index == 0) { // tripped
boolean ranAction = false;
try {
final Runnable command = barrierCommand;
//觸發任務
if (command != null)
command.run();
ranAction = true;
//喚醒所有等待線程，並更新generation
nextGeneration();
return 0;
} finally {
if (!ranAction)
breakBarrier();
}
}
for (;;) {
try {
//如果不是超時等待，則調用Condition.await()方法等待
if (!timed)
trip.await();
else if (nanos > 0L)
//超時等待，調用Condition.awaitNanos()方法等待
nanos = trip.awaitNanos(nanos);
} catch (InterruptedException ie) {
if (g == generation && ! g.broken) {
breakBarrier();
throw ie;
} else {
// We're about to finish waiting even if we had not
// been interrupted, so this interrupt is deemed to
// "belong" to subsequent execution.
Thread.currentThread().interrupt();
}
}
if (g.broken)
throw new BrokenBarrierException();
//generation已經更新，返回index
if (g != generation)
return index;
//“超時等待”，並且時間已到,終止CyclicBarrier，並拋出異常
if (timed && nanos <= 0L) {
breakBarrier();
throw new TimeoutException();
}
}
} finally {
//釋放鎖
lock.unlock();
}
}
await()的處理邏輯還是比較簡單的：如果該線程不是到達的最後一個線程，則他會一直處於等待狀態，除非發生以下情況：
- 最後一個線程到達，即
index == 0 - 超出了指定時間（超時等待）
- 其他的某個線程中斷當前線程
- 其他的某個線程中斷另一個等待的線程
- 其他的某個線程在等待
barrier超時 - 其他的某個線程在此
barrier調用reset()方法。reset()方法用於將屏障重置爲初始狀態。
我們需要注意Generation 對象，在上述代碼中我們總是可以看到拋出BrokenBarrierException異常，那麼什麼時候拋出異常呢？
如果一個線程處於等待狀態時，此時其他線程調用reset()，或者調用的barrier原本就是被損壞的，則拋出BrokenBarrierException異常。同時，任何線程在等待時被中斷了，則其他所有線程都將拋出BrokenBarrierException異常，並將barrier置於損壞狀態。
Generation描述着CyclicBarrier的更新換代。在CyclicBarrier中，同一批線程屬於同一代。當有parties個線程到達barrier，generation就會被更新換代。其中broken標識該當前CyclicBarrier是否已經處於中斷狀態。
private static class Generation {
boolean broken = false;
}
默認barrier是沒有損壞的。當barrier損壞了或者有一個線程中斷了，則通過breakBarrier()來終止所有的線程：
private void breakBarrier() {
generation.broken = true;
count = parties;
trip.signalAll();
}
在breakBarrier()中除了將broken設置爲true，還會調用signalAll將在CyclicBarrier處於等待狀態的線程全部喚醒。
當所有線程都已經到達barrier處（index == 0），則會通過nextGeneration()進行更新換地操作，在這個步驟中，做了三件事：喚醒所有線程，重置count，generation。
private void nextGeneration() {
trip.signalAll();
count = parties;
generation = new Generation();
}
3. 應用場景
CyclicBarrier可用於多線程結果合併的操作，用於多線程計算數據，最後合併計算結果的應用場景。比如我們需要統計多個Excel中的數據，然後等到一個總結果。我們可以通過多線程處理每一個Excel，執行完成後得到相應的結果，最後通過barrierAction來計算這些線程的計算結果，得到所有Excel的總和。
4. 應用示例
比如我們開會只有等所有的人到齊了纔會開會，如下：
import java.util.concurrent.CyclicBarrier;
/**
* @author wangzhao
* @date 2020/6/3 22:42
*/
public class CyclicBarrierTest {
private static CyclicBarrier cyclicBarrier;
static class CyclicBarrierThread extends Thread{
public void run() {
System.out.println(Thread.currentThread().getName() + "到了");
//等待
try {
cyclicBarrier.await();
} catch (Exception e) {
e.printStackTrace();
}
}
}
public static void main(String[] args){
cyclicBarrier = new CyclicBarrier(5, new Runnable() {
@Override
public void run() {
System.out.println("人到齊了，開會吧....");
}
});
for(int i = 0 ; i < 5 ; i++){
new CyclicBarrierThread().start();
}
}
}
