Java之CountDownLatch使用

CountDownLatch

1、类介绍

一个同步辅助类，在完成一组正在其他线程中执行的操作之前，它允许一个或多个线程一直等待。用给定的计数 初始化 CountDownLatch。由于调用了 countDown() 方法，所以在当前计数到达零之前，await 方法会一直受阻塞。之后，会释放所有等待的线程，await 的所有后续调用都将立即返回。这种现象只出现一次——计数无法被重置。 一个线程(或者多个)， 等待另外N个线程完成某个事情之后才能执行

2、使用场景

在一些应用场合中，需要等待某个条件达到要求后才能做后面的事情；同时当线程都完成后也会触发事件，以便进行后面的操作。 这个时候就可以使用CountDownLatch。CountDownLatch最重要的方法是countDown()和await()，前者主要是倒数一次，后者是等待倒数到0，如果没有到达0，就只有阻塞等待了。

3、方法说明

countDown

public void countDown()

递减锁存器的计数，如果计数到达零，则释放所有等待的线程。如果当前计数大于零，则将计数减少。如果新的计数为零，出于线程调度目的，将重新启用所有的等待线程。

如果当前计数等于零，则不发生任何操作。

await

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

使当前线程在锁存器倒计数至零之前一直等待，除非线程被中断或超出了指定的等待时间。如果当前计数为零，则此方法立刻返回 true 值。

如果当前计数大于零，则出于线程调度目的，将禁用当前线程，且在发生以下三种情况之一前，该线程将一直处于休眠状态：

• 由于调用 countDown() 方法，计数到达零；或者
• 其他某个线程中断当前线程；或者
• 已超出指定的等待时间。

如果计数到达零，则该方法返回 true 值。

如果当前线程：

• 在进入此方法时已经设置了该线程的中断状态；或者
• 在等待时被中断，

则抛出 InterruptedException，并且清除当前线程的已中断状态。如果超出了指定的等待时间，则返回值为 false。如果该时间小于等于零，则此方法根本不会等待。

 

参数：

timeout - 要等待的最长时间

unit - timeout 参数的时间单位。

返回：

如果计数到达零，则返回 true；如果在计数到达零之前超过了等待时间，则返回 false

抛出：

InterruptedException - 如果当前线程在等待时被中断

4、相关实例

<span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">public</span> <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">class</span> CountDownLatchTest {    <span class="bh_code_a_Java_comments" style="margin: 0px; padding: 0px; border: 0px; color: rgb(63, 127, 95); background-color: transparent;">// 模拟了100米赛跑，10名选手已经准备就绪，只等裁判一声令下。当所有人都到达终点时，比赛结束。</span>    <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">public</span> <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">static</span> <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">void</span> main(String[] args) <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">throws</span> InterruptedException {        <span class="bh_code_a_Java_comments" style="margin: 0px; padding: 0px; border: 0px; color: rgb(63, 127, 95); background-color: transparent;">// 开始的倒数锁 </span>        <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">final</span> CountDownLatch begin = <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">new</span> CountDownLatch(1);          <span class="bh_code_a_Java_comments" style="margin: 0px; padding: 0px; border: 0px; color: rgb(63, 127, 95); background-color: transparent;">// 结束的倒数锁 </span>        <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">final</span> CountDownLatch end = <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">new</span> CountDownLatch(10);          <span class="bh_code_a_Java_comments" style="margin: 0px; padding: 0px; border: 0px; color: rgb(63, 127, 95); background-color: transparent;">// 十名选手 </span>        <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">final</span> ExecutorService exec = Executors.newFixedThreadPool(10);          <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">for</span> (<span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">int</span> index = 0; index < 10; index++) {            <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">final</span> <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">int</span> NO = index + 1;              Runnable run = <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">new</span> Runnable() {                <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">public</span> <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">void</span> run() {                      <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">try</span> {                          <span class="bh_code_a_Java_comments" style="margin: 0px; padding: 0px; border: 0px; color: rgb(63, 127, 95); background-color: transparent;">// 如果当前计数为零，则此方法立即返回。</span>                        <span class="bh_code_a_Java_comments" style="margin: 0px; padding: 0px; border: 0px; color: rgb(63, 127, 95); background-color: transparent;">// 等待</span>                        begin.await();                          Thread.sleep((<span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">long</span>) (Math.random() * 10000));                          System.out.println(<span class="bh_code_a_Java_string" style="margin: 0px; padding: 0px; border: 0px; color: rgb(42, 0, 255); background-color: transparent;">"No."</span> + NO + <span class="bh_code_a_Java_string" style="margin: 0px; padding: 0px; border: 0px; color: rgb(42, 0, 255); background-color: transparent;">" arrived"</span>);                      } <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">catch</span> (InterruptedException e) {                      } <span class="bh_code_a_Java_keywords" style="margin: 0px; padding: 0px; border: 0px; color: rgb(127, 0, 85); background-color: transparent;">finally</span> {                          <span class="bh_code_a_Java_comments" style="margin: 0px; padding: 0px; border: 0px; color: rgb(63, 127, 95); background-color: transparent;">// 每个选手到达终点时，end就减一</span>                        end.countDown();                    }                  }              };              exec.submit(run);        }          System.out.println(<span class="bh_code_a_Java_string" style="margin: 0px; padding: 0px; border: 0px; color: rgb(42, 0, 255); background-color: transparent;">"Game Start"</span>);          <span class="bh_code_a_Java_comments" style="margin: 0px; padding: 0px; border: 0px; color: rgb(63, 127, 95); background-color: transparent;">// begin减一，开始游戏</span>        begin.countDown();          <span class="bh_code_a_Java_comments" style="margin: 0px; padding: 0px; border: 0px; color: rgb(63, 127, 95); background-color: transparent;">// 等待end变为0，即所有选手到达终点</span>        end.await();          System.out.println(<span class="bh_code_a_Java_string" style="margin: 0px; padding: 0px; border: 0px; color: rgb(42, 0, 255); background-color: transparent;">"Game Over"</span>);          exec.shutdown();      }}

5、输出结果

Game Start
No.9 arrived
No.6 arrived
No.8 arrived
No.7 arrived
No.10 arrived
No.1 arrived
No.5 arrived
No.4 arrived
No.2 arrived
No.3 arrived
Game Over

转载地址：http://www.itzhai.com/the-introduction-and-use-of-a-countdownlatch.html