知識星球此篇部落格所有原始碼均來自JDK 1.8
CyclicBarrier，一個同步輔助類，在API中是這麼介紹的：
它允許一組執行緒互相等待，直到到達某個公共屏障點 (common barrier point)。在涉及一組固定大小的執行緒的程式中，這些執行緒必須不時地互相等待，此時 CyclicBarrier 很有用。因為該 barrier 在釋放等待執行緒後可以重用，所以稱它為迴圈 的 barrier。
通俗點講就是：讓一組執行緒到達一個屏障時被阻塞，直到最後一個執行緒到達屏障時，屏障才會開門，所有被屏障攔截的執行緒才會繼續幹活。
友情提示：歡迎關註公眾號【芋道原始碼】。?關註後，拉你進【原始碼圈】微信群討論技術和原始碼。
友情提示：歡迎關註公眾號【芋道原始碼】。?關註後，拉你進【原始碼圈】微信群討論技術和原始碼。
友情提示：歡迎關註公眾號【芋道原始碼】。?關註後，拉你進【原始碼圈】微信群討論技術和原始碼。
實現分析
CyclicBarrier的結構如下：
透過上圖我們可以看到CyclicBarrier的內部是使用重入鎖ReentrantLock和Condition。它有兩個建構式：
-
CyclicBarrier(int parties)：建立一個新的 CyclicBarrier，它將在給定數量的參與者（執行緒）處於等待狀態時啟動，但它不會在啟動 barrier 時執行預定義的操作。
-
CyclicBarrier(int parties, Runnable barrierAction) ：建立一個新的 CyclicBarrier，它將在給定數量的參與者（執行緒）處於等待狀態時啟動，併在啟動 barrier 時執行給定的屏障操作，該操作由最後一個進入 barrier 的執行緒執行。
parties表示攔截執行緒的數量。
barrierAction 為CyclicBarrier接收的Runnable命令，用於在執行緒到達屏障時，優先執行barrierAction ，用於處理更加複雜的業務場景。
public CyclicBarrier(int parties, Runnable barrierAction) {
if (parties <= 0) throw new IllegalArgumentException();
this.parties = parties;
this.count = parties;
this.barrierCommand = barrierAction;
}
public CyclicBarrier(int parties) {
this(parties, null);
}
在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();
}
CyclicBarrier同時也提供了await(long timeout, TimeUnit unit) 方法來做超時控制，內部還是透過呼叫doawait()實現的。
應用場景
CyclicBarrier試用與多執行緒結果合併的操作，用於多執行緒計算資料，最後合併計算結果的應用場景。比如我們需要統計多個Excel中的資料，然後等到一個總結果。我們可以透過多執行緒處理每一個Excel，執行完成後得到相應的結果，最後透過barrierAction來計算這些執行緒的計算結果，得到所有Excel的總和。
應用示例
比如我們開會只有等所有的人到齊了才會開會，如下：
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();
}
}
}
執行結果：
