前篇文章介绍的CountDownLatch可以用来倒计数,适用于一个线程等待多个线程的情况。如果要实现多个线程互相等待的效果,此时CyclicBarrier就比较合适了。
与CountDownLatch一样,CyclicBarrier也是JDK1.5位于java.util.concurrent包下的一个同步辅助类,它允许一组线程互相等待,直到到达某个公共屏障点(common barrier point),我们姑且称之为barrier(调用await方法之后该线程就处于barrier了)。又因为该barrier在释放等待线程后可以重用,所以称它为cyclic(循环)的barrier。
CyclicBarrier有两个构造器,CyclicBarrier(int parties)和CyclicBarrier(int parties, Runnable barrierAction)。参数parties是一样的,表示启动barrier前必须调用的await()的线程数;参数barrierAction表示在启动barrier时执行的命令,如果不执行任何操作,则该参数可以为null。
在CyclicBarrier的所有方法中,await是最为重要的,它有两个重载方法分别是无参的await()和带时间参数的await(long timeout, TimeUnit unit),返回值都是int类型,表示到达barrier状态的当前线程索引。await的作用是在所有参与者线程都已经在此barrier上调用await方法之前将一直等待,或者超出了指定的等待时间。
下面我们通过例子来体会CyclicBarrier的用法
问题:假设有几个许久不见老同学约了一起去“祥来酒店”吃饭,他们说好各自去酒店,然后人到齐了之后再开始点菜吃饭。
在上面的问题中,如果所有的同学没到齐,先到的只能在指定地点等待后来的,直到所有人所有到齐之后才能一起吃。其中在指定地点等待的人就相当于处于barrier状态,当所有人到齐之后barrier状态就被打破,从而继续执行后续操作。
基于上面的分析,代码如下:
package com.gk.thread.barrier;
import java.util.concurrent.CyclicBarrier;
public class Eat {
public static void main(String[] args) {
final int PARTIES = 3;
CyclicBarrier classmate = new CyclicBarrier(PARTIES);
Runnable r = new EatRunnable(classmate);
for (int i=1; i<=PARTIES; i++) {
String name = " classmate--" + i + " ";
new Thread(r, name).start();
}
}
}
package com.gk.thread.barrier;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.concurrent.BrokenBarrierException;
import java.util.concurrent.CyclicBarrier;
public class EatRunnable implements Runnable {
private CyclicBarrier cb;
public EatRunnable(CyclicBarrier cb) {
this.cb = cb;
}
@Override
public void run() {
try {
Thread.sleep((long)(Math.random() * 1000) * 60); // 模拟同学先后达到指定地点
System.out.println(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) +
Thread.currentThread().getName() +
"已经到达“祥来酒店”......");
System.out.println();
cb.await(); // 等待其他同学
} catch (InterruptedException e) {
throw new RuntimeException(e);
} catch (BrokenBarrierException e) {
throw new RuntimeException(e);
}
System.out.println(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) +
" 所有人都已经到达“祥来酒店”,可以开始点菜啦...");
System.out.println();
}
}
仔细看运行结果的时间,先到的人等待,当最后一个人到达酒店的时候再全部一起“点菜吃饭”。
好了,吃完饭最尴尬的问题就是谁买单了。为了惩罚最后一个到达的,于是他们就规定由最后一个到达的请客买单。哈哈哈...
这时候CyclicBarrier的另一个构造器CyclicBarrier(int parties, Runnable barrierAction)就派上用场了,它可以在启动barrier时执行给定的屏障操作,并且该操作是由最后一个进入barrier的线程执行的。
package com.gk.thread.barrier;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.concurrent.BrokenBarrierException;
import java.util.concurrent.CyclicBarrier;
public class Pay {
public static void main(String[] args) {
final int PARTIES = 3;
CyclicBarrier classmate = new CyclicBarrier(PARTIES, new Runnable() {
@Override
public void run() {
System.out.println("由于" + Thread.currentThread().getName() + "是最后一个到达的,所以由TA请客买单...");
}
});
for (int i=1; i<=PARTIES; i++) {
String name = " classmate--" + i + " ";
new Thread(name) {
@Override
public void run() {
/* int number;*/
try {
Thread.sleep((long)(Math.random() * 1000) * 60); // 模拟同学先后达到指定地点
System.out.println(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) +
Thread.currentThread().getName() +
"已经到达指定地点...");
System.out.println();
/*number = */classmate.await(); // 等待其他同学
} catch (InterruptedException e) {
throw new RuntimeException(e);
} catch (BrokenBarrierException e) {
throw new RuntimeException(e);
}
/*if (number == 0)
System.out.println(Thread.currentThread().getName() + "是最后一个到达的...");*/
}
}.start();
}
}
}
其实这种类似的功能也可以用await方法返回值来判断,就像上面注释的代码那样,但显然使用构造器的方式更简洁,也更易于维护。
await(long timeout, TimeUnit unit)与await()的用法是类似的,不同的只是前者可以设置时间。可以参考CountDownLatch,不过与CountDownLatch还有点小小的不同,CyclicBarrier的await(long timeout, TimeUnit unit)方法会抛出TimeoutException异常。
package com.gk.thread.barrier;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.concurrent.BrokenBarrierException;
import java.util.concurrent.CyclicBarrier;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
public class TimeDemo {
public static void main(String[] args){
CyclicBarrier cb = new CyclicBarrier(2);
new Thread() {
@Override
public void run() {
System.out.println(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) + " " +
this.getName() + "开始等待...");
try {
cb.await(2L, TimeUnit.SECONDS); // 等待2秒钟
} catch (InterruptedException e) {
throw new RuntimeException(e);
} catch (BrokenBarrierException e) {
throw new RuntimeException(e);
} catch (TimeoutException e) {
System.out.println(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) + " " +
this.getName() + "等待超时,抛出TimeoutException异常...");
}
}
}.start();
new Thread() {
@Override
public void run() {
try {
Thread.sleep(1 * 1000 * 5); // 设置休眠5秒钟
cb.await();
} catch (InterruptedException e) {
throw new RuntimeException(e);
} catch (BrokenBarrierException e) {
System.out.println();
System.out.println(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) + " " +
"另一个线程超时啦,抛出BrokenBarrierException异常...");
}
System.out.println(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) + " " +
"CyclicBarrier结束啦...");
}
}.start();
}
}
此外,CyclicBarrier的另一个重要特性是可以重用。
package com.gk.thread.barrier;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.concurrent.BrokenBarrierException;
import java.util.concurrent.CyclicBarrier;
public class CyclicDemo {
public static void main(String[] args) throws InterruptedException {
final int PARTIES = 3;
CyclicBarrier cb = new CyclicBarrier(PARTIES);
for (int i=1; i<=PARTIES; i++) {
new Cyclic(cb).start();
}
Thread.sleep(1 * 1000 * 10);
System.out.println();
System.out.println("======++++=====重用CyclicBarrier=====++++======");
System.out.println();
for (int i=1; i<=PARTIES; i++) {
new Cyclic(cb).start();
}
}
static class Cyclic extends Thread{
CyclicBarrier cb;
public Cyclic(CyclicBarrier cb) {
this.cb = cb;
}
@Override
public void run() {
int number;
try {
Thread.sleep((long)(Math.random() * 1000) * 5);
System.out.println(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) + " --> " +
Thread.currentThread().getName());
System.out.println();
number = cb.await();
} catch (InterruptedException e) {
throw new RuntimeException(e);
}
catch (BrokenBarrierException e) {
throw new RuntimeException(e);
}
if (number == 0) {
System.out.println(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) +
" 当前CyclicBarrier结束啦...");
}
}
}
}
上面问题的描述只是现实生活中一个形象的比喻。在实际的编程中,比如进行IO操作时,如果要求多个IO操作完之后再进行后续操作的,就可以使用CyclicBarrier来解决了,当然还有很多。