Java多線程同步工具箱之CountDownLatch篇

Java多線程同步工具箱之CountDownLatch篇

前言

Java的多線程協調工具CountDownLatch，Semaphore，CyclicBarrier，ReadWriteLock都是在多線程代碼中使用比較多的工具類之一。掌握及理解這幾個類的實現，對解決和理解多線程中複雜的業務情況有很重要的做用。絕不誇張的說，這幾個類，是等同於解決多線程問的java.util包，實在有必要添加到程序員的工具箱裏面。

這次文章，將分幾篇總結及解讀一下這些工具類的具體用法和範例，最後，但願能夠再深刻一點去理解這幾個多線程工具的實現。

1. CountDownLatch（倒數鎖）

CountDownLatch是一個經常使用的多線程協調工具：主要爲協調一個或多個線程完成後，主線程進行某個操做的功能。

Latch原指門閂，CountDownLatch譯爲倒數鎖卻是不太過度。能夠理解爲：使用主線程初始化一個有N個子鎖的鎖，任務開始的時，分配給N個線程每一個線程持有一把鑰匙，每一個線程到某個狀態後（通常爲完成），可使用線程持有的鑰匙打開主線程持有的鎖，直至全部N個鎖都被打開，主線程才能夠繼續其餘任務。

1.1 API

從API上看咱們能夠關注下面幾個CountDownLatch提供了幾個接口：

1. 構造方法CountDownLatch(int)

構造方法十分簡單，注入一個int，初始化倒數鎖的大小。

1. await()

等待全部鎖被解開，該函數還有一個帶等待時長及等待時間單位的重寫await(long time, TimeUnit unit)，用於避免過分的等待形成的死鎖。

1. countDown()

解鎖方法，解開一個鎖，知道持有的鎖數量爲0，則接觸await的狀態。

1. getCount()

獲取當前的剩餘的鎖的數量。

1.2 範例

在範例中，咱們簡單的使用一個主線程，發起若干個子線程，讓子線程進行休眠的例子做爲測試倒數，讓各個子線程導數完通知解鎖，主線程會被在全部子線程完成解鎖後通知全部任務完成。

1.2.1 使用倒數鎖前

App.java

import java.util.concurrent.CountDownLatch;
import java.util.logging.Logger;

public class App {

    static Logger log = Logger.getAnonymousLogger();

    public static void main(String[] args) {
        
        for (int index = 0; index < 10; index++) {
            new Thread(new SubThread(index, index)).start();
        }

        // 全部的線程都完成了
        log.info("all thread finished");
    }

}

SubThread.java

import java.util.concurrent.CountDownLatch;
import java.util.logging.Logger;

public class SubThread implements Runnable {

    private int id;
    private int waitSecond;

    static Logger log = Logger.getAnonymousLogger();

    public SubThread(int id, int waitSecond) {
        this.id = id;
        // 秒數*1000毫秒 = 實際等待毫秒數
        this.waitSecond = waitSecond * 1000;
    }

    public void run() {
        try {
            log.info("Thread " + id + " started.");
            // 讓Thread再飛一下子
            Thread.sleep(waitSecond);

            log.info("Thread " + id + " end.");
            // 通知完成
        } catch (InterruptedException e) {
            log.config("error");
        }
    }

}

運行結果

能夠從結果中看到，全部的線程啓動後，主線程就會馬上退出，子線程會在完成各自的任務後再退出。

Aug 09, 2018 6:43:22 PM online.tangbk.demo.thead.SubThread run
INFO: Thread 3 started.

...
...

Aug 09, 2018 6:43:22 PM online.tangbk.demo.thead.App main
INFO: all thread finished
Aug 09, 2018 6:43:22 PM online.tangbk.demo.thead.SubThread run
INFO: Thread 8 started.

...
...

Aug 09, 2018 6:43:31 PM online.tangbk.demo.thead.SubThread run
INFO: Thread 9 end.

1.2.2 使用倒數鎖後

App.java

import java.util.concurrent.CountDownLatch;
import java.util.logging.Logger;

public class App {

    static Logger log = Logger.getAnonymousLogger();

    public static void main(String[] args) {

        // 初始化10個線程的鎖
        CountDownLatch cdl = new CountDownLatch(10);

        for (int index = 0; index < 10; index++) {
            // 將鎖傳給子線程
            new Thread(new SubThread(index, index, cdl)).start();
        }

        try {
            // 等待全部的鎖被（倒數）釋放
            cdl.await();
        } catch (InterruptedException e) {

            e.printStackTrace();
        }
        // 全部的線程都完成了
        log.info("all thread finished");
    }

}

SubThread.java

import java.util.concurrent.CountDownLatch;
import java.util.logging.Logger;

public class SubThread implements Runnable {

    private int id;
    private int waitSecond;
    private CountDownLatch cdl;

    static Logger log = Logger.getAnonymousLogger();

    public SubThread(int id, int waitSecond, CountDownLatch cdl) {
        this.id = id;
        // 秒數*1000毫秒 = 實際等待毫秒數
        this.waitSecond = waitSecond * 1000;
        this.cdl = cdl;
    }

    public void run() {
        try {
            log.info("Thread " + id + " started.");
            // 讓Thread再飛一下子
            Thread.sleep(waitSecond);

            cdl.countDown();
            log.info("Thread " + id + " end.");
            // 通知完成
        } catch (InterruptedException e) {
            log.config("error");
        }
    }

}

運行結果

能夠從結果中看到，全部的線程啓動後，都會等到全部線程完成等待後才結束。

Aug 09, 2018 6:29:20 PM online.tangbk.demo.thead.SubThread run
INFO: Thread 2 started.
Aug 09, 2018 6:29:20 PM online.tangbk.demo.thead.SubThread run
INFO: Thread 3 started.
Aug 09, 2018 6:29:20 PM online.tangbk.demo.thead.SubThread run
INFO: Thread 1 started.
Aug 09, 2018 6:29:20 PM online.tangbk.demo.thead.SubThread run
INFO: Thread 0 started.

...
...

Aug 09, 2018 6:29:28 PM online.tangbk.demo.thead.SubThread run
INFO: Thread 8 end.
Aug 09, 2018 6:29:29 PM online.tangbk.demo.thead.SubThread run
INFO: Thread 9 end.
Aug 09, 2018 6:29:29 PM online.tangbk.demo.thead.App main
INFO: all thread finished

1.3 CountDownLatch小結

CountDownLatch（倒數鎖）適用於須要等待子線程完成後，統一進行操做的一些操做。更能夠結合FutureTask的相關接口，取回子線程的結果，對結果統一搜集處理。