CyclicBarrier简介
public class CyclicBarrierDemo {
public static void main(String[] args) {
//只有10个线程到达才能通过,最后一个到达的线程执行Runnable中的方法
CyclicBarrier cyclicBarrier = new CyclicBarrier(10, new Runnable() {
@Override
public void run() {
System.out.println(Thread.currentThread().getName() + "所有线程完成工作");
}
});
ExecutorService executorService = Executors.newFixedThreadPool(10);
for(int i = 0; i < 10; i++){
executorService.execute(new Work(cyclicBarrier));
}
}
}
class Work implements Runnable{
private final CyclicBarrier cyclicBarrier;
public Work(CyclicBarrier cyclicBarrier) {
this.cyclicBarrier = cyclicBarrier;
}
@Override
public void run() {
try {
System.out.println(Thread.currentThread().getName() + "第一次工作");
cyclicBarrier.await();
System.out.println(Thread.currentThread().getName() + "第二次工作");
cyclicBarrier.await();
} catch (InterruptedException e) {
e.printStackTrace();
} catch (BrokenBarrierException e) {
e.printStackTrace();
}
}
}
-
CyclicBarrier用来Barrier来控制多个线程同时到达某个位置再继续执行,并且Barrier可以多次控制
-
CyclicBarrier初始化时用count值来控制具体几个线程,使用condition队列(具体见AQS源码阅读二)来挂起这些线程
-
当线程执行await()时,会使count值减一,然后阻塞挂起等待其他线程
-
最后一个到达的线程执行Runnable中的方法,唤醒条件队列中的线程,开启新的一代
-
在新的一代开启后,count值被重置为初始值,Barrier可以再次使用了
CyclicBarrier字段和构造方法
- Generation:用来循环使用Barrier,当所有线程到达后,这一代正常结束才会开启下一代
private static class Generation {
//当前代是否被打破
boolean broken = false;
}
//全局锁:在使用condition队列前需要加锁
private final ReentrantLock lock = new ReentrantLock();
//线程挂起时使用的condition队列:当前代所有线程抵达Barrier,这个条件队列内的线程才会被唤醒
private final Condition trip = lock.newCondition();
//通过Barrier需要的线程数量
private final int parties;
//最后一个抵达的线程需要执行的任务
private final Runnable barrierCommand;
//当前Barrier的代
private Generation generation = new Generation();
//初始值为parties,表示还有多少线程未到达
private int count;
//parties:通过Barrier需要的线程数量
//barrierAction:最后一个抵达的线程需要执行的任务
public CyclicBarrier(int parties, Runnable barrierAction) {
//小于等于0没有意义
if (parties <= 0) throw new IllegalArgumentException();
this.parties = parties;
//count的初始值就是parties,每到达一个线程,count减一
this.count = parties;
this.barrierCommand = barrierAction;
}
public CyclicBarrier(int parties) {
this(parties, null);
}
解析await()
-
await():当线程执行await()时,表明此时线程已经抵达Barrier,会使count减一
-
如果此刻count不为0,线程会进入conditio队列挂起
-
如果此刻count为0,线程会唤醒condition队列的线程,开启新的一代
//await()实际调用了dowait()方法
public int await() throws InterruptedException, BrokenBarrierException {
try {
return dowait(false, 0L);
} catch (TimeoutException toe) {
throw new Error(toe); // cannot happen
}
}
//timed:是否超时
//nanos:超时时长
private int dowait(boolean timed, long nanos) throws InterruptedException, BrokenBarrierException,
TimeoutException {
//全局锁
final ReentrantLock lock = this.lock;
//加锁:使用condition之前需要加锁
lock.lock();
try {
//Barrier的代
final Generation g = generation;
//当前代已经被打破,抛出异常
if (g.broken)
throw new BrokenBarrierException();
//当前线程的中断标记位为true
if (Thread.interrupted()) {
//打破当前代:会唤醒condition队列中的线程,具体后面有写
breakBarrier();
throw new InterruptedException();
}
//当前线程中断状态是false,当前代未打破
//尚未到达的线程数减一
int index = --count;
//情况一:当前线程是最后一个完成动作的线程
if (index == 0) { // tripped
//执行barrierCommand时是否正常执行
boolean ranAction = false;
try {
//当前线程需要完成构造函数中指定的任务
final Runnable command = barrierCommand;
//任务不为空,执行任务
if (command != null)
command.run();
//command.run()正常执行
ranAction = true;
//开启新的一代:会唤醒condition队列中的线程,具体后面有写
nextGeneration();
return 0;
} finally {
if (!ranAction)
//如果command.run()抛出异常,去打破当前代
breakBarrier();
}
}
//情况二:当前线程不是最后一个完成动作的线程,阻塞挂起
//自旋,一直到条件满足、当前代被打破、线程中断或者等待超时
for (;;) {
try {
//当前线程没有指定超时
if (!timed)
//当前线程会释放锁进入condition队列挂起,具体看AQS源码阅读(二)
trip.await();
//指定了超时
else if (nanos > 0L)
nanos = trip.awaitNanos(nanos);
} catch (InterruptedException ie) {
//什么时候会抛出InterruptedException异常呢？
//在condition队列挂起的线程收到中断信号时,会抛出中断异常,具体看AQS源码阅读(二)
//g == generation:当前代还是挂起之前的代
//!g.broken:当前代没有被打破
if (g == generation && ! g.broken) {
//去打破当前代
breakBarrier();
throw ie;
} else {
//给当前线程一个中断信号
Thread.currentThread().interrupt();
}
}
//线程被唤醒后的情况?
//情况一:当前代已经被打破,线程被唤醒
//情况二:所有线程都抵达Barrier,最后一个线程开启了新的一代
//情况三:当前线程在条件队列中等待超时,转移到阻塞队列时拿到了锁
//情况一:当前代已经被打破,线程被唤醒
if (g.broken)
//线程唤醒后抛出异常
throw new BrokenBarrierException();
////情况二:所有线程都抵达Barrier,最后一个线程开启了新的一代
if (g != generation)
//返回当前线程的index
return index;
//情况三:当前线程在条件队列中等待超时,转移到阻塞队列又拿到了锁
if (timed && nanos <= 0L) {
//打破Barrier,然后抛出超时异常
breakBarrier();
throw new TimeoutException();
}
}
} finally {
lock.unlock();
}
}
解析nextGeneration()和breakBarrier()
-
什么时候会执行nextGeneration()? 最后一个线程抵达时一切正常,开启了新的一代
-
什么时候会执行breakBarrier()?
-
线程抵达Barrier发现当前线程的中断标记位为true,就会打破当前代
-
线程抵达Barrier进入condition队列挂起,此时收到中断信号,抛出中断异常被catch,如果当前代还是线程挂起时的那一代,并且当前代还未被打破,就会打破当前代
-
线程抵达Barrier进入condition队列挂起,等待超时,转移到阻塞队列又拿到了锁,发现还是在线程挂起时的那一代,就会打破当前代
-
最后一个抵达的线程执行barrierCommand失败出现异常,就会打破当前代
//nextGeneration():唤醒condition队列的线程,重置count为parties,创建新的Generation对象,开启新的一代
private void nextGeneration() {
//将在条件队列内的线程全部唤醒
trip.signalAll();
//重置count为parties
count = parties;
//使用一个新的Generation对象,表示新的一代
generation = new Generation();
}
//breakBarrier():设置当前代的状态为打破状态,重置count为parties,然后唤醒在条件条件队列内的线程
private void breakBarrier() {
//打破当前代,有线程到来时会直接抛出异常
generation.broken = true;
//重置count为parties
count = parties;
//将在条件队列内的线程全部唤醒
trip.signalAll();
}
