这篇文章我们介绍下JDK并发包下的CyclicBarrier，中文名翻译过来大概叫“循环栅栏”，它是一个多线程场景下带有一定控制逻辑的工具类。

CyclicBarrier功能特点

1. 是一种同步手段
2. 允许固定数量的线程在某个点互相等待，最后实现一定的逻辑
3. 可重复使用

CyclicBarrier例子

假设有一个学校，校内共有5个班级，校长想知道学校内有多少男生多少女生，于是通知各班班主任分别去班级统计，然后到校长这里汇总，使用CyclicBarrier可以这么实现。

private static SexStatistics[] sexStatisticsData;//统计数据存放数组
private static CyclicBarrier cb;//循环栅栏
    
public static void main(String[] args) {
        sexStatisticsData = new SexStatistics[5];
        cb = new CyclicBarrier(5, new Runnable() {
            @Override
            public void run() {
                //最终汇总男女生数量
                int totalMale = 0, totalFemale = 0;
                for (SexStatistics stat : sexStatisticsData) {
                    totalMale += stat.male;
                    totalFemale += stat.female;
                }
                System.out.println("The school has male:" + totalMale + ",female:" + totalFemale);
            }
        });
       //这里启动5个线程去执行每个班级的男女统计
        for (int i = 0; i < 5; i++) {
            new Thread(new TeacherWork(i)).start();
        }
}
    
static class TeacherWork implements Runnable {
        private int classNo;
        public TeacherWork(int classNo) {
            this.classNo = classNo;
        }
        @Override
        public void run() {
            SexStatistics stat = new SexStatistics();
            stat.male = (int) (Math.random() * 50); //这里用随机数模拟统计
            stat.female = (int) (Math.random() * 50); //这里用随机数模拟统计
            sexStatisticsData[classNo] = stat;
            System.out.println("Class:" + classNo + " has male:" + stat.male + ",female:" + stat.female);
            try {
                cb.await();
            } catch (InterruptedException e) {
                return;
            } catch (BrokenBarrierException e) {
                return;
            }
        }
}
    
static class SexStatistics {
        private int male;
        private int female;
}

上例中定义了一个运行5个线程参与的CyclicBarrier，并且定义了一个实现了Runnable接口的匿名类来模拟校长做最后的汇总；同时启动了5个TeacherWork的线程模拟班主任对各班级男女同学的数量做统计，最后打印出来的日志如下：

Class:1 has male:33,female:38
Class:2 has male:40,female:15
Class:4 has male:22,female:25
Class:3 has male:2,female:29
Class:0 has male:30,female:36
The school has male:127,female:143

CyclicBarrier原理

CyclicBarrier的构造函数有两个：

• 参数parties表示有多少个线程参与到CyclicBarrier的等待中
• 参数barrierAction是一个Runnable的实现类，在所有参与线程都执行完await操作后CyclicBarrier执行barrierAction的run方法，完成后唤醒所有线程，如果没传或者传了null值则不执行

public CyclicBarrier(int parties, Runnable barrierAction){...}
public CyclicBarrier(int parties) {...}

CyclicBarrier主要的是await方法，一个是带有超时功能的，另一个则没有。该方法是给参与线程在处理完业务逻辑之后的，上述例子中各班主任统计完各自班级男女生数量后调用。

public int await(long timeout, TimeUnit unit)
        throws InterruptedException,
               BrokenBarrierException,
               TimeoutException {
        return dowait(true, unit.toNanos(timeout));
}

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

同时await方法还返回了一个int值，这个返回值表示当前线程到达CyclicBarrier时的序号，上例中5个线程从开始到最后的序号分别是4，3，2，1，0。当某个线程await方法返回0时，就表示所有参与线程均已到达，此时如果barrierAction不为null，则会调用该对象的run方法，最后唤醒所有等待线程，并且重置栅栏数据表示可以开始下一轮逻辑。

CyclicBarrier注意点

上述两个await方法我们可以看到会抛出3类Exception：

• InterruptedException：当有参与线程被打断后会抛出
• BrokenBarrierException：当CyclicBarrier已遭破坏后抛出（这里原因可以有多种，比如检测到线程被打断或者超时等，具体可以参考下CyclicBarrier的dowait方法）
• TimeoutException：当线程设置了等待超时并且超时后抛出

同时当我们await方法传递了barrierAction，在调用它的run方法中如果出错了也会抛出上述BrokenBarrierException。

当有任何一个线程抛出以上Exception后，CyclicBarrier就失效了，同时导致其他线程也会抛出上述Exception，所以我们在使用当中需要有所顾虑：

1. 每个参与线程需要处理因CyclicBarrier失效后导致的内存数据或者数据库数据的回滚
2. 在barrierAction中需要注意对Exception进行处理以免影响整个业务逻辑

Demo代码位置

src/main/java/net/weichitech/juc/CyclicBarrierTest.java · 小西学编程/java-learning - Gitee.com

相关文章

JAVA并发之ReentrantLock原理解析