CountDownLatch

https://blog.csdn.net/shihuacai/article/details/8856370

CountDownLatch

1. 类介绍
   一个同步辅助类，在完成一组正在其他线程中执行的操作之前，它允许一个或多个线程一直等待。用给定的计数 初始化 CountDownLatch。由于调用了 countDown() 方法，所以在当前计数到达零之前，await 方法会一直受阻塞。之后，会释放所有等待的线程，await 的所有后续调用都将立即返回。这种现象只出现一次——计数无法被重置。 一个线程(或者多个)， 等待另外N个线程完成某个事情之后才能执行
   CountDownLatch是通过一个计数器来实现的，计数器的初始值为线程的数量。每当一个线程完成了自己的任务后，计数器的值就会减1。当计数器值到达0时，它表示所有的线程已经完成了任务，然后在闭锁上等待的线程就可以恢复执行任务。
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 - 如果当前线程在等待时被中断

CountDownLatch.java类中定义的构造函数：·

//Constructs a CountDownLatch initialized with the given count.
public void CountDownLatch(int count) {...}

构造器中的计数值（count）实际上就是闭锁需要等待的线程数量。这个值只能被设置一次，而且CountDownLatch没有提供任何机制去重新设置这个计数值。

与CountDownLatch的第一次交互是主线程等待其他线程。主线程必须在启动其他线程后立即调用CountDownLatch.await()方法。这样主线程的操作就会在这个方法上阻塞，直到其他线程完成各自的任务。

其他N 个线程必须引用闭锁对象，因为他们需要通知CountDownLatch对象，他们已经完成了各自的任务。这种通知机制是通过 CountDownLatch.countDown()方法来完成的；每调用一次这个方法，在构造函数中初始化的count值就减1。所以当N个线程都调 用了这个方法，count的值等于0，然后主线程就能通过await()方法，恢复执行自己的任务。

4. 相关实例

package day02;

import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

/**
 * @author ZerlindaLi create at 2019/6/11 11:00
 * @version 1.0.0
 * @description CountDownLatchTest
 */
public class CountDownLatchTest {
    // 模拟了100米赛跑，10名选手已经准备就绪，只等裁判一声令下。当所有人都到达终点时，比赛结束。
    public static void main(String[] args) throws Exception{
        // 开始倒数锁
        final CountDownLatch begin = new CountDownLatch(1);
        // 结束的倒数锁
        final CountDownLatch end = new CountDownLatch(10);
        // 十名选手
        final ExecutorService exec = Executors.newFixedThreadPool(10);

        for(int index = 0; index < 10; index++){
            final int NO = index + 1;
            Runnable run = new Runnable() {
                @Override
                public void run() {
                    try {
                        // 如果当前计数为零，则次方法立即返回。
                        // 等待
                        begin.await();
                        Thread.sleep((long) (Math.random() * 10000));
                        System.out.println("No."+NO+" arrived");
                    } catch (InterruptedException e) {
                        e.printStackTrace();
                    } finally {
                        // 每个选手到达终点时，end就减一
                        end.countDown();
                    }
                }
            };
            exec.submit(run);
        }
        System.out.println("Game Start");
        // begin减一，开始游戏
        begin.countDown();
        // 等待end变为0，即所有选手到达终点
        end.await();
        System.out.println("Game Over");
    }
}

5. 输出结果

E:\environment\java1.8\jdk1.8.0_201\bin\java.exe "-javaagent:E:\environment\JetBrains\IntelliJ IDEA 2019.1\lib\idea_rt.jar=62307:E:\environment\JetBrains\IntelliJ IDEA 2019.1\bin" -Dfile.encoding=UTF-8 -classpath E:\environment\java1.8\jdk1.8.0_201\jre\lib\charsets.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\deploy.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\ext\access-bridge-64.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\ext\cldrdata.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\ext\dnsns.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\ext\jaccess.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\ext\jfxrt.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\ext\localedata.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\ext\nashorn.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\ext\sunec.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\ext\sunjce_provider.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\ext\sunmscapi.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\ext\sunpkcs11.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\ext\zipfs.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\javaws.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\jce.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\jfr.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\jfxswt.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\jsse.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\management-agent.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\plugin.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\resources.jar;E:\environment\java1.8\jdk1.8.0_201\jre\lib\rt.jar;E:\workspace\zli-scala-learn\target\scala-2.12\classes;C:\Users\zerli\.ivy2\cache\org.scala-lang\scala-library\jars\scala-library-2.12.8.jar day02.CountDownLatchTest
Game Start
No.7 arrived
No.5 arrived
No.6 arrived
No.9 arrived
No.4 arrived
No.10 arrived
No.1 arrived
No.2 arrived
No.3 arrived
No.8 arrived
Game Over