CyclicBarrier

CyclicBarrier是什么

CyclicBarrier又被称为同步屏障，可以让一组线程到达一个屏障时被阻塞，直到最后一个线程到达屏障时，所有被阻塞的线程才被唤醒，继续执行
举个例子：CyclicBarrier类似一扇门，默认情况下关闭状态，堵住了线程执行的道路，直到所有线程都就位，门才打开，让所有线程一起通过

用例

public class CyclicBarrierUsing {

    private static CyclicBarrier cyclicBarrier = new CyclicBarrier(3);

    public static void main(String[] args) {
        for (int i = 0; i < 3; i++) {
            new TestThread().start();
        }
    }

    static class TestThread extends Thread {
        @Override
        public void run() {
            System.out.println(Thread.currentThread().getName() + "达到屏障");
            try {
                cyclicBarrier.await();
                System.out.println(Thread.currentThread().getName() + "离开屏障");
            } catch (InterruptedException e) {
                e.printStackTrace();
            } catch (BrokenBarrierException e) {
                e.printStackTrace();
            }
        }
    }

}

执行结果
输出：

Thread-0达到屏障
Thread-2达到屏障
Thread-1达到屏障
Thread-1离开屏障
Thread-2离开屏障
Thread-0离开屏障

实现原理

CyclicBarrier实现主要基于ReentrantLock、Condition

内部属性

public class CyclicBarrier {
    private static class Generation {
        boolean broken = false;
    }
    /** 当线程到达屏障需要获取锁，即调用CyclicBarrier.await方法 */
    private final ReentrantLock lock = new ReentrantLock();
    /** 线程在该条件等待被唤醒 */
    private final Condition trip = lock.newCondition();
    /** 需要等待几个线程 */
    private final int parties;
    /* 当所有线程就绪后 可执行该任务 */
    private final Runnable barrierCommand;
    /** 当前生命周期 */
    private Generation generation = new Generation();
    /**
     * 仍然需等待的线程数量（即还有多少线程没有到达屏障），线程到达后调用
     * CyclicBarrier.await方法会-1，在每个生命周期内都会减到0为止；
     * 当退出屏障后在新的生命周期内会被重新置为parties值
     */
    private int count;
    ...省略后面代码
}

构造方法

• 默认的构造方法是CyclicBarrier(int parties)，其参数表示屏障拦截的线程数量，每个线程调用await方法告诉CyclicBarrier已经到达屏障位置，线程被阻塞。

public CyclicBarrier(int parties) {
        this(parties, null);
}

• 另外一个构造方法CyclicBarrier(int parties, Runnable barrierAction)，其中barrierAction任务会在所有线程到达屏障后执行。

public CyclicBarrier(int parties, Runnable barrierAction) {
        if (parties <= 0) throw new IllegalArgumentException();
        this.parties = parties;
        this.count = parties;
        this.barrierCommand = barrierAction;
}

await方法

调用CyclicBarrier.await()方法，使调用线程进入阻塞状态

public int await() throws InterruptedException, BrokenBarrierException {
        try {
            return dowait(false, 0L);
        } catch (TimeoutException toe) {
            throw new Error(toe); // cannot happen
        }
}

其内部调用的是doWait()方法，await()还有一个带超时的重载方法，功能类似。doWait()方法代码如下

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();
            //如果线程被中断调用breakBarrier退出屏障并抛出异常，breakBarrier()见后续小节
            //breakBarrier()标明当前生命周期被破坏、唤醒所有被阻塞线程、count重置为parties     
            if (Thread.interrupted()) {
                breakBarrier();
                throw new InterruptedException();
            }
            // 减少需达到屏障线程数
            int index = --count;
            if (index == 0) {  // 如果所有线程到达屏障，唤醒其它线程继续执行
                boolean ranAction = false;
                try {
                    final Runnable command = barrierCommand;
                    // 获取需要执行的Runnable对象，如果不为null则执行run方法
                    if (command != null)
                        command.run();
                    ranAction = true;
                    //开启新的生命周期，count数重置，唤醒阻塞线程
                    nextGeneration();
                    return 0;
                } finally {
                    if (!ranAction)
                        breakBarrier();
                }
            }

            // loop until tripped, broken, interrupted, or timed out
            // 如果还有其它线程没有到达屏障将执行下面循环，直到屏障破碎、线程被中断、或超时
            for (;;) {
                try {
                    // 是否是超时等待，不是超时等待立马调用trip.await()，trip是
                    // Condition，调用await将会是线程阻塞，否则调用带有超时时间的
                    // awaitNanos(nanos)（超时时间大于0的情况下）
                    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();
        }
    }

breakBarrier()

标明当前生命周期被破坏、唤醒所有被阻塞线程、count重置为parties

private void breakBarrier() {
        generation.broken = true;
        count = parties;
        trip.signalAll();
}

nextGeneration()

开启新的生命周期，唤醒所有在Condition条件trip上阻塞的线程，重置count值，重新获取新generation对象

private void nextGeneration() {
        // signal completion of last generation
        trip.signalAll();
        // set up next generation
        count = parties;
        generation = new Generation();
    }