并发工具类

简介

在JDK的并发包里提供了几个非常有用的并发工具类。

• 提供并发流程控制的工具类

  • CountDownLatch
  • CyclicBarrier
  • Semaphore

• 提供了在线程间交换数据的工具类

  • Exchanger

本文会配合一些应用场景来介绍如何使用这些工具类。

---

等待多线程完成的CountDownLatch

CountDownLatch 允许一个或多个线程等待其他线程完成操作。

假如有这样一个需求：我们需要解析一个Excel里多个sheet的数据，此时可以考虑使用多线程，每个线程解析一个sheet里的数据，等到所有的sheet都解析完之后，程序需要提示解析完成。在这个需求中，要实现主线程等待所有线程完成sheet的解析操作，最简单的做法是使用join()方法，如下：

 

public static class JoinCountDownLatchTest {
    public static void main(String[] args) throws InterruptedException {
        Thread parser1 = new Thread(new Runnable() {
            @Override
            public void run() {
                System.out.println("parser1 finish");
            }
        });
        Thread parser2 = new Thread(new Runnable() {
            @Override
            public void run() {
                System.out.println("parser2 finish");
            }
        });
        parser1.start();
        parser2.start();
        parser1.join();
        parser2.join();
        System.out.println("all parser finish");
    }
}

输出结果：

 

parser1 finish
parser2 finish
all parser finish

关于join的介绍

join 用于让当前执行线程等待join线程执行结束。其实现原理是不停检查join线程是否存活，
如果 join 线程存活则让当前线程永远等待。其中，wait(0)表示永远等待下去。代码片段如下：

 

while (isAlive()) {
    wait(0);
}

直到 join 线程中止后，线程的 this.notifyAll() 方法会被调用，调用 notifyAll() 方法是在 JVM 里实现的，所以在JDK 里看不到，大家可以查看JVM源码。

在JDK 1.5之后的并发包中提供的 CountDownLatch 也可以实现 join 的功能，并且比join的功能更多，示例如下：

 

public static class CountDownLatchTest {
    static CountDownLatch c = new CountDownLatch(3);

    public static void main(String[] args) throws InterruptedException {
        new Thread(new Runnable() {
            @Override
            public void run() {
                System.out.println(1 + " -- " + System.currentTimeMillis());
                c.countDown();
                System.out.println(2 + " -- " + System.currentTimeMillis());
                c.countDown();
                try {
                    Thread.sleep(1000);
                    System.out.println(4 + " -- " + System.currentTimeMillis());
                    c.countDown();
                    Thread.sleep(1000);
                    System.out.println(5 + " -- " + System.currentTimeMillis());
                    c.countDown();
                    System.out.println(6 + " -- " + System.currentTimeMillis());
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
            }
        }).start();
        c.await();
        System.out.println("3" + " -- " + System.currentTimeMillis());
    }
}

输出结果

 

1 -- 1558966154351
2 -- 1558966154351
4 -- 1558966155352
3 -- 1558966155352
5 -- 1558966156353
6 -- 1558966156353

CountDownLatch 的构造函数接收一个int 类型的参数作为计数器，如果你想等待N个点完成，这里就传入N。
当我们调用 CountDownLatch 的 countDown 方法时，N 就会 -1，CountDownLatch 的 await 方法会阻塞当前线程，直到 N 变成零。
由于 countDown 方法可以用在任何地方，所以这里说的 N 个点，可以是 N个线程，也可以是 1个线程里的N个执行步骤。
用在多个线程时，只需要把这个 CountDownLatch 的引用传递到线程里即可。
如果有某个解析 sheet 的线程处理得比较慢，我们不可能让主线程一直等待，所以可以使用另外一个带指定时间的 await 方法—— await(long time，TimeUnit unit)，这个方法等待特定时间后，就会不再阻塞当前线程。
join 也有类似的方法。

计数器必须大于等于0，只是等于0时候，计数器就是零，调用await方法时不会阻塞当前线程。
CountDownLatch不可能重新初始化或者修改CountDownLatch对象的内部计数器的值。
一个线程调用countDown方法happen-before另外一个线程调用await方法。

---

同步屏障CyclicBarrier

CyclicBarrier的字面意思是可循环使用（Cyclic）的屏障（Barrier）。
它要做的事情是，让一组线程到达一个屏障（也可以叫同步点）时被阻塞，直到最后一个线程到达屏障时，屏障才会开门，所有被屏障拦截的线程才会继续运行。

CyclicBarrier 默认的构造方法是 CyclicBarrier(int parties)，其参数表示 屏障拦截的线程数量，每个线程调用 await 方法告诉 CyclicBarrier 我已经到达了屏障，然后当前线程被阻塞。

代码示例：

 

public static class CyclicBarrierTest {
    private static CyclicBarrier c = new CyclicBarrier(2);

