CountDownLatch的原理及使用

CountDownLatch是一个同步工具栏，它的主要作用是：使一个或多个线程一直等待，直到其它线程的操作执行完后再执行。

CountDownLatch概念和原理

CountDownLatch是java1.5被引入的，跟他一起被引入的并发工具类还有CyclicBarrier、Semaphore、ConcurrentHashMap和BlocklingQueue，都在concurrent包下。CountDownLatch这个类可以使一个线程等待其他线程完成各自的工作后再执行。比如，主程序启动框架的时候确保其他的框架服务已经启动了。

CountDownLatch是通过一个计数器来实现的，计数器的初始值为线程的数量。每当完成一个线程完成的任务后，计数器的值减1.当计数器的值为0的时候，表示所有的线程都已经完成了任务，然后在闭锁上等待的线程就可以恢复执行任务。如图：

CountDownLatch的伪代码如下：

 

//主线程启动
//为N个线程创建CountDownLatch
//创建并启动N个线程
//主线程在latch（闭锁）上等待
//N个线程完成工作并返回
//主线程恢复执行

CountDownLatch如何工作

jdk源码中CountDownLatch定义的构造函数：

//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()方法，恢复执行自己的任务。

实时系统中的使用场景

1.实现最大的并行性：有时我们想同时启动多个线程，实现最大程度的并行性。例如，我们想测试一个单例类。如果我们创建一个初始计数为1的CountDownLatch，并让所有线程都在这个锁上等待，那么我们可以很轻松地完成测试。我们只需调用 一次countDown()方法就可以让所有的等待线程同时恢复执行。
2.开始执行前等待n个线程完成各自任务：例如应用程序启动类要确保在处理用户请求前，所有N个外部系统已经启动和运行了。
3.死锁检测：一个非常方便的使用场景是，你可以使用n个线程访问共享资源，在每次测试阶段的线程数目是不同的，并尝试产生死锁。

CountDownLatch例子

本例中模拟一个程序启动类，它开始时启动了n个线程类，这些线程将检查外部系统并通知闭锁，并且启动类一直在闭锁上等待着。一旦验证和检查了所有外部服务，那么启动类恢复执行。

BaseHealthChecker.java：这个类是一个Runnable，负责所有特定的外部服务健康的检测。它删除了重复的代码和闭锁的中心控制代码。

package com.countdownlatch;

import java.util.concurrent.CountDownLatch;

public abstract class BaseHealthChecker implements Runnable {

    
    private CountDownLatch _latch;
    private String _serviceName;
    private boolean _serviceUp;
    
    //Get latch object in constructor so that after completing the task, 
    //thread can countDown() the latch
    
    public BaseHealthChecker(String serviceName, CountDownLatch latch){
        super();
        this._latch = latch;
        this._serviceName = serviceName;
        this._serviceUp = false;
    }
    
    @Override
    public void run() {
        try {
            verifyService();
            _serviceUp = true;
        } catch (Throwable t){
            _serviceUp = false;
        }finally {
             if(_latch != null) {
                _latch.countDown();
             }
        }
    }
    
    public String getServiceName() {
        return _serviceName;
    }
 
    public boolean isServiceUp() {
        return _serviceUp;
    }
    //This methos needs to be implemented by all specific service checker
    public abstract void verifyService();
}

NetworkHealthChecker.java：这个类继承了BaseHealthChecker，实现了verifyService()方法。DatabaseHealthChecker.java和CacheHealthChecker.java除了服务名和休眠时间外，与NetworkHealthChecker.java是一样的。

package com.countdownlatch;

import java.util.concurrent.CountDownLatch;

public class NetworkHealthChecker extends BaseHealthChecker{

    public NetworkHealthChecker(CountDownLatch latch) {
         super("Network Service", latch);
    }

    @Override
    public void verifyService() {
        System.out.println("Checking " + this.getServiceName());
        try{
            Thread.sleep(7000);
        }
        catch (InterruptedException e){
            e.printStackTrace();
        }
        System.out.println(this.getServiceName() + " is UP");
    }
    
    

}

ApplicationStartupUtil.java：这个类是一个主启动类，它负责初始化闭锁，然后等待，直到所有服务都被检测完。

package com.countdownlatch;

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 ApplicationStartupUtil {

    //List of service checkers
    private static List<BaseHealthChecker> _services;
    
  //This latch will be used to wait on
    private static CountDownLatch _latch;
    
    private ApplicationStartupUtil(){}
    
    private final static ApplicationStartupUtil INSTANCE = new ApplicationStartupUtil();
    
    public static ApplicationStartupUtil getInstance(){
        return INSTANCE;
    }
     
    public static boolean checkExternalServices() throws Exception{
        //Initialize the latch with number of service checkers
        _latch = new CountDownLatch(2);
         
        //All add checker in lists
        _services = new ArrayList<BaseHealthChecker>();
        _services.add(new NetworkHealthChecker(_latch));
        _services.add(new CacheHealthChecker(_latch));
        _services.add(new DatabaseHealthChecker(_latch));
         
        //Start service checkers using executor framework
        //这种线程池执行线程，程序不会结束
        Executor executor = Executors.newFixedThreadPool(_services.size());
         
        for(final BaseHealthChecker v : _services){
            executor.execute(v);
        }
         
        //Now wait till all services are checked
        _latch.await();
         
        //Services are file and now proceed startup
        for(final BaseHealthChecker v : _services){
            if( ! v.isServiceUp()){
                return false;
            }
        }
        return true;
    }
    
    
    public static void main(String[] args) {
        boolean result = false;
        try {
            result = ApplicationStartupUtil.checkExternalServices();
        } catch (Exception e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        System.out.println("External services validation completed !! Result was :: "+ result);
    }
}

打印结果：