CountDownLatch

  

2010-09-30 15:11:22|  分类： |字号 订阅

 

 

java.util.concurrent.CountDownLatch它是一个同步辅助类，在完成一组正在其他线程中执行的操作之前，它允许一个或多个线程一直等待。
用给定的计数初始化 CountDownLatch。在调用countDown() 方法，使当前计数减一，且当前计数到达零之前，await 方法会一直受阻塞。当前计数到达零之后，会释放所有等待的线程，await 的所有后续调用都将立即返回。这种现象只出现一次——计数无法被重置。
如果需要重置计数，请考虑使用 CyclicBarrier。
CountDownLatch 是一个通用同步工具，它有很多用途。将计数 1 初始化的 CountDownLatch 用作一个简单的开/关锁存器，或入口：在通过调用 countDown() 的线程打开入口前，所有调用 await 的线程都一直在入口处等待。
用 N 初始化的 CountDownLatch 可以使一个线程在 N 个线程完成某项操作之前一直等待，或者使其在某项操作完成 N 次之前一直等待。
CountDownLatch的一个有用特性是，它不要求调用 countDown 方法的线程等到计数到达零时才继续，调用countDown 方法的线程并不会阻塞。CountDownLatch调用await方法将阻塞当前线程，直到其他线程调用countDown 方法，使其计数到达零时才继续。 
CountDownLatch主要有以下三种用法
  用法1:将计数1初始化的 CountDownLatch 用作一个简单的开/关锁存器，或入口：
在通过调用 countDown() 的线程打开入口前，所有调用 await 的线程都一直在入口处等待。
  用法2：用N初始化的 CountDownLatch 可以使一个线程在 N 个线程完成某项操作之前一直等待，或者使其在某项操作完成 N 次之前一直等待。
  用法3:它不要求调用 countDown 方法的线程等到计数到达零时才继续，而在所有线程都能通过之前，它只是阻止任何线程继续通过一个await。
注意2：用法3其实对用法1和用法2的混合使用。它的实质是一个线程来阻止其他线程通过（用法1），
        但是该线程要完成N个操作（用法2），才让其他线程通过。
注意3:理解的CountDownLatch含义，可以灵活的使用它，而不用拘于上述三种形式。 
注意4:计数无法被重置。如果需要重置计数，请考虑使用 CyclicBarrier。

示例1
  startSignal是一个启动信号，在 driver 为继续执行 worker 做好准备之前，它会阻止所有的 worker 继续执行。
  doneSignal是一个完成信号，它允许 driver 在完成所有 worker 之前一直等待。

 classDriver{// ...
   void main()throwsInterruptedException{
     CountDownLatch startSignal =newCountDownLatch(1);
     CountDownLatch doneSignal =newCountDownLatch(N);

     for(int i =0; i < N;++i)// create and start threads
       newThread(newWorker(startSignal, doneSignal)).start();

     doSomethingElse();            // don't let run yet
     startSignal.countDown();      // let all threads proceed
     doSomethingElse();
     doneSignal.await();           // wait for all to finish
   }
 }

 classWorkerimplementsRunnable{
   privatefinalCountDownLatch startSignal;
   privatefinalCountDownLatch doneSignal;
   Worker(CountDownLatch startSignal,CountDownLatch doneSignal){
      this.startSignal = startSignal;
      this.doneSignal = doneSignal;
   }
   publicvoid run(){
      try{
        startSignal.await();
        doWork();
        doneSignal.countDown();
      }catch(InterruptedException ex){}// return;
   }

   void doWork(){...}
 }

 

另一种典型用法是，将一个问题分成N个部分，用执行每个部分并让锁存器倒计数的Runnable来描述每个部分，
然后将所有 Runnable 加入到 Executor 队列。当所有的子部分完成后，协调线程就能够通过 await。
（当线程必须用这种方法反复倒计数时，可改为使用 CyclicBarrier。）

 classDriver2{// ...
   void main()throwsInterruptedException{
     CountDownLatch doneSignal =newCountDownLatch(N);
     Executor e =...

     for(int i =0; i < N;++i)// create and start threads
       e.execute(newWorkerRunnable(doneSignal, i));

     doneSignal.await();           // wait for all to finish
   }
 }

 classWorkerRunnableimplementsRunnable{
   privatefinalCountDownLatch doneSignal;
   privatefinalint i;
   WorkerRunnable(CountDownLatch doneSignal,int i){
      this.doneSignal = doneSignal;
      this.i = i;
   }
   publicvoid run(){
      try{
        doWork(i);
        doneSignal.countDown();
      }catch(InterruptedException ex){}// return;
   }

   void doWork(){...}
 }

内存一致性效果：线程中调用 countDown() 之前的操作 happen-before 紧跟在从另一个线程中对应 await() 成功返回的操作。
主要函数
public CountDownLatch(int count)
    构造一个用给定计数初始化的 CountDownLatch。
    参数：
        count - 在线程能通过 await() 之前，必须调用 countDown() 的次数 
    抛出：
        IllegalArgumentException - 如果 count 为负
public void await()
           throws InterruptedException
    使当前线程在锁存器倒计数至零之前一直等待，除非线程被中断。
    如果当前计数为零，则此方法立即返回。
    如果当前计数大于零，则出于线程调度目的，将禁用当前线程，且在发生以下两种情况之一前，该线程将一直处于休眠状态：
        * 由于调用 countDown() 方法，计数到达零；或者
        * 其他某个线程中断当前线程。 
    如果当前线程：
        * 在进入此方法时已经设置了该线程的中断状态；或者
        * 在等待时被中断， 
    则抛出 InterruptedException，并且清除当前线程的已中断状态。
    抛出：
        InterruptedException - 如果当前线程在等待时被中断
注意：它会抛出InterruptedException，关于Interrupted，请参阅《JAVA线程的interrupt》

public boolean await(long timeout,TimeUnit unit) throws InterruptedException
    使当前线程在锁存器倒计数至零之前一直等待，除非线程被中断或超出了指定的等待时间。
    如果当前计数为零，则此方法立刻返回 true 值。
    如果当前计数大于零，则出于线程调度目的，将禁用当前线程，且在发生以下三种情况之一前，该线程将一直处于休眠状态：
        * 由于调用 countDown() 方法，计数到达零；或者
        * 其他某个线程中断当前线程；或者
        * 已超出指定的等待时间。 
    如果计数到达零，则该方法返回 true 值。
    如果当前线程：
        * 在进入此方法时已经设置了该线程的中断状态；或者
        * 在等待时被中断， 
    则抛出 InterruptedException，并且清除当前线程的已中断状态。
    如果超出了指定的等待时间，则返回值为 false。如果该时间小于等于零，则此方法根本不会等待。
    参数：
        timeout - 要等待的最长时间
        unit - timeout 参数的时间单位。 
    返回：
        如果计数到达零，则返回 true；如果在计数到达零之前超过了等待时间，则返回 false 
    抛出：
        InterruptedException - 如果当前线程在等待时被中断
public void countDown()
    递减锁存器的计数，如果计数到达零，则释放所有等待的线程。
    如果当前计数大于零，则将计数减少。如果新的计数为零，出于线程调度目的，将重新启用所有的等待线程。
    如果当前计数等于零，则不发生任何操作。 
public long getCount()
    返回当前计数。
    此方法通常用于调试和测试。
    返回：
        当前计数