【并发编程】CyclicBarrier

CyclicBarrier 字面意思回环栅栏，通过它可以实现让一组线程等待至某个状态之后再全部同时执行。叫做回环是因为当所有等待线程都被释放以后，CyclicBarrier 可以被重用。我们暂且把这个状态就叫做barrier，当调用 await 方法之后，线程就处于 barrier 了。

CyclicBarrier 类位于 java.util.concurrent 包下，CyclicBarrier 提供 2 个构造器：

public CyclicBarrier(int parties, Runnable barrierAction) {}

public CyclicBarrier(int parties) {}

参数 parties 指让多少个线程或者任务等待至 barrier 状态；

参数 barrierAction 为当这些线程都达到 barrier 状态时会执行的内容。

然后 CyclicBarrier 中最重要的方法就是 await 方法，它有 2 个重载版本：

public int await() throws InterruptedException, BrokenBarrierException {};

public int await(long timeout, TimeUnit unit) throws InterruptedException, BrokenBarrierException, TimeoutException {};

第一个版本比较常用，用来挂起当前线程，直至所有线程都到达 barrier 状态再同时执行后续任务；

第二个版本是让这些线程等待至一定的时间，如果还有线程没有到达 barrier 状态就直接让到达 barrier 的线程执行后续任务。

假若有若干个线程都要进行写数据操作，并且只有所有线程都完成写数据操作之后，这些线程才能继续做后面的事情，此时就可以利用 CyclicBarrier 了：

public class Test {
    public static void main(String[] args) {
        int N = 4;
        CyclicBarrier barrier = new CyclicBarrier(N);
        for(int i=0; i<N; i++){
            new Writer(barrier).start();
        }
    }
    
    static class Writer extends Thread {
        private CyclicBarrier cyclicBarrier;
        public Writer(CyclicBarrier cyclicBarrier) {
            this.cyclicBarrier = cyclicBarrier;
        }
 
        @Override
        public void run() {
            System.out.println("线程" + Thread.currentThread().getName() + 
                               "正在写入数据...");
            try {
                // 以睡眠来模拟写入数据操作
                Thread.sleep(5000);
                System.out.println("线程" + Thread.currentThread().getName() + 
                                   "写入数据完毕，等待其他线程写入完毕");
                cyclicBarrier.await();
            } catch (InterruptedException e) {
                e.printStackTrace();
            } catch (BrokenBarrierException e) {
                e.printStackTrace();
            }
            System.out.println("所有线程写入完毕，继续处理其他任务...");
        }
    }
}

如果说想在所有线程写入操作完之后，进行额外的其他操作可以为 CyclicBarrier 提供 Runnable 参数：

public class Test {
    public static void main(String[] args) {
        int N = 4;
        CyclicBarrier barrier  = new CyclicBarrier(N, new Runnable() {
            @Override
            public void run() {
                System.out.println("所有线程均写入完成");   
            }
        });
         
        for(int i=0; i<N; i++) {
            new Writer(barrier).start();
        }
    }
    static class Writer extends Thread {
        private CyclicBarrier cyclicBarrier;
        public Writer(CyclicBarrier cyclicBarrier) {
            this.cyclicBarrier = cyclicBarrier;
        }
 
        @Override
        public void run() {
            System.out.println("线程" + Thread.currentThread().getName() + 
                               "正在写入数据...");
            try {
                // 以睡眠来模拟写入数据操作
                Thread.sleep(5000);   
                System.out.println("线程" + Thread.currentThread().getName() + 
                                   "写入数据完毕，等待其他线程写入完毕");
                cyclicBarrier.await();
            } catch (InterruptedException e) {
                e.printStackTrace();
            } catch (BrokenBarrierException e) {
                e.printStackTrace();
            }
            System.out.println("所有线程写入完毕，继续处理其他任务...");
        }
    }
}

当四个线程都到达 barrier 状态后，会从四个线程中选择最后一个进入 barrier 状态的线程去执行 Runnable。

CyclicBarrier 实际用途：

假设我们要导入一批数据，因为数据量较大有4亿条，所以我们希望启动四个线程，每个线程负责导入1亿条数据，我们希望所有的数据导入完成之后，还在数据库中插入一条记录，表示任务执行完成，此时就可以使用 CyclicBarrier。