- java.lang.Object
-
- java.util.concurrent.CountDownLatch
-
public class CountDownLatch extends Object
允许一个或多个线程等待直到在其他线程中执行的一组操作完成的同步辅助。A
CountDownLatch
用给定的计数初始化。await
方法阻塞,直到由于调用countDown()
方法,当前计数达到零,此后所有等待线程被释放,并且任何后续的调用await
立即返回。 这是一个一次性的现象 - 计数无法重置。 如果您需要重置计数的版本,请考虑使用CyclicBarrier
。A
CountDownLatch
是一种通用的同步工具,可用于多种用途。 用CountDownLatch
初始化的CountDownLatch
用作简单的开/关锁存器,或者门:所有线程调用await
在门口等待,直到被调用countDown()
的线程打开 。 一个初始化为N的CountDownLatch
可以用来使一个线程等待直到N个线程完成一些动作,或者一些动作已经完成N次。CountDownLatch
一个有用的属性是,它不需要线程调用countDown
等待计数到达零,然后继续,它只是阻止任何线程通过await
,直到所有线程可以通过。示例用法:这是一组类,其中一组工作线程使用两个倒计时锁存器:
- 第一个是启动信号,防止任何工作人员进入,直到驾驶员准备好继续前进;
- 第二个是完成信号,允许司机等到所有的工作人员完成。
class Driver { // ... void main() throws InterruptedException { CountDownLatch startSignal = new CountDownLatch(1); CountDownLatch doneSignal = new CountDownLatch(N); for (int i = 0; i < N; ++i) // create and start threads new Thread(new Worker(startSignal, doneSignal)).start(); doSomethingElse(); // don't let run yet startSignal.countDown(); // let all threads proceed doSomethingElse(); doneSignal.await(); // wait for all to finish } } class Worker implements Runnable { private final CountDownLatch startSignal; private final CountDownLatch doneSignal; Worker(CountDownLatch startSignal, CountDownLatch doneSignal) { this.startSignal = startSignal; this.doneSignal = doneSignal; } public void run() { try { startSignal.await(); doWork(); doneSignal.countDown(); } catch (InterruptedException ex) {} // return; } void doWork() { ... } }
另一个典型的用法是将问题划分为N个部分,用一个Runnable来描述每个部分,该Runnable执行该部分并在锁存器上倒计时,并将所有Runnables排队到执行器。 当所有子部件完成时,协调线程将能够通过等待。 (当线程必须以这种方式反复倒数时,请改用
CyclicBarrier
。 )class Driver2 { // ... void main() throws InterruptedException { CountDownLatch doneSignal = new CountDownLatch(N); Executor e = ... for (int i = 0; i < N; ++i) // create and start threads e.execute(new WorkerRunnable(doneSignal, i)); doneSignal.await(); // wait for all to finish } } class WorkerRunnable implements Runnable { private final CountDownLatch doneSignal; private final int i; WorkerRunnable(CountDownLatch doneSignal, int i) { this.doneSignal = doneSignal; this.i = i; } public void run() { try { doWork(i); doneSignal.countDown(); } catch (InterruptedException ex) {} // return; } void doWork() { ... } }
内存一致性效果:直到计数调用之前达到零,在一个线程操作
countDown()
happen-before下从相应的成功返回行动await()
在另一个线程。- 从以下版本开始:
- 1.5
-
-
构造方法摘要
构造方法 Constructor 描述 CountDownLatch(int count)
构造一个以给定计数初始化的CountDownLatch
。
-
方法摘要
所有方法 接口方法 具体的方法 Modifier and Type 方法 描述 void
await()
导致当前线程等到锁存器向下计数为零,除非线程为 interrupted 。boolean
await(long timeout, TimeUnit unit)
使当前线程等待直到锁存器计数到零为止,除非线程为 interrupted ,否则指定的等待时间已过。void
countDown()
减少锁存器的计数,如果计数达到零,释放所有等待的线程。long
getCount()
返回当前计数。String
toString()
返回一个标识此锁存器的字符串及其状态。
-
-
-
构造方法详细信息
-
CountDownLatch
public CountDownLatch(int count)
构造一个以给定计数初始化的CountDownLatch
。- 参数
-
count
-的次数countDown()
前线程可以通过必须调用await()
- 异常
-
IllegalArgumentException
- 如果count
为负数
-
-
方法详细信息
-
await
public void await() throws InterruptedException
导致当前线程等到锁存器计数到零,除非线程是interrupted 。如果当前计数为零,则此方法立即返回。
如果当前计数大于零,则当前线程将被禁用以进行线程调度,并处于休眠状态,直至发生两件事情之一:
- 由于调用了
countDown()
方法,计数达到零; 要么 - 一些其他线程interrupts当前线程。
如果当前线程:
- 在进入该方法时设置了中断状态; 要么
- 是等待interrupted ,
InterruptedException
并清除当前线程的中断状态。- 异常
-
InterruptedException
- 如果当前线程在等待时中断
- 由于调用了
-
await
public boolean await(long timeout, TimeUnit unit) throws InterruptedException
导致当前线程等到锁存器向下计数到零,除非线程为interrupted或指定的等待时间过去。如果当前计数为零,则该方法将立即返回值为
true
。如果当前计数大于零,则当前线程将被禁用以进行线程调度,并处于休眠状态,直至发生三件事情之一:
- 由于调用了
countDown()
方法,计数达到零; 要么 - 一些其他线程interrupts当前线程; 要么
- 指定的等待时间过去了。
如果计数达到零,则方法返回值为
true
。如果当前线程:
- 在进入该方法时设置了中断状态; 要么
- 是interrupted等待,
InterruptedException
并清除当前线程的中断状态。如果指定的等待时间过去,则返回值
false
。 如果时间小于或等于零,该方法根本不会等待。- 参数
-
timeout
- 等待的最长时间 -
unit
-timeout
参数的时间单位 - 结果
-
true
如果计数达到零和false
如果在计数达到零之前经过的等待时间 - 异常
-
InterruptedException
- 如果当前线程在等待时中断
- 由于调用了
-
countDown
public void countDown()
减少锁存器的计数,如果计数达到零,释放所有等待的线程。如果当前计数大于零,则它将递减。 如果新计数为零,则所有等待的线程都将被重新启用以进行线程调度。
如果当前计数等于零,那么没有任何反应。
-
getCount
public long getCount()
返回当前计数。该方法通常用于调试和测试。
- 结果
- 当前计数
-
-