Java并发工具类之CountDownLatch

概述

CountDownLatch是一个同步工具类，用来协调多个线程之间的同步，或者说起到线程之间的通信的作用。CountDownLatch能够使一个线程在等待另外一些线程完成各自工作之后，再继续执行。使用一个计数器进行实现，计数器初始值为线程的数量。当每一个线程完成自己任务后，调用countDown()方法使计数器的值减1。当计数器的值为0时，表示所有的线程都已经完成一些任务，然后在CountDownLatch上等待的线程就可以恢复执行接下来的任务。

方法说明

public void await() throws InterruptedException {
    ...
}

public boolean await(long timeout, TimeUnit unit)
    throws InterruptedException {
    ...
}

public void countDown() {
    ...
}

在使用CountDownLatch时，首先要new一个CountDownLatch对象：CountDownLatch latch = new CountDownLatch(3)；

调用latch.await()方法会阻塞当前线程，直到计数器为0时，当前线程才会从await()方法中返回并继续往后执行。await(long timeout, TimeUnit unit)方法不会让当前线程一直等待，如果超过了设置的时间timeout，即使计数器不为0，线程也会从await(long timeout, TimeUnit unit)方法中返回。调用latch.countDown()方法会使计数器减1。

应用场景

1. 一个线程等待多个多个线程（任务合并）

假如有这样一个需求：我们需要解析一个Excel里多个sheet的数据，此时可以考虑使用多线程，每个线程解析一个sheet里的数据，等到所有的sheet都解析完之后，程序会对所有的sheet的解析结果进行合并。再假如这样的场景：启动一个服务时，主线程需要等待多个组件加载完毕，之后再继续执行。

在这种情况下，我们将计数器值设为等待的线程数量，我们会在主线程中调用awite()方法进行等待；在子线程中，没完成一个任务就会调用countDown方法使得计数器值减1，等所有的任务完成了，计数器值就为0了，这时主线程才从awite方法中返回，继续执行后面的代码。

示例代码

CountDownLatch countDownLatch = new CountDownLatch(5);
for (int i = 0; i < 5; i++) {
    final int index = i;
    new Thread(() -> {
        try {
            Thread.sleep(1000 + ThreadLocalRandom.current().nextInt(1000));
            System.out.println("finish" + index + Thread.currentThread().getName());
            countDownLatch.countDown();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }).start();
}

countDownLatch.await();// 主线程在阻塞，当计数器==0，就唤醒主线程往下执行。
System.out.println("主线程:在所有任务运行完成后，进行结果汇总");
------------------------------------------------------------------------
//运行结果
finish4Thread-4
finish1Thread-1
finish2Thread-2
finish3Thread-3
finish0Thread-0
主线程:在所有任务运行完成后，进行结果汇总

2. 多个线程集合完毕后一起执行

为了模拟高并发，让一组线程在指定时刻(秒杀时间)执行抢购，这些线程在准备就绪后，进行等待(CountDownLatch.await())，直到秒杀时刻的到来，然后一拥而上；在这个场景中，CountDownLatch充当的是一个发令枪的角色；就像田径赛跑时，运动员会在起跑线做准备动作，等到发令枪一声响，运动员就会奋力奔跑。和上面的秒杀场景类似。在这种场景下，计数器的值初始化为1。

CountDownLatch countDownLatch = new CountDownLatch(1);
for (int i = 0; i < 5; i++) {
    new Thread(() -> {
        try {
            //准备完毕……运动员都阻塞在这，等待号令
            countDownLatch.await();
            String parter = "【" + Thread.currentThread().getName() + "】";
            System.out.println(parter + "开始执行……");
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }).start();
}

Thread.sleep(2000);// 裁判准备发令
countDownLatch.countDown();// 发令枪：执行发令
--------------------------------------------------------
// 运行结果
【Thread-0】开始执行……
【Thread-1】开始执行……
【Thread-4】开始执行……
【Thread-3】开始执行……
【Thread-2】开始执行……

注意两种场景中，await和countDown方法的位置，这是主要区别。

参考资料

CountDownLatch的两种常用场景