关于CountDownLatch的使用

在项目使用多线程实现功能时, 需要将多个线程结果整理返回,而CountDownLatch正好解决该场景问题

1 CountDownLatch的简介

CountDownLatch是Jdk1.5版本引入的, 主要作用是让一个线程,等待其他线程完成某种操作之后,该线程继续执行.

其内部实现, 是通过一个计数器统计, 计数器的初始值是线程的数量, 每当一个线程执行完毕后, 计数器的值就减一, 当计数器的值为0时, 当前等待的线程就继续正常向下执行了.

CountDownLatch源代码

/**
 *
 * @since 1.5
 * @author Doug Lea
 */
public class CountDownLatch {
    // 内部类
    private final Sync sync;
    
    // 构造 需要传入计数器,需要等待的线程数
    public CountDownLatch(int count) {
        if (count < 0) throw new IllegalArgumentException("count < 0");
        this.sync = new Sync(count);
    }
    
    
    // 等待方法 让当前线程等待 当计数器为0,等待的线程才会继续执行
    public void await() throws InterruptedException {
        sync.acquireSharedInterruptibly(1);
    }
    
    // 计数器进行减1 
    public void countDown() {
        sync.releaseShared(1);
    }
        
    // 等待指定的时间后,count没为0, 继续向下执行   
    public boolean await(long timeout, TimeUnit unit)
        throws InterruptedException {
        return sync.tryAcquireSharedNanos(1, unit.toNanos(timeout));
    }
    
}

从代码可知CountDownLatch中属性是其内部维护的内部类Sync , 而Sync是继承了AbstractQueuedSynchronizer抽象类,其中tryReleaseShared方法就是对state值进行减一操作(CountDownLatch的countDown), 在抽象类中state字段为volatile属性,程序可以保证state字段的可见性, 使用CAS方法,对state进行了设置,通过二者,保证了state字段的原子性操作.

    private static final class Sync extends AbstractQueuedSynchronizer {
        private static final long serialVersionUID = 4982264981922014374L;

        Sync(int count) {
            setState(count);
        }

        int getCount() {
            return getState();
        }

        protected int tryAcquireShared(int acquires) {
            return (getState() == 0) ? 1 : -1;
        }

        protected boolean tryReleaseShared(int releases) {
            // Decrement count; signal when transition to zero
            for (;;) {
                // 获取当前state值
                int c = getState();
                // state值为0, 说明计数器已经减为0, 直接返回
                if (c == 0)
                    return false;
                int nextc = c-1;
                // 使用CAS算法对state设置
                if (compareAndSetState(c, nextc))
                    return nextc == 0;
            }
        }
    }

其中调用顺序为

// CountDownLatch类
public void countDown() {
        sync.releaseShared(1);
    }

	// AbstractQueuedSynchronizer类
    public final boolean releaseShared(int arg) {
        if (tryReleaseShared(arg)) {
            // 唤醒调用了await()方法的线程,多个线程睡眠,则都唤醒
            doReleaseShared();
            return true;
        }
        return false;
    }

	// AbstractQueuedSynchronizer类
	// 唤醒调用了await方法的线程
    private void doReleaseShared() {
        for (;;) {
            Node h = head;
            if (h != null && h != tail) {
                int ws = h.waitStatus;
                if (ws == Node.SIGNAL) {
                    if (!compareAndSetWaitStatus(h, Node.SIGNAL, 0))
                        continue;            // loop to recheck cases
                    unparkSuccessor(h);
                }
                else if (ws == 0 &&
                         !compareAndSetWaitStatus(h, 0, Node.PROPAGATE))
                    continue;                // loop on failed CAS
            }
            if (h == head)                   // loop if head changed
                break;
        }
    }

	// CountDownLatch内部类Sync 
protected boolean tryReleaseShared(int releases) {
            // Decrement count; signal when transition to zero
            for (;;) {
                // 获取当前state值
                int c = getState();
                // state值为0, 说明计数器已经减为0, 直接返回
                if (c == 0)
                    return false;
                int nextc = c-1;
                // 使用CAS算法对state设置
                if (compareAndSetState(c, nextc))
                    return nextc == 0;
            }
        }

2 CountDownLatch的使用

案列1

创建两个线程类, 让a线程等b线程走完再走

MyThread1线程类

public class MyThread1 extends Thread {
    private CountDownLatch latch;
    public MyThread1(CountDownLatch latch){
        this.latch = latch;
    }
    @Override
    public void run() {
        System.out.println("MyThread1线程开始了");
        try {
            // 让当前线程等待,执行其他线程
            latch.await();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        System.out.println("MyThread1结束了....");
    }
}

MyThread2线程类

public class MyThread2 extends Thread {
    private CountDownLatch latch;

    public MyThread2(CountDownLatch latch) {
        this.latch = latch;
    }

    @Override
    public void run() {
        System.out.println("MyThread2 线程开始了");
        // 让latch的计数器减少1
        latch.countDown();
        System.out.println("MyThread2 结束了....");
    }
}

测试类

public class CountDownLatchDemo {
    public static void main(String[] args) throws InterruptedException {
        // 创建一个CountDownLatch, 设置计数器为1 
        CountDownLatch latch = new CountDownLatch(1);
        // 创建两个线程
        Thread t1 = new MyThread1(latch);

        Thread t2 = new MyThread2(latch);

        t1.start();
		
        // 主线程睡眠
        Thread.sleep(5000);
        t2.start();
    }
}

运行结果为

/*
    MyThread1线程开始了
    MyThread2 线程开始了
    MyThread2 结束了....
    MyThread1结束了....
*/

案列2

public class CountDemo implements Runnable {

    private CountDownLatch countDownLatch;

    public CountDemo(CountDownLatch countDownLatch) {
        this.countDownLatch = countDownLatch;
    }

    @Override
    public void run() {
        
        // 计数器减一
        countDownLatch.countDown();
        System.out.println("当前还剩余线程的数量为" + (countDownLatch.getCount()));

    }
}

测试类

public class CountDownLatchDemo {
    
        public static void main(String[] args) {
        ExecutorService executorService = Executors.newCachedThreadPool();
        CountDownLatch countDownLatch = new CountDownLatch(10);
        for (int i = 0; i < 10; i++) {
            CountDemo countDemo = new CountDemo(countDownLatch);
            executorService.execute(countDemo);
        }
    }
    
}

运行结果:

/*
    当前还剩余线程的数量为9
    当前还剩余线程的数量为8
    当前还剩余线程的数量为7
    当前还剩余线程的数量为6
    当前还剩余线程的数量为5
    当前还剩余线程的数量为4
    当前还剩余线程的数量为3
    当前还剩余线程的数量为2
    当前还剩余线程的数量为1
    当前还剩余线程的数量为0
*/