09-J.U.C之并发工具类：CountDownLatch

清疚 2021-08-29 13:25 233阅读 0赞

### CountDownLatch ###

*  1. 简介
 *  2. 实现分析
 *   *  2.1 await()
     *  2.2 countDown()
 *  3. 总结
 *  4. 应用示例

# 1. 简介 #

`CountDownLatch`与`CyclicBarrier`有点儿相似。

`CyclicBarrier`所描述的是“允许一组线程互相等待，直到到达某个公共屏障点，才会进行后续任务"，而`CountDownLatch`所描述的是”在完成一组正在其他线程中执行的操作之前，它允许一个或多个线程一直等待“。

在`API`中是这样描述的：

用给定的计数初始化 `CountDownLatch`。由于调用了 `countDown()` 方法，所以在当前计数到达零之前，`await` 方法会一直受阻塞。之后，会释放所有等待的线程，`await` 的所有后续调用都将立即返回。

这种现象只出现一次——计数无法被重置。如果需要重置计数，请考虑使用 `CyclicBarrier`。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdfemhhb18_size_16_color_FFFFFF_t_70]  
      `CountDownLatch`是通过一个计数器来实现的，当我们在`new` 一个`CountDownLatch`对象的时候需要带入该计数器值，该值就表示了线程的数量。每当一个线程完成自己的任务后，计数器的值就会减`1`。当计数器的值变为`0`时，就表示所有的线程均已经完成了任务，然后就可以恢复等待的线程继续执行了。

# 2. 实现分析 #

![在这里插入图片描述][20200604003541515.png]

通过上图我们可以看到，`CountDownLatch`内部依赖`Sync`实现，而`Sync`继承`AQS`。

`CountDownLatch`仅提供了一个构造方法：`CountDownLatch(int count)` ： 构造一个用给定计数初始化的`CountDownLatch`。

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

`sync`为`CountDownLatch`的一个内部类，其定义如下：

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) { 
            for (;;) { 
                int c = getState();
                if (c == 0)
                    return false;
                int nextc = c-1;
                if (compareAndSetState(c, nextc))
                    return nextc == 0;
            }
        }
    }

通过这个内部类`Sync`我们可以清楚地看到`CountDownLatch`是采用共享锁来实现的。

## 2.1 await() ##

`CountDownLatch`提供`await()`方法来使当前线程在锁存器倒计数至零之前一直等待，除非线程被中断，定义如下：

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

`await`其内部使用`AQS`的`acquireSharedInterruptibly(int arg)`：

public final void acquireSharedInterruptibly(int arg)
        throws InterruptedException { 
        if (Thread.interrupted())
            throw new InterruptedException();
        // 查看当前计数器的值是否为0，为0则直接返回，否则进入AQS的队列等待
        if (tryAcquireShared(arg) < 0)
            doAcquireSharedInterruptibly(arg);
    }

在内部类`Sync`中重写了`tryAcquireShared(int arg)`方法：

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

`getState()`获取同步状态，其值等于计数器的值，从这里我们可以看到如果计数器值不等于`0`，则会调用`doAcquireSharedInterruptibly(int arg)`，该方法为一个自旋方法会尝试一直去获取同步状态：

private void doAcquireSharedInterruptibly(int arg)
        throws InterruptedException { 
        final Node node = addWaiter(Node.SHARED);
        boolean failed = true;
        try { 
            for (;;) { 
                final Node p = node.predecessor();
                if (p == head) { 
                    /** * 对于CountDownLatch而言，如果计数器值不等于0，那么r 会一直小于0 */
                    int r = tryAcquireShared(arg);
                    if (r >= 0) { 
                        setHeadAndPropagate(node, r);
                        p.next = null; // help GC
                        failed = false;
                        return;
                    }
                }
                //等待
                if (shouldParkAfterFailedAcquire(p, node) &&
                    parkAndCheckInterrupt())
                    throw new InterruptedException();
            }
        } finally { 
            if (failed)
                cancelAcquire(node);
        }
    }

## 2.2 countDown() ##

`CountDownLatch`提供`countDown()`方法递减锁存器的计数，如果计数到达零，则释放所有等待的线程。

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

内部调用`AQS`的`releaseShared(int arg)`方法来释放共享锁同步状态：

public final boolean releaseShared(int arg) { 
    	    if (tryReleaseShared(arg)) { 
    	        doReleaseShared();
    	        return true;
    	    }
    	    return false;
    	}

`tryReleaseShared(int arg)`方法被`CountDownLatch`的内部类`Sync`重写：

protected boolean tryReleaseShared(int releases) { 
        for (;;) { 
            //获取锁状态
            int c = getState();
            //c == 0 直接返回，释放锁成功
            if (c == 0)
                return false;
            //计算新“锁计数器”
            int nextc = c-1;
            //更新锁状态（计数器）
            if (compareAndSetState(c, nextc))
                return nextc == 0;
        }
    }

如果 `tryReleaseShared` 方法返回 `true`，说明是最后一个线程调用的`countdown`方法，那么该线程除了让计数器值减`1`之外，还需要唤醒因调用 `CountdownLatch` 的 `await` 方法而被阻塞的线程。

# 3. 总结 #

`CountDownLatch`内部通过共享锁实现。在创建`CountDownLatch`实例时，需要传递一个`int`型的参数：`count`，该参数为计数器的初始值，也可以理解为该共享锁可以获取的总次数。

当某个线程调用`await()`方法，程序首先判断`count`的值是否为`0`，如果不为`0`的话则会一直等待直到为`0`为止。当其他线程调用`countDown()`方法时，则执行释放共享锁状态，使`count`值`-1`。

当在创建`CountDownLatch`时初始化的`count`参数，必须要有`count`线程调用`countDown`方法才会使计数器`coun`t等于0，锁才会释放，前面等待的线程才会继续运行。注意`CountDownLatch`不能回滚重置。

# 4. 应用示例 #

public class CountDownLatchTest { 
        private static CountDownLatch countDownLatch = new CountDownLatch(5);
    
        /** * Boss线程，等待员工到达开会 */
        static class BossThread extends Thread{ 
            @Override
            public void run() { 
                System.out.println("Boss在会议室等待，总共有" + countDownLatch.getCount() + "个人开会...");
                try { 
                    //Boss等待
                    countDownLatch.await();
                } catch (InterruptedException e) { 
                    e.printStackTrace();
                }
    
                System.out.println("所有人都已经到齐了，开会吧...");
            }
        }
    
        //员工到达会议室
        static class EmpleoyeeThread  extends Thread{ 
            @Override
            public void run() { 
                System.out.println(Thread.currentThread().getName() + "，到达会议室....");
                //员工到达会议室 count - 1
                countDownLatch.countDown();
            }
        }
    
        public static void main(String[] args){ 
            //Boss线程启动
            new BossThread().start();
    
            for(int i = 0,j = countDownLatch.getCount() ; i < j ; i++){ 
                new EmpleoyeeThread().start();
            }
        }
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdfemhhb18_size_16_color_FFFFFF_t_70 1]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdfemhhb18_size_16_color_FFFFFF_t_70]: /images/20210813/d0700b508e514d7d81c1a7679e0e2adf.png
[20200604003541515.png]: /images/20210813/3766801aae85468ab1bbc247c1e8cfc2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdfemhhb18_size_16_color_FFFFFF_t_70 1]: /images/20210813/272efe12f0524507b40e49a0aaf25022.png