Java并发工具类（一）：等待多线程完成的CountDownLatch

作用

CountDownLatch是一个同步工具类，它允许一个或多个线程一直等待，直到其他线程的操作执行完后再执行

简介

CountDownLatch是在java1.5被引入的，存在于java.util.concurrent包下，它允许1个或者多个线程一直等待，直到一组操作执行完成。

CountDownLatch是通过一个计数器来实现的，计数器的初始值为线程的数量，此值是线程将要等待的操作数（线程的数量）。当某个线程为了想要执行这些操作而等待时，它要使用 await()方法。此方法让线程进入休眠直到操作完成。当某个操作结束，它使用countDown() 方法来减少CountDownLatch类的内部计数器，计数器的值就会减1。当计数器到达0时，它表示所有的线程已经完成了任务，这个类会唤醒全部使用await() 方法休眠的线程们恢复执行任务。

应用场景

假如有这样一个需求，当我们需要解析一个Excel里多个sheet的数据时，可以考虑使用多线程，每个线程解析一个sheet里的数据，等到所有的sheet都解析完之后，程序需要提示解析完成。在这个需求中，要实现主线程等待所有线程完成sheet的解析操作，最简单的做法是使用join。代码如下：

 1 public class JoinCountDownLatchTest {
 2 
 3     public static void main(String[] args) throws InterruptedException {
 4         Thread parser1 = new Thread(new Runnable() {
 5             @Override
 6             public void run() {
 7             }
 8         });
 9 
10         Thread parser2 = new Thread(new Runnable() {
11             @Override
12             public void run() {
13                 System.out.println("parser2 finish");
14             }
15         });
16 
17         parser1.start();
18         parser2.start();
19         parser1.join();
20         parser2.join();
21         System.out.println("all parser finish");
22     }
23 
24 }

join用于让当前执行线程等待join线程执行结束。其实现原理是不停检查join线程是否存活，如果join线程存活则让当前线程永远wait，代码片段如下，wait(0)表示永远等待下去。

while (isAlive()) {
 wait(0);
}

直到join线程中止后，线程的this.notifyAll会被调用，调用notifyAll是在JVM里实现的，所以JDK里看不到，有兴趣的同学可以看看JVM源码。JDK不推荐在线程实例上使用wait，notify和notifyAll方法。

而在JDK1.5之后的并发包中提供的CountDownLatch也可以实现join的这个功能，并且比join的功能更多。

 1 public class CountDownLatchTest {
 2 
 3     static CountDownLatch c = new CountDownLatch(2);
 4 
 5     public static void main(String[] args) throws InterruptedException {
 6         new Thread(new Runnable() {
 7             @Override
 8             public void run() {
 9                 System.out.println(1);
10                 c.countDown();
11                 System.out.println(2);
12                 c.countDown();
13             }
14         }).start();
15 
16         c.await();
17         System.out.println("3");
18     }
19 
20 }

CountDownLatch的构造函数接收一个int类型的参数作为计数器，如果你想等待N个点完成，这里就传入N。

当我们调用一次CountDownLatch的countDown方法时，N就会减1，CountDownLatch的await会阻塞当前线程，直到N变成零。由于countDown方法可以用在任何地方，所以这里说的N个点，可以是N个线程，也可以是1个线程里的N个执行步骤。用在多个线程时，你只需要把这个CountDownLatch的引用传递到线程里。

其他方法

如果有某个解析sheet的线程处理的比较慢，我们不可能让主线程一直等待，所以我们可以使用另外一个带指定时间的await方法，await(long time, TimeUnit unit): 这个方法等待特定时间后，就会不再阻塞当前线程。join也有类似的方法。

注意：计数器必须大于等于0，只是等于0时候，计数器就是零，调用await方法时不会阻塞当前线程。CountDownLatch不可能重新初始化或者修改CountDownLatch对象的内部计数器的值。一个线程调用countDown方法 happen-before 另外一个线程调用await方法。

参考：《Java并发编程的艺术》