CountDownLatch类的使用

Posted 2020-11-01

CountDownLatch介绍

JDk1.5提供了一个非常有用的包，Concurrent包，这个包主要用来操作一些并发操作，提供一些并发类，可以方便在项目当中傻瓜式应用。

JDK1.5以前，使用并发操作，都是通过Thread，Runnable来操作多线程；但是在JDK1.5之后，提供了非常方便的线程池（ThreadExecutorPool），主要代码由大牛Doug Lea完成，其实是在jdk1.4时代，由于java语言内置对多线程编程的支持比较基础和有限，所以他写了这个，因为实在太过于优秀，所以被加入到jdk之中。而本文要介绍的是Concurrent包下的CountDownLatch类。

CountDownLatch类位于java.util.concurrent包下，利用它可以实现类似计数器的功能。比如有一个任务A，它要等待其他4个任务执行完毕之后才能执行，此时就可以利用CountDownLatch来实现这种功能了。CountDownLatch是通过一个计数器来实现的，计数器的初始值为线程的数量。每当一个线程完成了自己的任务后，计数器的值就会减1。当计数器值到达0时，它表示所有的线程已经完成了任务，然后在闭锁上等待的线程就可以恢复执行任务。

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

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

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

---

CountDownLatch代码示例

我们来用一个例子演示CountDownLatch的使用，在这个例子中，我们来模拟一个危险品化工车监控中心。它开始时启动了n个线程，这些线程将检查调度站的化工车辆是否可以发车，并通知闭锁，并且启动类一直在闭锁上等待着。一旦验证和检查了所有调度站的化工车辆可以正常发车，那么启动类就会恢复执行。

DangerCenter 类，这个类是一个Runnable，负责所有调度站的化工车辆检查，属于是一个监控中心。代码如下：

package org.zero01.zk.countdown;

import java.util.concurrent.CountDownLatch;

/**
 * 抽象类，用于演示 危险品化工车监控中心 统一检查
 */
public abstract class DangerCenter implements Runnable {

    private CountDownLatch countDown;       // 计数器
    private String station;                 // 调度站
    private boolean ok;                     // 调度站针对当前自己的站点进行检查，是否检查ok的标志

    public DangerCenter(CountDownLatch countDown, String station) {
        this.countDown = countDown;
        this.station = station;
        this.ok = false;
    }

    public void run() {
        try {
            check();
            ok = true;
        } catch (Exception e) {
            e.printStackTrace();
            ok = false;
        } finally {
            if (countDown != null) {
                countDown.countDown();
            }
        }
    }

    /**
     * 检查危化品车
     * 蒸罐
     * 汽油
     * 轮胎
     * gps
     * ...
     */
    public abstract void check();

    public CountDownLatch getCountDown() {
        return countDown;
    }
    public void setCountDown(CountDownLatch countDown) {
        this.countDown = countDown;
    }
    public String getStation() {
        return station;
    }
    public void setStation(String station) {
        this.station = station;
    }
    public boolean isOk() {
        return ok;
    }
    public void setOk(boolean ok) {
        this.ok = ok;
    }
}

StationBeijing类，该类作为一个调度站，这个类继承了DangerCenter，实现了check()方法，每个调度站都各自检查自己的车辆。代码如下：

package org.zero01.zk.countdown;

import java.util.concurrent.CountDownLatch;

public class StationBeijing extends DangerCenter {

    public StationBeijing(CountDownLatch countDown) {
        super(countDown, "北京调度站");
    }

    @Override
    public void check() {
        System.out.println("正在检查 [" + this.getStation() + "]...");

        try {
            Thread.sleep(2000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }

        System.out.println("检查 [" + this.getStation() + "] 完毕，可以发车~");
    }
}

StationShandongChangchuan和StationJiangsuSanling除了调度站名称和休眠时间外，与StationBeijing 是一样的，所以在此略过。

CheckStartUp 类，这个类是一个主启动类，它负责初始化闭锁，然后等待，直到所有调度站的车辆都被检测完成。代码如下：

package org.zero01.zk.countdown;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.Executor;
import java.util.concurrent.Executors;

public class CheckStartUp {

    private static List<DangerCenter> stationList;
    private static CountDownLatch countDown;

    public CheckStartUp() {
    }

    public static boolean checkAllStations() throws Exception {

        // 初始化3个调度站
        countDown = new CountDownLatch(3);

        // 把所有站点添加进list
        stationList = new ArrayList<DangerCenter>();
        stationList.add(new StationBeijing(countDown));
        stationList.add(new StationJiangsuSanling(countDown));
        stationList.add(new StationShandongChangchuan(countDown));

        // 使用线程池
        Executor executor = Executors.newFixedThreadPool(stationList.size());

        for (DangerCenter center : stationList) {
            executor.execute(center);
        }

        // 等待线程执行完毕
        countDown.await();

        for (DangerCenter center : stationList) {
            if (!center.isOk()) {
                return false;
            }
        }

        return true;
    }

    public static void main(String[] args) throws Exception {
        boolean result = CheckStartUp.checkAllStations();
        System.out.println("监控中心针对所有危化品调度站点的检查结果为：" + result);
    }
}

运行 CheckStartUp 类，控制台打印结果如下：

正在检查 [北京调度站]...
正在检查 [山东长川调度站]...
正在检查 [江苏三林调度站]...
检查 [山东长川调度站] 完毕，可以发车~
检查 [江苏三林调度站] 完毕，可以发车~
检查 [北京调度站] 完毕，可以发车~
监控中心针对所有危化品调度站点的检查结果为：true