CyclicBarrier是一个同步辅助类,允许一组线程相互等待,直到到达一个共同的barrier point。如果一组线程需要不定时地相互等待,这个时候就可以用到CyclicBarrier。CyclicBarrier之所以带“Cyclic”前缀,是因为当所有相互等待的线程释放后,Barrier可以被重复利用。
CyclicBarrier的构造函数为:
public CyclicBarrier(int parties, Runnable barrierAction) {
if (parties <= 0) throw new IllegalArgumentException();
this.parties = parties;
this.count = parties;
this.barrierCommand = barrierAction;
}
很明显,parties 参数指的是该CyclicBarrier将是多少个线程相互等待。 CyclicBarrier允许在构造函数中传入barrierAction参数,barrierAction指的是当Barrier被触发,即所有相互等待的线程都到barrier point时所执行的动作。该动作是由最后一个到达barrier point线程触发的。
CyclicBarrier最重要的方法就是await(),其使各个线程相互等待就是通过各个线程调用该方法来实现的。下面就分析下该方法的代码:
public int await() throws InterruptedException, BrokenBarrierException {
try {
return dowait(false, 0L);
} catch (TimeoutException toe) {
throw new Error(toe); // cannot happen;
}
}
/**
* Main barrier code, covering the various policies.
*/
private int dowait(boolean timed, long nanos)
throws InterruptedException, BrokenBarrierException,
TimeoutException {
final ReentrantLock lock = this.lock;
lock.lock();
try {
final Generation g = generation;
if (g.broken)
throw new BrokenBarrierException();
if (Thread.interrupted()) {
breakBarrier();
throw new InterruptedException();
}
int index = --count;// ①
if (index == 0) { // tripped
boolean ranAction = false;
try {
final Runnable command = barrierCommand; // ③
if (command != null)
command.run();
ranAction = true;
nextGeneration();
return 0;
} finally {
if (!ranAction)
breakBarrier();
}
}
// loop until tripped, broken, interrupted, or timed out
for (;;) { // ②
try {
if (!timed)
trip.await();
else if (nanos > 0L)
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();
if (g != generation)
return index;
if (timed && nanos <= 0L) {
breakBarrier();
throw new TimeoutException();
}
}
} finally {
lock.unlock();
}
}
await()方法的里面调用了dowait()方法,dowait()才是真正的逻辑所在。
在代码①处,对count做减一操作,从构造函数可知,count的值就代表着相互依赖的线程数。如果index不等于0,则表明不是所有的线程都达到了barrier point,则程序执行②处得代码,如果timed为true,则不是blocking的等待,而是等待一段时间后返回。因为此处timed是false,所以执行trip.await()。trip是一个Condition对象,其维护了一个队列,该队列代表着一个等待集,trip.await()操作就是把当前线程放入trip的等待集中,等待被唤醒。
如果index=0,则表明当前线程是最后一个到达barrier point的线程,则执行③处得代码,首先看是否定义了barrierCommand,barrierCommand就是上面说到的barrierAction的封装,如果barrierCommand不为null,则执行barrierCommand.run(),这就是上面为什么说barrierAction是由最后一个到达barrier point的线程所触发的原因。
执行完barrierAction后,则开始唤醒其它在trip等待集里面的线程,nextGeneration方法就是完成这一操作。
private void nextGeneration() {
// signal completion of last generation
trip.signalAll();
// set up next generation
count = parties;
generation = new Generation();
}
trip.signalAll()是唤醒所以等待的线程。然后重置count和generation,这也说明了为什么,所以线程到达barrier point后,CyclicBarrier可以被重新使用。
经过上面的分析,CyclicBarrier的实现其实很简单,并没有太多的内幕。