【JDK】JDK源码分析-CountDownLatch

概述

CountDownLatch 是并发包中的一个工具类，它的典型应用场景为：一个线程等待几个线程执行，待这几个线程结束后，该线程再继续执行。

简单起见，可以把它理解为一个倒数的计数器：初始值为线程数，每个线程结束时执行减 1 操作，当计数器减到 0 时等待的线程再继续执行。

代码分析

CountDownLatch 的类签名和主要方法如下：

public class CountDownLatch {}

常用方法为：await()、await(long, TimeUnit) 和 countDown。其中两个 await 都是让当前线程进入等待状态（获取资源失败）；而 countDown 方法是将计数器减去 1，当计数器为 0 的时候，那些处于等待状态的线程会继续执行（获取资源成功）。

构造器代码如下：

private final Sync sync;

public CountDownLatch(int count) {
    if (count < 0) throw new IllegalArgumentException("count < 0");
    this.sync = new Sync(count);
}

构造器（该构造器是唯一的）传入一个正整数，且初始化了 sync 变量，Sync 是内部的一个嵌套类，继承自 AQS。

await / await(long, TimeUnit)：

public void await() throws InterruptedException {
    sync.acquireSharedInterruptibly(1);
}

public boolean await(long timeout, TimeUnit unit)
    throws InterruptedException {
    return sync.tryAcquireSharedNanos(1, unit.toNanos(timeout));
}

countDown:

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

其中，acquireSharedInterruptibly、tryAcquireSharedNanos 和 releaseShared 都是 AQS 中「共享模式」的方法，具体代码可参考前文「JDK源码分析-AbstractQueuedSynchronizer(3)」的分析。

嵌套类 Sync 代码如下：

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

    // 构造器，初始化 AQS 的 state 变量
    Sync(int count) {
        setState(count);
    }

    int getCount() {
        return getState();
    }

    // 尝试获取资源的操作
    // 只有当 state 变量为 0 的时候才能获取成功（返回 1）
    protected int tryAcquireShared(int acquires) {
        return (getState() == 0) ? 1 : -1;
    }

    // 尝试释放资源的操作
    protected boolean tryReleaseShared(int releases) {
        // Decrement count; signal when transition to zero
        for (;;) {
            int c = getState();
            if (c == 0)
                return false;
            // 该操作就是尝试把 state 变量减去 1
            int nextc = c-1;
            if (compareAndSetState(c, nextc))
                return nextc == 0;
        }
    }
}

Sync 继承了 AQS 抽象类，根据 AQS 可知，acquireSharedInterruptibly 和 tryAcquireSharedNanos 方法的实现都调用了 tryAcquireShared。

流程说明：通常先把 CountDownLatch 的计数器（state）初始化为 N，执行 wait 操作就是尝试以共享模式获取资源，而每次 countDown 操作就是将 N 减去 1，只有当 N 减到 0 的时候，才能获取成功（tryAcquireShared 方法），然后继续执行。

场景举例

为便于理解该类的用法，举两个简单的例子来说明它的使用场景。

场景 1：一个线程等待多个线程执行完之后再继续执行

public void test() throws InterruptedException {
    int count = 5;
    // CountDownLatch 的初始化计数器为 5
    // 注意线程数和计数器保持一致
    CountDownLatch countDownLatch = new CountDownLatch(count);
    for (int i = 0; i < count; i++) {
        int finalI = i;
        new Thread(() -> {
            try {
                TimeUnit.SECONDS.sleep(finalI);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
            System.out.println(Thread.currentThread().getName() + " is working ..");
            // 每个线程执行结束时执行 countDown
            countDownLatch.countDown();
        }).start();
    }
    // 主线程进入等待状态（尝试获取资源，成功后才能继续执行）
    countDownLatch.await();
    System.out.println(Thread.currentThread().getName() + " go on ..");
}

/*  输出结果：
    Thread-0 is working ..
    Thread-1 is working ..
    Thread-2 is working ..
    Thread-3 is working ..
    Thread-4 is working ..
    main go on ..
*/

场景 2：一个线程到达指定条件后，通知另一个线程

private static volatile List<Integer> list = new ArrayList<>();

private static void test() {
  CountDownLatch countDownLatch = new CountDownLatch(1);

  new Thread(() -> {
    if (list.size() != 5) {
      try {
        // list 的大小为 5 时再继续执行，否则等待
        // 等待 state 减到 0
        countDownLatch.await();
      } catch (InterruptedException e) {
        e.printStackTrace();
      }
    }
    System.out.println(Thread.currentThread().getName() + " start..");
  }).start();

  new Thread(() -> {
    for (int i = 0; i < 10; i++) {
      list.add(i);
      System.out.println(Thread.currentThread().getName() + " add " + i);
      if (list.size() == 5) {
        // 满足条件时将 state 减 1
        countDownLatch.countDown();
      }
      try {
        TimeUnit.SECONDS.sleep(1);
      } catch (InterruptedException e) {
        e.printStackTrace();
      }
    }
  }).start();
}

/*  输出结果：
    Thread-1 add 0
    Thread-1 add 1
    Thread-1 add 2
    Thread-1 add 3
    Thread-1 add 4
    Thread-0 start..
    Thread-1 add 5
    Thread-1 add 6
    Thread-1 add 7
    Thread-1 add 8
    Thread-1 add 9
*/

小结

CountDownLatch 可以理解为一个倒数的计数器，它的典型应用场景就是一个线程等待几个线程执行结束后再继续执行。其内部是基于 AQS 的共享模式实现的。

相关阅读：

JDK源码分析-AbstractQueuedSynchronizer(3)

Stay hungry, stay foolish.

PS: 本文首发于微信公众号【WriteOnRead】。

原文地址：https://www.cnblogs.com/jaxer/p/11317908.html

时间： 2024-08-04 21:08:36

【JDK】JDK源码分析-CountDownLatch的相关文章

【JDK源码分析】深入源码分析CountDownLatch

前言 CountDownLatch是一个闭锁实现,它可以使一个或者多个线程等待一组事件发生.它包含一个计数器,用来表示需要等待的事件数量,coutDown方法用于表示一个事件发生,计数器随之递减,而await方法等待计数器为0之前一直阻塞.它是基于AQS的共享锁来实现的,其中使用了较多的AQS的方法,所以在这之前最好阅读过AQS的源码,不嫌弃也可以查看本人之前AQS的源码分析,有些AQS方法没有在之前分析过的这里涉及到了会进行分析. 源码 我们先看它的属性和构造器, // Sync为其内部类 p

jdk源码分析总览

今天看到了一个源码分析按照重要性排序的例子, 这里拿过来用了,之后按照这个顺序不断的完善源码的内容. 引用的出处忘记了(对作者说声抱歉) 很多java开发的小伙伴都会阅读jdk源码,然而确不知道应该从哪读起.以下为小编整理的通常所需阅读的源码范围. 标题为包名,后面序号为优先级1-4,优先级递减 1.java.lang 1) Object 12) String 13) AbstractStringBuilder 14) StringBuffer 15) StringBuilder 16) Boo