    public static void main(String[] args) {
        System.out.println(" 1 -- " + System.currentTimeMillis());
        new Thread(new Runnable() {
            @Override
            public void run() {
                try {
                    System.out.println(" 2 -- " + System.currentTimeMillis());
                    Thread.sleep(1000);
                    System.out.println(" 3 -- " + System.currentTimeMillis());
                    c.await();
                    System.out.println(" 4 -- " + System.currentTimeMillis());
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        }).start();

        try {
            System.out.println(" 5 -- " + System.currentTimeMillis());
            c.await();
            System.out.println(" 6 -- " + System.currentTimeMillis());
        } catch (Exception e) {
            e.printStackTrace();
        }
        System.out.println(" 7 -- " + System.currentTimeMillis());
    }
}

输出结果：

 

 1 -- 1558969130471
 5 -- 1558969130471
 2 -- 1558969130471
 3 -- 1558969131471
 4 -- 1558969131471
 6 -- 1558969131471
 7 -- 1558969131471

如果把 new CyclicBarrier(2) 修改成 new CyclicBarrier(3)，则主线程和子线程会永远等待，因为没有第三个线程执行await方法，即 没有第三个线程到达屏障，所以之前到达屏障的两个线程都不会继续执行。

CyclicBarrier 还提供一个更高级的构造函数CyclicBarrier(int parties，Runnable barrierAction)，用于在线程到达屏障时，优先执行barrierAction，方便处理更复杂的业务场景。

示例如下：

 

public static class CyclicBarrierTest2 {
    static CyclicBarrier c = new CyclicBarrier(2, new A());

    public static void main(String[] args) {
        new Thread(new Runnable() {
            @Override
            public void run() {
                try {
                    c.await();
                } catch (Exception e) {
                }
                System.out.println(1);
            }
        }).start();
        try {
            c.await();
        } catch (Exception e) {
        }
        System.out.println(2);
    }

    static class A implements Runnable {
        @Override
        public void run() {
            System.out.println(3);
        }
    }
}

因为 CyclicBarrier 设置了拦截线程的数量是 2 ，所以必须等代码中的 第一个线程 和 线程A 都执行完之后，才会继续执行 主线程，然后输出 2，所以代码执行后的输出如下：

 

3
1
2

---

CyclicBarrier的应用场景

CyclicBarrier 可以用于多线程计算数据，最后合并计算结果的场景。
例如，用一个Excel保存了用户所有银行流水，每个Sheet保存一个账户近一年的每笔银行流水，现在需要统计用户的日均银行流水，先用多线程处理每个sheet里的银行流水，都执行完之后，得到每个sheet的日均银行流水，最后，再用 CyclicBarrier(int parties, Runnable barrierAction) 中的 barrierAction 用这些线程的计算结果，计算出整个Excel的日均银行流水，代码如下：

 

public static class BankWaterService {
    /**
     * 创建4个屏障，处理完之后执行当前类的run方法
     */
    private CyclicBarrier c = new CyclicBarrier(4, new MyRunnable());
    /**
     * 假设只有4个sheet，所以只启动4个线程
     */
    private Executor executor = Executors.newFixedThreadPool(4);
    /**
     * 保存每个sheet计算出的银流结果
     */
    private ConcurrentHashMap<String, Integer> sheetBankWaterCount = new ConcurrentHashMap<>();

    public static void main(String[] args) {
        BankWaterService bankWaterCount = new BankWaterService();
        bankWaterCount.count();
    }

    private void count() {
        for (int i = 0; i < 4; i++) {
            executor.execute(new Runnable() {
                @Override
                public void run() {
                    // 计算当前sheet的银流数据，计算代码省略
                    sheetBankWaterCount.put(Thread.currentThread().getName(), 1);
                    // 银流计算完成，插入一个屏障
                    try {
                        c.await();
                    } catch (InterruptedException | BrokenBarrierException e) {
                        e.printStackTrace();
                    }
                }
            });
        }
    }

    class MyRunnable implements Runnable {

        @Override
        public void run() {
            int result = 0;
            // 汇总每个sheet计算出的结果
            for (Map.Entry<String, Integer> sheet : sheetBankWaterCount.entrySet()) {
                result += sheet.getValue();
            }
            // 将结果输出
            sheetBankWaterCount.put("result", result);
            System.out.println("result = " + result);
        }
    }
}

使用线程池创建4个线程，分别计算每个sheet里的数据，每个sheet计算结果是1，再由BankWaterService 线程汇总4个sheet计算出的结果输出结果：

 

result = 4

---

CyclicBarrier和CountDownLatch的区别

CountDownLatch的计数器只能使用一次，而CyclicBarrier的计数器可以使用reset()方法重置。
所以CyclicBarrier能处理更为复杂的业务场景。
例如，如果计算发生错误，可以重置计数器，并让线程重新执行一次。

CyclicBarrier还提供其他有用的方法，比如：

• getNumberWaiting方法可以获得CyclicBarrier阻塞的线程数量。
• isBroken()方法用来了解阻塞的线程是否被中断。

上面的银行流水例子执行完之后会返回true。

以下是 isBroken的使用代码示例：

 

public static class CyclicBarrierTest3 {
    static CyclicBarrier c = new CyclicBarrier(2);

    public static void main(String[] args) {
        Thread thread = new Thread(new Runnable() {
            @Override
            public void run() {
                try {
                    c.await();
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        });
        thread.start();
        thread.interrupt();
        try {
            c.await();
        } catch (Exception e) {
            System.out.println(c.isBroken());
        }
    }
}

输出结果：

 

true

控制并发线程数的Semaphore

Semaphore（信号量）是用来控制同时访问特定资源的线程数量，它通过协调各个线程，以保证合理的使用公共资源。

多年以来，我都觉得从字面上很难理解Semaphore所表达的含义，只能把它比作是控制流量的红绿灯。比如××马路要限制流量，只允许同时有一百辆车在这条路上行使，其他的都必须在路口等待，所以前一百辆车会看到绿灯，可以开进这条马路，后面的车会看到红灯，不能驶入××马路，但是如果前一百辆中有5辆车已经离开了××马路，那么后面就允许有5辆车驶入马路，这个例子里说的车就是线程，驶入马路就表示线程在执行，离开马路就表示线程执行完成，看见红灯就表示线程被阻塞，不能执行。

• 应用场景
  Semaphore可以用于做流量控制，特别是公用资源有限的应用场景，比如数据库连接。
  假如有一个需求，要读取几万个文件的数据，因为都是IO密集型任务，我们可以启动几十个线程并发地读取，但是如果读到内存后，还需要存储到数据库中，而数据库的连接数只有10个，这时我们必须控制只有10个线程同时获取数据库连接保存数据，否则会报错无法获取数据库连接。
  这个时候，就可以使用Semaphore来做流量控制，代码如下：

  public static class SemaphoreTest {
      private static final int THREAD_COUNT = 20;
      private static ExecutorService threadPool = Executors.newFixedThreadPool(THREAD_COUNT);
      private static Semaphore s = new Semaphore(5);
  
      public static void main(String[] args) {
          for (int i = 0; i < THREAD_COUNT; i++) {
              threadPool.execute(new MyRunnable(i));
          }
          threadPool.shutdown();
      }
  
      private static class MyRunnable implements Runnable {
  
          private int index;
  
          MyRunnable(int index) {
              this.index = index;
          }
  
          @Override
          public void run() {
              try {
                  s.acquire();
                  System.out.println("save data -- " + index);
                  s.release();
              } catch (InterruptedException e) {
                  e.printStackTrace();
              }
  
          }
      }
  }
  

  输出结果：

  save data -- 0
  save data -- 4
  save data -- 3
  save data -- 1
  save data -- 2
  save data -- 6
  save data -- 5
  save data -- 7
  save data -- 9
  save data -- 10
  save data -- 8
  save data -- 11
  save data -- 12
  save data -- 13
  save data -- 14
  save data -- 15
  save data -- 16
  save data -- 17
  save data -- 18
  save data -- 19
  

  在代码中，虽然有20个线程在执行，但是只允许5个并发执行。Semaphore的构造方法Semaphore(int permits)接受一个整型的数字，表示可用的许可证数量。Semaphore(5)表示允许5个线程获取许可证，也就是最大并发数是5。
  Semaphore的用法也很简单，首先线程使用Semaphore的acquire()方法获取一个许可证，使用完之后调用release()方法归还许可证。
  还可以用tryAcquire()方法尝试获取许可证。

• 其他方法

  • int availablePermits()：返回此信号量中当前可用的许可证数。
  • int getQueueLength()：返回正在等待获取许可证的线程数。
  • boolean hasQueuedThreads()：是否有线程正在等待获取许可证。
  • void reducePermits(int reduction)：减少 reduction个许可证，是个protected方法。
  • Collection<Thread> getQueuedThreads()：返回所有等待获取许可证的线程集合，是个protected方法。

线程间交换数据的Exchanger

Exchanger（交换者）是一个用于线程间协作的工具类。
Exchanger用于进行线程间的数据交换。它提供一个同步点，在这个同步点，两个线程可以交换彼此的数据。这两个线程通过exchange方法交换数据，如果第一个线程先执行exchange()方法，它会一直等待第二个线程也执行exchange()方法，当两个线程都到达同步点时，这两个线程就可以交换数据，将本线程生产出来的数据传递给对方。

下面来看一下Exchanger的应用场景。

Exchanger可以用于 遗传算法。
遗传算法 里需要选出两个人作为交配对象，这时候会交换两人的数据，并使用交叉规则得出2个交配结果。

Exchanger 也可以用于校对工作。
比如我们需要将纸制银行流水通过人工的方式录入成电子银行流水，为了避免错误，采用AB岗两人进行录入，录入到Excel之后，系统需要加载这两个Excel，并对两个Excel数据进行校对，看看是否录入一致。

示例代码如下：

 

public static class ExchangerTest {
    private static final Exchanger<String> exgr = new Exchanger<String>();
    private static ExecutorService threadPool = Executors.newFixedThreadPool(2);

    public static void main(String[] args) {
        threadPool.execute(new Runnable() {
            @Override
            public void run() {
                try {
                    // A录入银行流水数据
                    String A = "银行流水A";
                    exgr.exchange(A);
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
            }
        });
        threadPool.execute(new Runnable() {
            @Override
            public void run() {
                try {
                    // B录入银行流水数据
                    String B = "银行流水B";
                    String A = exgr.exchange("B");
                    System.out.println("A和B数据是否一致：" + A.equals(B)
                            + ", A录入的是：" + A + ", B录入是：" + B);
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
            }
        });
        threadPool.shutdown();
    }
}

输出结果：

 

A和B数据是否一致：false, A录入的是：银行流水A, B录入是：银行流水B

如果两个线程有一个没有执行exchange()方法，则会一直等待，如果担心有特殊情况发生，避免一直等待，可以使用exchange(V x, long timeout, TimeUnit unit)设置最大等待时长。

小结

本文配合一些应用场景介绍JDK中提供的几个并发工具类，大家记住这个工具类的用途，一旦有对应的业务场景，不妨试试这些工具类。

• 等待多线程完成的CountDownLatch
• 同步屏障CyclicBarrier
• 控制并发线程数的Semaphore
• 线程间交换数据的Exchanger

链接：https://www.jianshu.com/p/79d9baaa396e