CountDownLatch使用指南-Java快速入门教程

1. 简介

在本文中，我们将提供CountDownLatch类的指南，并演示如何在一些实际示例中使用它。

本质上，通过使用CountDownLatch，我们可以使线程阻塞，直到其他线程完成给定任务。

2. 并发编程中的用法

简单地说，CountDownLatch有一个计数器字段，你可以根据需要递减。然后，我们可以使用它来阻止调用线程，直到它被倒计时到零。

如果我们进行一些并行处理，我们可以实例化CountDownLatch，其计数器值与我们想要处理的多个线程相同。然后，我们可以在每个线程完成后调用countdown（），保证调用await（） 的依赖线程将阻塞，直到工作线程完成。

3. 等待线程池完成

让我们通过创建一个Worker并使用CountDownLatch字段来尝试这种模式，以指示它何时完成：

public class Worker implements Runnable {
    private List<String> outputScraper;
    private CountDownLatch countDownLatch;

    public Worker(List<String> outputScraper, CountDownLatch countDownLatch) {
        this.outputScraper = outputScraper;
        this.countDownLatch = countDownLatch;
    }

    @Override
    public void run() {
        doSomeWork();
        outputScraper.add("Counted down");
        countDownLatch.countDown();
    }
}Copy

然后，让我们创建一个测试，以证明我们可以获得一个 CountDownLatch来等待Worker实例完成：

@Test
public void whenParallelProcessing_thenMainThreadWillBlockUntilCompletion()
  throws InterruptedException {

    List<String> outputScraper = Collections.synchronizedList(new ArrayList<>());
    CountDownLatch countDownLatch = new CountDownLatch(5);
    List<Thread> workers = Stream
      .generate(() -> new Thread(new Worker(outputScraper, countDownLatch)))
      .limit(5)
      .collect(toList());

      workers.forEach(Thread::start);
      countDownLatch.await(); 
      outputScraper.add("Latch released");

      assertThat(outputScraper)
        .containsExactly(
          "Counted down",
          "Counted down",
          "Counted down",
          "Counted down",
          "Counted down",
          "Latch released"
        );
    }Copy

当然，“Latch release”将始终是最后的输出 - 因为它取决于CountDownLatch的发布。

请注意，如果我们不调用await（），我们将无法保证线程执行的顺序，因此测试将随机失败。

4.等待开始的线程池

如果我们采用前面的示例，但这次启动了数千个线程而不是五个线程，那么许多早期的线程很可能在我们甚至在后面的线程上调用start（） 之前就已经完成了处理。这可能会使尝试重现并发问题变得困难，因为我们无法让所有线程并行运行。

为了解决这个问题，让我们让CountdownLatch的工作方式与前面的示例不同。我们可以阻止每个子线程，直到所有其他子线程启动为止，而不是阻塞父线程。

让我们修改我们的run（） 方法，使其在处理之前阻塞：

public class WaitingWorker implements Runnable {

    private List<String> outputScraper;
    private CountDownLatch readyThreadCounter;
    private CountDownLatch callingThreadBlocker;
    private CountDownLatch completedThreadCounter;

    public WaitingWorker(
      List<String> outputScraper,
      CountDownLatch readyThreadCounter,
      CountDownLatch callingThreadBlocker,
      CountDownLatch completedThreadCounter) {

        this.outputScraper = outputScraper;
        this.readyThreadCounter = readyThreadCounter;
        this.callingThreadBlocker = callingThreadBlocker;
        this.completedThreadCounter = completedThreadCounter;
    }

    @Override
    public void run() {
        readyThreadCounter.countDown();
        try {
            callingThreadBlocker.await();
            doSomeWork();
            outputScraper.add("Counted down");
        } catch (InterruptedException e) {
            e.printStackTrace();
        } finally {
            completedThreadCounter.countDown();
        }
    }
}Copy

现在，让我们修改我们的测试，使其阻止直到所有工作线程启动，取消阻止工作线程，然后阻止直到工作线程完成：

@Test
public void whenDoingLotsOfThreadsInParallel_thenStartThemAtTheSameTime()
 throws InterruptedException {
 
    List<String> outputScraper = Collections.synchronizedList(new ArrayList<>());
    CountDownLatch readyThreadCounter = new CountDownLatch(5);
    CountDownLatch callingThreadBlocker = new CountDownLatch(1);
    CountDownLatch completedThreadCounter = new CountDownLatch(5);
    List<Thread> workers = Stream
      .generate(() -> new Thread(new WaitingWorker(
        outputScraper, readyThreadCounter, callingThreadBlocker, completedThreadCounter)))
      .limit(5)
      .collect(toList());

    workers.forEach(Thread::start);
    readyThreadCounter.await(); 
    outputScraper.add("Workers ready");
    callingThreadBlocker.countDown(); 
    completedThreadCounter.await(); 
    outputScraper.add("Workers complete");

    assertThat(outputScraper)
      .containsExactly(
        "Workers ready",
        "Counted down",
        "Counted down",
        "Counted down",
        "Counted down",
        "Counted down",
        "Workers complete"
      );
}Copy

此模式对于尝试重现并发错误非常有用，因为可用于强制数千个线程尝试并行执行某些逻辑。

5. 提前终止倒计时闩锁

有时，我们可能会遇到工人在倒计时之前错误终止的情况。这可能导致它永远不会达到零，并且 await（） 永远不会终止：

@Override
public void run() {
    if (true) {
        throw new RuntimeException("Oh dear, I'm a BrokenWorker");
    }
    countDownLatch.countDown();
    outputScraper.add("Counted down");
}Copy

让我们修改我们之前的测试以使用Broken Worker，以显示await（） 将如何永久阻塞：

@Test
public void whenFailingToParallelProcess_thenMainThreadShouldGetNotGetStuck()
  throws InterruptedException {
 
    List<String> outputScraper = Collections.synchronizedList(new ArrayList<>());
    CountDownLatch countDownLatch = new CountDownLatch(5);
    List<Thread> workers = Stream
      .generate(() -> new Thread(new BrokenWorker(outputScraper, countDownLatch)))
      .limit(5)
      .collect(toList());

    workers.forEach(Thread::start);
    countDownLatch.await();
}Copy

显然，这不是我们想要的行为 - 应用程序继续比无限阻塞要好得多。

为了解决这个问题，让我们在调用await（） 中添加一个超时参数。

boolean completed = countDownLatch.await(3L, TimeUnit.SECONDS);
assertThat(completed).isFalse();Copy

正如我们所看到的，测试最终会超时，await（） 会返回false。

6. 结论

在本快速指南中，我们演示了如何使用CountDownLatch来阻塞线程，直到其他线程完成一些处理。

我们还展示了如何使用它通过确保线程并行运行来帮助调试并发问题。