CyclicBarrier从字面意思上来看,循环栅栏,这篇文章就来分析下是到底是如何实现循环和栅栏的。
属性
private final ReentrantLock lock = new ReentrantLock();
/** Condition to wait on until tripped */
private final Condition trip = lock.newCondition();
/** The number of parties */
private final int parties;
/* The command to run when tripped */
private final Runnable barrierCommand;
/** The current generation */
private Generation generation = new Generation();
private int count;
private static class Generation {
boolean broken = false;
}
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有两个构造器,一个接收资源总数,一个接收资源总数和回调线程。回调线程在哪使用,后面再看。
因为CyclicBarrier是可以重复使用的,那么就需要有一个变量标识所有的线程是属于同一个过程的。CyclicBarrier定义了Generation,代际,其中只有一个变量broken,表示当前代际是否被破坏,默认为false。
await
CyclicBarrier最重要的方法就是await。
public int await() throws InterruptedException, BrokenBarrierException {
try {
return dowait(false, 0L);
} catch (TimeoutException toe) {
throw new Error(toe); // cannot happen
}
}
private int dowait(boolean timed, long nanos)
throws InterruptedException, BrokenBarrierException,
TimeoutException {
final ReentrantLock lock = this.lock;
lock.lock();//1、获取锁
try {
final Generation g = generation;
//2、是否已更新换代
if (g.broken)
throw new BrokenBarrierException();
//3、是否被中断
if (Thread.interrupted()) {
//4、跳出栅栏
breakBarrier();
throw new InterruptedException();
}
//5、当前线程到达栅栏,计数减1
int index = --count;
//6、所有线程都到达了栅栏
if (index == 0) { // tripped
boolean ranAction = false;
try {
//7、获取回调线程
final Runnable command = barrierCommand;
if (command != null)
//8、如果生成时传入了回调线程,启动回调线程
command.run();
ranAction = true;
//9、重置,开始下一代
nextGeneration();
return 0;
} finally {
//10、如果ranAction为false,说明回调线程执行出错了
if (!ranAction)
//11、跳出栅栏
breakBarrier();
}
}
// loop until tripped, broken, interrupted, or timed out
for (;;) {
try {
if (!timed)
//12、如果不需要超时等待,则立即调用Condition的await
trip.await();
else if (nanos > 0L)
//13、如果需要超时等待
nanos = trip.awaitNanos(nanos);
} catch (InterruptedException ie) {//14、如果等待时被中断了
//15、如果等待前和现在处于同一代,并且没有被跳出过
if (g == generation && ! g.broken) {
//16、跳出栅栏
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.
//17、不属于本代的线程,补中断
Thread.currentThread().interrupt();
}
}
//18、被其他线程唤醒,此时本代已经被破坏
if (g.broken)
throw new BrokenBarrierException();
//19、不属于本代,又不是因为别的线程中断
if (g != generation)
return index;
//20、如果等待超时,跳出栅栏
if (timed && nanos <= 0L) {
breakBarrier();
throw new TimeoutException();
}
}
} finally {
lock.unlock();
}
}
private void breakBarrier() {
//1、更新换代
generation.broken = true;
//2、重置计数
count = parties;
//3、唤醒所有在等待通过栅栏的线程
trip.signalAll();
}
private void nextGeneration() {
// signal completion of last generation
//1、唤醒所有在等待通过栅栏的线程
trip.signalAll();
// set up next generation
//2、重置计数
count = parties;
//3、重新生成代际,此时broken为false
generation = new Generation();
}
当线程调用了await时,认为该线程已经到达了栅栏,计数减1,并进入阻塞等待。当最后一个线程到达栅栏时,如果生成时传入了回调线程,此时执行,然后唤醒所有等待的线程,并更新换代。这是正常的流程。
线程在等待时会被四种情况唤醒:
- 正常流程,最后一个线程达到栅栏后发起的唤醒
- 本线程在等待时被中断了
- 别的线程发生了中断,触发代际破坏,唤醒了等待中的线程
- 本线程等待超时了
如果代际被破坏了,会抛出BrokenBarrierException。
reset
public void reset() {
final ReentrantLock lock = this.lock;
lock.lock();
try {
breakBarrier(); // break the current generation
nextGeneration(); // start a new generation
} finally {
lock.unlock();
}
}
线程也可以调用reset来重置代际,但是这也会导致已经在等待的线程抛出BrokenBarrierException。
对比CountDownLatch
CountDownLatch只能使用一次,而CyclicBarrier支持循环更新代际,多次调用和重置,同时它还提供了所有线程到达栅栏时执行回调的功能。CountDownLatch底层是共享获取,CyclicBarrier是独占获取(通过调用ReentrantLock)。