JUC源码分析之CyclicBarrier简介关键方法与参数源码解析CountDownLatch和CyclicBarrier的区别与联系应用场景小结

/** 要屏障的线程数 */
private final int parties;
/* 当线程都到达barrier，运行的 barrierCommand*/
private final Runnable barrierCommand;

//-------------------------函数列表------------------------------
//构造函数，指定参与线程数
public CyclicBarrier(int parties)
//构造函数，指定参与线程数，并在所有线程到达barrier之后执行给定的barrierAction逻辑
public CyclicBarrier(int parties, Runnable barrierAction);
//等待所有的参与者到达barrier
public int await();
//等待所有的参与者到达barrier，或等待给定的时间
public int await(long timeout, TimeUnit unit);
//获取参与等待到达barrier的线程数
public int getParties();
//查询barrier是否处于broken状态
public boolean isBroken();
//重置barrier为初始状态
public void reset();
//返回等待barrier的线程数量
public int getNumberWaiting();

private int dowait(boolean timed, long nanos)
            throws InterruptedException, BrokenBarrierException,
            TimeoutException {
        //独占锁
        final ReentrantLock lock = this.lock;
        //获取独占锁
        lock.lock();
        try {
            //保存当前"Generation"
            final Generation g = generation;
            //当前generation“已损坏”，抛BrokenBarrierException
            //抛该异常一般因为某个线程在等待某个处于“断开”状态的CyclicBarrier
            if (g.broken)
                throw new BrokenBarrierException();

            //当前线程中断，通过breakBarrier终止CyclicBarrier
            if (Thread.interrupted()) {
                //线程被中断，终止Barrier，唤醒所有等待线程
                breakBarrier();
                throw new InterruptedException();
            }

            //计数器自减
            int index = --count;
            //如果计数器 == 0
            //表示所有线程都已经到位，触发动作（是否执行某项任务）
            if (index == 0) {  // tripped
                boolean ranAction = false;
                try {
                    //barrierCommand线程要执行的任务
                    final Runnable command = barrierCommand;
                    //执行的任务!=null，执行任务
                    if (command != null)
                        command.run();
                    ranAction = true;
                    //唤醒所有等待线程，并更新generation
                    nextGeneration();
                    return 0;
                } finally {
                    if (!ranAction)
                        breakBarrier();
                }
            }

            //循环一直执行，直到下面三个if一个条件满足才会退出循环
            //自旋等待 所有parties到达 | generation被销毁 | 线程中断 | 超时
            for (;;) {
                try {
                    //如果不是超时等待，则调用await等待
                    if (!timed)
                        trip.await();
                        //调用awaitNanos等待
                    else if (nanos > 0L)
                        nanos = trip.awaitNanos(nanos);
                } catch (InterruptedException ie) {
                    //
                    if (g == generation && ! g.broken) {
                        breakBarrier();
                        throw ie;
                    } else {
                        Thread.currentThread().interrupt();
                    }
                }

                //当前generation“已损坏”，抛出BrokenBarrierException异常
                //抛出该异常一般都是某个线程在等待某个处于“断开”状态的CyclicBarrier
                if (g.broken)
                    throw new BrokenBarrierException();

                //generation已经更新，返回index
                if (g != generation)
                    return index;

                //“超时等待”，并且时间已到，则通过breakBarrier()终止CyclicBarrier
                if (timed && nanos <= 0L) {
                    breakBarrier();
                    throw new TimeoutException();
                }
            }
        } finally {
            //释放独占锁
            lock.unlock();
        }
    }