一、概念
CountDownLatch 是java.util.concurrent中的一个同步工具类,用来协调多个线程之间的同步,或者说起到线程之间的通信(而不是互斥)的作用。机制是只要提供的多个(具体数量等于初始化CountDownLatch时count的值)线程都达到了预期状态或者完成了预期工作时触发事件,其他线程可以等待这个事件来触发自己后续的工作。
等待的线程可以是多个,即 CountDownLatch 可以唤醒多个等待的线程。到达自己预期状态的线程会调用 CountDownLatch 的 countDown(),而等待的线程会调用 CountDownLatch 的 await()。
CountDownLatch 能够使一个线程在等待另外一些线程完成各自工作之后,再继续执行。计数器初始值为线程的数量。当每一个线程完成自己任务后,计数器的值就会减 1。当计数器的值为 0 时,表示所有的线程都已经完成一些任务,然后在 CountDownLatch 上等待的线程就可以恢复执行接下来的任务。
注意:它是一次性的,计算器的值只能在构造方法中初始化一次,之后再没有任何机制对其设置值,当 CountDownLatch 使用完毕后,它不能再次被使用。
二、用法
1️⃣某一线程在开始运行前等待 n 个线程执行完毕。CountDownLatch 的计数器初始化new CountDownLatch(n)
,每当一个任务线程执行完毕,就将计数器减 1 即执行countdownLatch.countDown()
,当计数器的值变为 0 时,在 CountDownLatch 上 await() 的线程就会被唤醒。一个典型应用场景就是启动一个服务时,主线程需要等待多个组件加载完毕,之后再继续执行。
2️⃣实现多个线程开始执行任务的最大并行性。注意是并行性,不是并发,强调的是多个线程在某一时刻同时开始执行。类似于赛跑,将多个线程放到起点,等待发令枪响,然后同时开跑。做法是初始化一个共享的 CountDownLatch(1),将其计算器初始化为 1,多个线程在开始执行任务前首先 countdownlatch.await(),当主线程调用 countDown() 时,计数器变为 0,多个线程同时被唤醒。
三、方法说明
1️⃣public void countDown()
递减锁存器的计数,如果计数到达零,则释放所有等待的线程。如果当前计数大于零,则将计数减少。
2️⃣public void await() throws InterruptedException {};
调用该方法的线程会被挂起,它会等待直到 count 值为 0 才继续执行。
3️⃣public boolean await(long timeout,TimeUnit unit) throws InterruptedException
timeout—>要等待的最长时间;unit—>timeout 参数的时间单位。和 await() 类似,只不过等待一定的时间后 count 值还没变为 0 的话就会继续执行。
使当前线程在锁存器倒计数至零之前一直等待,除非线程被中断或超出了指定的等待时间。如果当前计数为零,此方法立刻返回 true。如果当前计数大于零,出于线程调度目的,将禁用当前线程,且在发生以下三种情况之一前,该线程将一直出于休眠状态:
- 由于调用 countDown(),计数到达零。
- 其他某个线程中断当前线程。
- 已超出指定的等待时间。
- 如果计数到达零,该方法返回 true。
- 如果当前线程,在进入此方法时已经设置了该线程的中断状态;或者在等待时被中断,则抛出 InterruptedException,并且清除当前线程的已中断状态。
- 如果超出了指定的等待时间,则返回 false。如果该时间小于等于零,则该方法根本不会等待。
四、方法示例
1️⃣主线程等待子线程执行完成再执行
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
public class CountdownLatchTest1 {
public static void main(String[] args) {
ExecutorService service = Executors.newFixedThreadPool(3);
final CountDownLatch latch = new CountDownLatch(3);
for (int i = 0; i < 3; i++) {
Runnable runnable = new Runnable() {
@Override
public void run() {
try {
System.out.println("子线程" + Thread.currentThread().getName() + "开始执行");
Thread.sleep((long) (Math.random() * 10000));
System.out.println("子线程" + Thread.currentThread().getName() + "执行完成");
latch.countDown();//当前线程调用此方法,则计数减1
} catch (InterruptedException e) {
e.printStackTrace();
}
}
};
service.execute(runnable);
}
try {
System.out.println("主线程" + Thread.currentThread().getName() + "等待子线程执行完成...");
latch.await();//阻塞当前线程,直到计数器的值为0
service.shutdown();
System.out.println("主线程" + Thread.currentThread().getName() + "开始执行...");
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
2️⃣百米赛跑,4 名选手等待裁判口令,裁判一声口令,选手听到后同时起跑,当所有选手到达终点,裁判进行汇总排名
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
public class CountdownLatchTest2 {
public static void main(String[] args) {
ExecutorService service = Executors.newCachedThreadPool();
final CountDownLatch cdOrder = new CountDownLatch(1);
final CountDownLatch cdAnswer = new CountDownLatch(4);
for (int i = 0; i < 4; i++) {
Runnable runnable = new Runnable() {
@Override
public void run() {
try {
System.out.println("选手" + Thread.currentThread().getName() + "正在等待裁判发布口令");
cdOrder.await();
System.out.println("选手" + Thread.currentThread().getName() + "已接受裁判口令");
Thread.sleep((long) (Math.random() * 10000));
System.out.println("选手" + Thread.currentThread().getName() + "到达终点");
cdAnswer.countDown();
} catch (InterruptedException e) {
e.printStackTrace();
}
}
};
service.execute(runnable);
}
try {
Thread.sleep((long) (Math.random() * 10000));
System.out.println("裁判" + Thread.currentThread().getName() + "即将发布口令");
cdOrder.countDown();
System.out.println("裁判" + Thread.currentThread().getName() + "已发送口令,正在等待所有选手到达终点");
cdAnswer.await();
System.out.println("所有选手都到达终点");
System.out.println("裁判" + Thread.currentThread().getName() + "汇总成绩排名");
} catch (InterruptedException e) {
e.printStackTrace();
}
service.shutdown();
}
}
3️⃣确保三个线程顺序执行
import java.util.concurrent.CountDownLatch;
public class CountdownLatchTest3 {
// T1、T2、T3三个线程顺序执行
public static void main(String[] args) {
CountDownLatch c0 = new CountDownLatch(0); //计数器为0
CountDownLatch c1 = new CountDownLatch(1); //计数器为1
CountDownLatch c2 = new CountDownLatch(1); //计数器为1
//c0为0,t1可以执行。t1的计数器减1
Thread t1 = new Thread(new Work(c0, c1));
//t1的计数器为0时,t2才能执行。t2的计数器c2减1
Thread t2 = new Thread(new Work(c1, c2));
//t2的计数器c2为0时,t3才能执行
Thread t3 = new Thread(new Work(c2, c2));
t1.start();
t2.start();
t3.start();
}
//定义Work线程类,需要传入开始和结束的CountDownLatch参数
static class Work implements Runnable {
CountDownLatch c1;
CountDownLatch c2;
Work(CountDownLatch c1, CountDownLatch c2) {
super();
this.c1 = c1;
this.c2 = c2;
}
public void run() {
try {
c1.await();//前一线程为0才可以执行
System.out.println("thread start:" + Thread.currentThread().getName());
c2.countDown();//本线程计数器减少
} catch (InterruptedException e) {
}
}
}
}