CountDownLatch

CountDownLatch

• 博客分类： 
• 多线程

 

CountDownLatch

          可以用来在一个线程中等待多个线程完成任务的类；  

通常的使用场景是，某个主线程接到一个任务，起了n个子线程去完成，但是主线程需要等待这n个子线程都完成任务了以后才开始执行某个操作

 

 

JDK:

一个同步辅助类，在完成一组其他线程执行的操作之前，它允许一个或多个线程一直等待。

用给定的计数 初始化 CountDownLatch。由于调用了 countDown() 方法，所以在当前计数到达零之前，await 方法会一直受阻塞。之后，会释放所有等待的线程，await 的所有后续调用都将立即返回。这种现象只出现一次——计数无法被重置。如果需要重置计数，请考虑使用 CyclicBarrier。

 

CountDownLatch 是一个通用同步工具，它有很多用途。将计数 1 初始化的 CountDownLatch 用作一个简单的开/关锁存器，或入口：在通过调用 countDown() 的线程打开入口前，所有调用 await 的线程都一直在入口处等待。用 N 初始化的 CountDownLatch 可以使一个线程在 N 个线程完成某项操作之前一直等待，或者使其在某项操作完成 N 次之前一直等待。

 

它本身而言是Java并发包中非常有用的一个类，它可以让某些任务完成以后再继续运行下面的内容，每个任务本身执行完毕后让计数器减一，直到计数器清零后，以下的内容才可以继续运行，否则将阻塞等待。

 

 

CountDownLatch 的一个有用特性是，它不要求调用 countDown 方法的线程等到计数到达零时才继续，而在所有线程都能通过之前，它只是阻止任何线程继续通过一个 await。

 

http://www.cjsdn.net/Doc/JDK60/java/util/concurrent/locks/Condition.html

 

 

Java代码  

1. /*构造方法摘要 
2. CountDownLatch(int count)  
3.           构造一个用给定计数初始化的 CountDownLatch。 
4. */  

 CountDownLatch有以下基本方法：

 

1）await(),阻塞等待，直到计数器清零 

2）await(int timeout, TimeUnit unit),使线程阻塞，除非被中断或者超过等待的最大时间

如果达到计数器清零，则await返回true，如果等待超过了最大的等待时间，则返回false 

3）countDown(),计数器减一，当计数器清零时,await的线程被唤醒,线程继续执行 

4）getCount ()，获取当前计数器的大小

 

       下面的例子模拟 一个命令发出者和三个命令接受者，三个命令接受者首先阻塞在命令发出者，当命令发出后，三个接受者接收到命令开始执行相应的操作，同时命令发出者阻塞等待所有的接受者完成。类似于赛跑，所有运动员站到起跑线后都在等待裁判发出命令，运动员接受到命令后开始奔跑，当所有运动员跑到终点后，裁判宣布赛跑结果。代码如下：

Java代码  

1. package tags;  
2.   
3. import java.util.concurrent.CountDownLatch;  
4.   
5. public class CountdownLatchTest {  
6.     public static void main(String[] args) {  
7.         ExecutorService service = Executors.newCachedThreadPool();  
8.         final CountDownLatch cdOrder = new CountDownLatch(1);  
9.         final CountDownLatch cdAnswer = new CountDownLatch(3);  
10.   
11.         for (int i = 0; i < 3; i++) {  
12.             Runnable runnable = new Runnable() {  
13.   
14.                 public void run() {  
15.                     try {  
16.                             System.out.println("线程" + Thread.currentThread().getName() + "正准备接受命令");  
17.                         cdOrder.await();  
18.                             System.out.println("线程" + Thread.currentThread().getName() + "已接受命令");  
19.                         Thread.sleep((long) (Math.random() * 10000));  
20.                             System.out.println("线程" + Thread.currentThread().getName() + "回应命令处理结果");  
21.                         cdAnswer.countDown();  
22.                     } catch (Exception e) {  
23.                         e.printStackTrace();  
24.                     }  
25.                 }  
26.   
27.             };  
28.             service.execute(runnable);  
29.         }  
30.         try {  
31.             Thread.sleep((long) (Math.random() * 10000));  
32.                 System.out.println("线程" + Thread.currentThread().getName() + "即将发布命令");  
33.             cdOrder.countDown();  
34.                 System.out.println("线程" + Thread.currentThread().getName() + "已经发送命令，正在等待结果");  
35.             cdAnswer.await();  
36.                 System.out.println("线程" + Thread.currentThread().getName() + "已收到所有响应结果");  
37.         } catch (Exception e) {  
38.             e.printStackTrace();  
39.         }  
40.         service.shutdown();  
41.     }  
42. }  

 结果：

 

线程pool-1-thread-1正准备接受命令

线程pool-1-thread-3正准备接受命令

线程pool-1-thread-2正准备接受命令

线程main即将发布命令

线程pool-1-thread-1已接受命令

线程pool-1-thread-3已接受命令

线程pool-1-thread-2已接受命令

线程main已经发送命令，正在等待结果

线程pool-1-thread-1回应命令处理结果

线程pool-1-thread-2回应命令处理结果

线程pool-1-thread-3回应命令处理结果

线程main已收到所有响应结果

 

 

下面的例子是jdk中的说明：

将一个问题分成 N 个部分，用执行每个部分并让锁存器倒计数的 Runnable 来描述每个部分，然后将所有 Runnable 加入到 Executor 队列。当所有的子部分完成后，协调线程就能够通过 await。（当线程必须用这种方法反复倒计数时，可改为使用CyclicBarrier。）

代码如下：

Java代码  

1. class Driver2 { // ...  
2.    void main() throws InterruptedException {  
3.      CountDownLatch doneSignal = new CountDownLatch(N);  
4.      Executor e = ...  
5.      for (int i = 0; i < N; ++i) // create and start threads  
6.        e.execute(new WorkerRunnable(doneSignal, i));  
7.   
8.      doneSignal.await();           // wait for all to finish  
9.    }  
10.  }  
11.   
12.  class WorkerRunnable implements Runnable {  
13.    private final CountDownLatch doneSignal;  
14.    private final int i;  
15.    WorkerRunnable(CountDownLatch doneSignal, int i) {  
16.       this.doneSignal = doneSignal;  
17.       this.i = i;  
18.    }  
19.    public void run() {  
20.       try {  
21.         doWork(i);  
22.         doneSignal.countDown();  
23.       } catch (InterruptedException ex) {} // return;  
24.    }  
25.   
26.    void doWork() { ... }  
27.  }  

 

总结：

 

总体上就是当调用await()方法时，阻塞，直到调用countDown()使其count为0时，被阻塞的线程才开始执行，功能和CyclicBarrier大同小异。