JDK源码分析之concurrent包（三） -- Future方式的实现

上一篇我们基于JDK的源码对线程池ThreadPoolExecutor的实现做了分析,本篇来对Executor框架中另一种典型用法Future方式做源码解读.我们知道Future方式实现了带有返回值的程序的异步调用,关于异步调用的场景大家可以自行脑补Ajax的应用(获取返回结果的方式不同,Future是主动询问获取,Ajax是回调函数),这里不做过多说明. 在进入源码前,首先来看下Future方式相关的API: 接口Callable:有返回结果并且可能抛出异常的任务: 接口Future:表示异步

JDK源码分析—— ArrayBlockingQueue 和 LinkedBlockingQueue

目的:本文通过分析JDK源码来对比ArrayBlockingQueue 和LinkedBlockingQueue,以便日后灵活使用. 1. 在Java的Concurrent包中,添加了阻塞队列BlockingQueue,用于多线程编程.BlockingQueue的核心方法有: boolean add(E e) ,把 e 添加到BlockingQueue里.如果BlockingQueue可以容纳,则返回true,否则抛出异常. boolean offer(E e),表示如果可能的话,将 e 加到B

JDK源码分析之String篇

------------------------------String在内存中的存储情况(一下内容摘自参考资料1)----------------------------------- 前提:先了解下什么是声明,什么时候才算是产生了对象实例 其中x并未看到内存分配,变量在使用前必须先声明,再赋值,然后才可以使用.java基础数据类型会用对应的默认值进行初始化 一.首先看看Java虚拟机JVM的内存块及其变量.对象内存空间是怎么存储分配的 1.栈:存放基本数据类型及对象变量的引用,对象本身不存放

JDK中String类的源码分析(二)

1.startsWith(String prefix, int toffset)方法 包括startsWith(*),endsWith(*)方法,都是调用上述一个方法 1 public boolean startsWith(String prefix, int toffset) { 2 char ta[] = value; 3 int to = toffset; 4 char pa[] = prefix.value; 5 int po = 0; 6 int pc = prefix.value.l

【JDK源码分析】通过源码分析CyclicBarrier

前言 CyclicBarrier它是什么?一个同步辅助类,它允许一组线程互相等待,直到到达某个公共屏障点.类似于朋友之间联系要在中午聚个会,几个朋友全部到齐后才开始喝酒吃菜. 源码 CyclicBarrier属性和构造器 public class CyclicBarrier { // 互斥锁 private final ReentrantLock lock = new ReentrantLock(); // 条件等待 private final Condition trip = lock.new

【源码阅读系列】JDK 8 ConcurrentHashMap 源码分析之 由transfer引发的bug

不阅读源码就不会发现这个事儿 前段时间在阅读ConcurrentHashMap源码,版本JDK 8,目前源码研究已经告一段落.感谢鲁道的ConcurrentHashMap源码分析文章,读到文章,感觉和作者发生了一些交流,解答了很多疑惑,也验证了一些想法.鲁道在简书的addCount分析文章点这里 (文章底部的评论中就有这篇文章发酵的原由).鲁道还有其他ConcurrentHashMap源码分析的系列文章,在简书.掘金都有分布,感兴趣的同学可以进一步追踪. 推完文章,回到本篇的主题"阅读源码&qu

JDK源码阅读（一）：Object源码分析

最近经过某大佬的建议准备阅读一下JDK的源码来提升一下自己 所以开始写JDK源码分析的文章 阅读JDK版本为1.8 目录 Object结构图 构造器 equals 方法 getClass 方法 hashCode 方法 toString 方法 finalize 方法 registerNatives 方法 1. Object结构图 2. 类构造器 ??类构造器是创建Java对象的方法之一.一般我们都使用new关键字来进行实例,还可以在构造器中进行相应的初始化操作. ??在一个Java类中必须存在一个