CyclicBarrier一個同步輔助類,它允許一組線程互相等待,直到到達(dá)某個公共屏障點(diǎn) (common barrier point)。假如在涉及一組固定大小的線程的程序應(yīng)用中,要求這些線程必須不時地互相等待(保證所有線程都執(zhí)行完畢才返回),那么選擇 CyclicBarrier 就會讓這個實(shí)現(xiàn)變得非常容易。CyclicBarrier 在釋放等待線程后可以重用,所以又稱它為循環(huán) 的 barrier。
CyclicBarrier 支持一個可選的 Runnable 命令,在一組線程中的最后一個線程到達(dá)之后(但在釋放所有線程之前),該命令在每個屏障點(diǎn)完成前只運(yùn)行一次。
下面是一個JDK官方自帶示例(只演示使用方式,目前不能直接運(yùn)行),可以讓大家更好的了解一下CyclicBarrier的使用。
示例說明:有一個兩維數(shù)組,保存的N行的數(shù)據(jù)內(nèi)容。現(xiàn)在需要有N個線程,每個線程處理一行結(jié)果,當(dāng)所有N的結(jié)果都處理完成后,返回。示例代碼如下:
public class Solver {
final int N;
final float[][] data;
final CyclicBarrier barrier;
class Worker implements Runnable {
int myRow;
Worker(int row) {
myRow = row;
}
public void run() {
while (!done()) {
processRow(myRow);
try {
barrier.await();
} catch (InterruptedException ex) {
return;
} catch (BrokenBarrierException ex) {
return;
}
}
}
}
public Solver(float[][] matrix) {
data = matrix;
N = matrix.length;
//創(chuàng)建N個大小的Barrier,調(diào)用 barrier.await方法來等待線程結(jié)束
barrier = new CyclicBarrier(N,
new Runnable() {
public void run() {
mergeRows(...);
}
});
for (int i = 0; i < N; ++i)
new Thread(new Worker(i)).start();
waitUntilDone();
}
}
在這個例子中,每個 worker 線程處理一行數(shù)據(jù),在處理完所有的行之前,該線程將一直在屏障處等待。
處理完所有的行之后,將執(zhí)行所提供的 Runnable 屏障操作,并合并這些行。
如果合并者確定已經(jīng)找到了一個解決方案,那么 done() 將返回 true,所有的 worker 線程都將終止。
如果屏障操作在執(zhí)行時不依賴于正掛起的線程,則線程組中的任何線程在獲得釋放時都能執(zhí)行該操作。
為方便此操作,每次調(diào)用 await() 都將返回能到達(dá)屏障處的線程的索引。然后,您可以選擇哪個線程應(yīng)該執(zhí)行屏障操作,例如:
if (barrier.await() == 0) {
// log the completion of this iteration
}對于失敗的同步嘗試,CyclicBarrier 使用了一種要么全部要么全不 (all-or-none) 的破壞模式:如果因?yàn)橹袛唷⑹』蛘叱瑫r等原因,導(dǎo)致線程過早地離開了屏障點(diǎn),那么在該屏障點(diǎn)等待的其他所有線程也將通過 BrokenBarrierException(如果它們幾乎同時被中斷,則用 InterruptedException)以反常的方式離開。
內(nèi)存一致性效果:線程中調(diào)用 await() 之前的操作 happen-before 那些是屏障操作的一部份的操作,后者依次 happen-before 緊跟在從另一個線程中對應(yīng) await() 成功返回的操作。
主要API介紹
await
public int await() throws InterruptedException, BrokenBarrierException
將一直等待。
如果當(dāng)前線程不是將到達(dá)的最后一個線程,出于調(diào)度目的,將禁用它,且在發(fā)生以下情況之一前,該線程將一直處于休眠狀態(tài):
最后一個線程到達(dá);
或者 其他某個線程中斷當(dāng)前線程;
或者 其他某個線程中斷另一個等待線程;
或者 其他某個線程在等待 barrier 時超時;
或者 其他某個線程在此 barrier 上調(diào)用 reset()。
如果當(dāng)前線程:
在進(jìn)入此方法時已經(jīng)設(shè)置了該線程的中斷狀態(tài);或者
在等待時被中斷
則拋出 InterruptedException,并且清除當(dāng)前線程的已中斷狀態(tài)。
如果在線程處于等待狀態(tài)時 barrier 被 reset(),或者在調(diào)用 await 時 barrier 被損壞,抑或任意一個線程正處于等待狀態(tài),則拋出 BrokenBarrierException 異常。
如果任何線程在等待時被 中斷,則其他所有等待線程都將拋出 BrokenBarrierException 異常,并將 barrier 置于損壞狀態(tài)。
如果當(dāng)前線程是最后一個將要到達(dá)的線程,并且構(gòu)造方法中提供了一個非空的屏障操作,則在允許其他線程繼續(xù)運(yùn)行之前,當(dāng)前線程將運(yùn)行該操作。
如果在執(zhí)行屏障操作過程中發(fā)生異常,則該異常將傳播到當(dāng)前線程中,并將 barrier 置于損壞狀態(tài)。
返回:
到達(dá)的當(dāng)前線程的索引,其中,索引 getParties() - 1 指示將到達(dá)的第一個線程,零指示最后一個到達(dá)的線程
拋出:
InterruptedException - 如果當(dāng)前線程在等待時被中斷
BrokenBarrierException - 如果另一個 線程在當(dāng)前線程等待時被中斷或超時,或者重置了 barrier,或者在調(diào)用 await 時 barrier 被損壞,抑或由于異常而導(dǎo)致屏障操作(如果存在)失敗。
getNumberWaiting
public int getNumberWaiting()
返回當(dāng)前在屏障處等待的參與者數(shù)目。此方法主要用于調(diào)試和斷言。
返回 當(dāng)前阻塞在 await() 中的參與者數(shù)目。
完整示例
示例說明:假如一個飛機(jī)乘客的登機(jī)過程,要求乘客的身份證驗(yàn)證通過,乘客的登機(jī)牌已經(jīng)更換以及乘客的行禮已經(jīng)確認(rèn)后才可以登錄。
完整代碼如下:
public static void main(String[] args) {
final int TOTAL_STEPS = 3;//步驟個數(shù)
final String[] steps = new String[] {"換登機(jī)牌確認(rèn)", "身份證確認(rèn)", "行禮確認(rèn)"};
final CyclicBarrier cb = new CyclicBarrier(TOTAL_STEPS);
ExecutorService es = Executors.newFixedThreadPool(TOTAL_STEPS); // 在線程池中放入三個線程
for (int i = 0; i < TOTAL_STEPS; i++) { // 開啟三個任務(wù)
final String name = steps[i];
es.execute(new Runnable() {
public void run() {
for (int i = 0; i < 5; i++) {
try {
String passenger = "乘客"+i;
int wait = new Random().nextInt(5000);
Thread.sleep(wait);
System.out.print(passenger + " " + name + "【確認(rèn)通過 】+ 耗時:" + wait);
// 如果有2個線程已經(jīng)在等待,那么最后一個線程到達(dá)后就可以一起開始后面操作
if (cb.getNumberWaiting() + 1 == 3) {
System.out.println(", 全部通過,確認(rèn)下一個乘客");
} else {
System.out.println(", 還有"
+ (TOTAL_STEPS - cb.getNumberWaiting() - 1) + "個任務(wù)等待");
}
cb.await();
} catch (Exception e) {
e.printStackTrace();
}
}
}
});
}
es.shutdown();
}
}
執(zhí)行結(jié)果如下:
乘客0 行禮確認(rèn)【確認(rèn)通過 】+ 耗時:1616, 還有2個任務(wù)等待
乘客0 身份證確認(rèn)【確認(rèn)通過 】+ 耗時:1792, 還有1個任務(wù)等待
乘客0 換登機(jī)牌確認(rèn)【確認(rèn)通過 】+ 耗時:3891, 全部通過,確認(rèn)下一個乘客
乘客1 身份證確認(rèn)【確認(rèn)通過 】+ 耗時:282, 還有2個任務(wù)等待
乘客1 換登機(jī)牌確認(rèn)【確認(rèn)通過 】+ 耗時:4354, 還有1個任務(wù)等待
乘客1 行禮確認(rèn)【確認(rèn)通過 】+ 耗時:4996, 全部通過,確認(rèn)下一個乘客
乘客2 身份證確認(rèn)【確認(rèn)通過 】+ 耗時:2977, 還有2個任務(wù)等待
乘客2 行禮確認(rèn)【確認(rèn)通過 】+ 耗時:3848, 還有1個任務(wù)等待
乘客2 換登機(jī)牌確認(rèn)【確認(rèn)通過 】+ 耗時:4069, 全部通過,確認(rèn)下一個乘客
乘客3 換登機(jī)牌確認(rèn)【確認(rèn)通過 】+ 耗時:905, 還有2個任務(wù)等待
乘客3 身份證確認(rèn)【確認(rèn)通過 】+ 耗時:1916, 還有1個任務(wù)等待
乘客3 行禮確認(rèn)【確認(rèn)通過 】+ 耗時:4710, 全部通過,確認(rèn)下一個乘客
乘客4 身份證確認(rèn)【確認(rèn)通過 】+ 耗時:1371, 還有2個任務(wù)等待
乘客4 行禮確認(rèn)【確認(rèn)通過 】+ 耗時:1768, 還有1個任務(wù)等待
乘客4 換登機(jī)牌確認(rèn)【確認(rèn)通過 】+ 耗時:2498, 全部通過,確認(rèn)下一個乘客
Good Luck!
Yours Matthew!