java高併發系列 - 第24天：ThreadLocal、InheritableThreadLocal（通俗易懂）

路人甲Java發表於2019-08-13

Javathread

java高併發系列第24篇文章。

環境：jdk1.8。

本文內容

需要解決的問題
介紹ThreadLocal
介紹InheritableThreadLocal

需要解決的問題

我們還是以解決問題的方式來引出ThreadLocal、InheritableThreadLocal，這樣印象會深刻一些。

目前java開發web系統一般有3層，controller、service、dao，請求到達controller，controller呼叫service，service呼叫dao，然後進行處理。

我們寫一個簡單的例子，有3個方法分別模擬controller、service、dao。程式碼如下：

package com.itsoku.chat24;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.LinkedBlockingDeque;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * 跟著阿里p7學併發，微信公眾號：javacode2018
 */
public class Demo1 {

    static AtomicInteger threadIndex = new AtomicInteger(1);
    //建立處理請求的執行緒池子
    static ThreadPoolExecutor disposeRequestExecutor = new ThreadPoolExecutor(3,
            3,
            60,
            TimeUnit.SECONDS,
            new LinkedBlockingDeque<>(),
            r -> {
                Thread thread = new Thread(r);
                thread.setName("disposeRequestThread-" + threadIndex.getAndIncrement());
                return thread;
            });

    //記錄日誌
    public static void log(String msg) {
        StackTraceElement stack[] = (new Throwable()).getStackTrace();
        System.out.println("****" + System.currentTimeMillis() + ",[執行緒:" + Thread.currentThread().getName() + "]," + stack[1] + ":" + msg);
    }

    //模擬controller
    public static void controller(List<String> dataList) {
        log("接受請求");
        service(dataList);
    }

    //模擬service
    public static void service(List<String> dataList) {
        log("執行業務");
        dao(dataList);
    }

    //模擬dao
    public static void dao(List<String> dataList) {
        log("執行資料庫操作");
        //模擬插入資料
        for (String s : dataList) {
            log("插入資料" + s + "成功");
        }
    }

    public static void main(String[] args) {
        //需要插入的資料
        List<String> dataList = new ArrayList<>();
        for (int i = 0; i < 3; i++) {
            dataList.add("資料" + i);
        }

        //模擬5個請求
        int requestCount = 5;
        for (int i = 0; i < requestCount; i++) {
            disposeRequestExecutor.execute(() -> {
                controller(dataList);
            });
        }

        disposeRequestExecutor.shutdown();
    }
}

執行結果：

****1565338891286,[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo1.controller(Demo1.java:36):接受請求
****1565338891286,[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo1.controller(Demo1.java:36):接受請求
****1565338891287,[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo1.service(Demo1.java:42):執行業務
****1565338891287,[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo1.service(Demo1.java:42):執行業務
****1565338891287,[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo1.controller(Demo1.java:36):接受請求
****1565338891287,[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo1.dao(Demo1.java:48):執行資料庫操作
****1565338891287,[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo1.dao(Demo1.java:51):插入資料資料0成功
****1565338891287,[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo1.dao(Demo1.java:51):插入資料資料1成功
****1565338891287,[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo1.dao(Demo1.java:48):執行資料庫操作
****1565338891287,[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo1.dao(Demo1.java:51):插入資料資料2成功
****1565338891287,[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo1.service(Demo1.java:42):執行業務
****1565338891288,[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo1.controller(Demo1.java:36):接受請求
****1565338891287,[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo1.dao(Demo1.java:51):插入資料資料0成功
****1565338891288,[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo1.service(Demo1.java:42):執行業務
****1565338891288,[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo1.dao(Demo1.java:48):執行資料庫操作
****1565338891288,[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo1.dao(Demo1.java:48):執行資料庫操作
****1565338891288,[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo1.dao(Demo1.java:51):插入資料資料1成功
****1565338891288,[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo1.dao(Demo1.java:51):插入資料資料0成功
****1565338891288,[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo1.dao(Demo1.java:51):插入資料資料0成功
****1565338891288,[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo1.dao(Demo1.java:51):插入資料資料1成功
****1565338891288,[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo1.dao(Demo1.java:51):插入資料資料2成功
****1565338891288,[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo1.dao(Demo1.java:51):插入資料資料2成功
****1565338891288,[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo1.dao(Demo1.java:51):插入資料資料1成功
****1565338891288,[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo1.controller(Demo1.java:36):接受請求
****1565338891288,[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo1.dao(Demo1.java:51):插入資料資料2成功
****1565338891288,[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo1.service(Demo1.java:42):執行業務
****1565338891289,[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo1.dao(Demo1.java:48):執行資料庫操作
****1565338891289,[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo1.dao(Demo1.java:51):插入資料資料0成功
****1565338891289,[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo1.dao(Demo1.java:51):插入資料資料1成功
****1565338891289,[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo1.dao(Demo1.java:51):插入資料資料2成功

程式碼中呼叫controller、service、dao 3個方法時，來模擬處理一個請求。main方法中迴圈了5次模擬發起5次請求，然後交給執行緒池去處理請求，dao中模擬迴圈插入傳入的dataList資料。

問題來了：開發者想看一下哪些地方耗時比較多，想通過日誌來分析耗時情況，想追蹤某個請求的完整日誌，怎麼搞？

上面的請求採用執行緒池的方式處理的，多個請求可能會被一個執行緒處理，通過日誌很難看出那些日誌是同一個請求，我們能不能給請求加一個唯一標誌，日誌中輸出這個唯一標誌，當然可以。

如果我們的程式碼就只有上面示例這麼簡單，我想還是很容易的，上面就3個方法，給每個方法加個traceId引數，log方法也加個traceId引數，就解決了，程式碼如下：

package com.itsoku.chat24;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.LinkedBlockingDeque;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * 跟著阿里p7學併發，微信公眾號：javacode2018
 */
public class Demo2 {

    static AtomicInteger threadIndex = new AtomicInteger(1);
    //建立處理請求的執行緒池子
    static ThreadPoolExecutor disposeRequestExecutor = new ThreadPoolExecutor(3,
            3,
            60,
            TimeUnit.SECONDS,
            new LinkedBlockingDeque<>(),
            r -> {
                Thread thread = new Thread(r);
                thread.setName("disposeRequestThread-" + threadIndex.getAndIncrement());
                return thread;
            });

    //記錄日誌
    public static void log(String msg, String traceId) {
        StackTraceElement stack[] = (new Throwable()).getStackTrace();
        System.out.println("****" + System.currentTimeMillis() + "[traceId:" + traceId + "],[執行緒:" + Thread.currentThread().getName() + "]," + stack[1] + ":" + msg);
    }

    //模擬controller
    public static void controller(List<String> dataList, String traceId) {
        log("接受請求", traceId);
        service(dataList, traceId);
    }

    //模擬service
    public static void service(List<String> dataList, String traceId) {
        log("執行業務", traceId);
        dao(dataList, traceId);
    }

    //模擬dao
    public static void dao(List<String> dataList, String traceId) {
        log("執行資料庫操作", traceId);
        //模擬插入資料
        for (String s : dataList) {
            log("插入資料" + s + "成功", traceId);
        }
    }

    public static void main(String[] args) {
        //需要插入的資料
        List<String> dataList = new ArrayList<>();
        for (int i = 0; i < 3; i++) {
            dataList.add("資料" + i);
        }

        //模擬5個請求
        int requestCount = 5;
        for (int i = 0; i < requestCount; i++) {
            String traceId = String.valueOf(i);
            disposeRequestExecutor.execute(() -> {
                controller(dataList, traceId);
            });
        }

        disposeRequestExecutor.shutdown();
    }
}

輸出：

****1565339559773[traceId:0],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo2.controller(Demo2.java:36):接受請求
****1565339559773[traceId:1],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo2.controller(Demo2.java:36):接受請求
****1565339559773[traceId:2],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo2.controller(Demo2.java:36):接受請求
****1565339559774[traceId:1],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo2.service(Demo2.java:42):執行業務
****1565339559774[traceId:0],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo2.service(Demo2.java:42):執行業務
****1565339559774[traceId:1],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo2.dao(Demo2.java:48):執行資料庫操作
****1565339559774[traceId:2],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo2.service(Demo2.java:42):執行業務
****1565339559774[traceId:1],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo2.dao(Demo2.java:51):插入資料資料0成功
****1565339559774[traceId:0],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo2.dao(Demo2.java:48):執行資料庫操作
****1565339559774[traceId:1],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo2.dao(Demo2.java:51):插入資料資料1成功
****1565339559774[traceId:2],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo2.dao(Demo2.java:48):執行資料庫操作
****1565339559774[traceId:1],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo2.dao(Demo2.java:51):插入資料資料2成功
****1565339559774[traceId:0],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo2.dao(Demo2.java:51):插入資料資料0成功
****1565339559775[traceId:3],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo2.controller(Demo2.java:36):接受請求
****1565339559775[traceId:2],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo2.dao(Demo2.java:51):插入資料資料0成功
****1565339559775[traceId:3],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo2.service(Demo2.java:42):執行業務
****1565339559775[traceId:0],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo2.dao(Demo2.java:51):插入資料資料1成功
****1565339559775[traceId:3],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo2.dao(Demo2.java:48):執行資料庫操作
****1565339559775[traceId:2],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo2.dao(Demo2.java:51):插入資料資料1成功
****1565339559775[traceId:3],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo2.dao(Demo2.java:51):插入資料資料0成功
****1565339559775[traceId:0],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo2.dao(Demo2.java:51):插入資料資料2成功
****1565339559775[traceId:3],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo2.dao(Demo2.java:51):插入資料資料1成功
****1565339559775[traceId:2],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo2.dao(Demo2.java:51):插入資料資料2成功
****1565339559775[traceId:3],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo2.dao(Demo2.java:51):插入資料資料2成功
****1565339559775[traceId:4],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo2.controller(Demo2.java:36):接受請求
****1565339559776[traceId:4],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo2.service(Demo2.java:42):執行業務
****1565339559776[traceId:4],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo2.dao(Demo2.java:48):執行資料庫操作
****1565339559776[traceId:4],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo2.dao(Demo2.java:51):插入資料資料0成功
****1565339559776[traceId:4],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo2.dao(Demo2.java:51):插入資料資料1成功
****1565339559776[traceId:4],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo2.dao(Demo2.java:51):插入資料資料2成功

上面我們通過修改程式碼的方式，把問題解決了，但前提是你們的系統都像上面這麼簡單，功能很少，需要改的程式碼很少，可以這麼去改。但事與願違，我們的系統一般功能都是比較多的，如果我們都一個個去改，豈不是要瘋掉，改程式碼還涉及到重新測試，風險也不可控。那有什麼好辦法麼？

ThreadLocal

還是拿上面的問題，我們來分析一下，每個請求都是由一個執行緒處理的，執行緒就相當於一個人一樣，每個請求相當於一個任務，任務來了，人來處理，處理完畢之後，再處理下一個請求任務。人身上是不是有很多口袋，人剛開始準備處理任務的時候，我們把任務的編號放在處理者的口袋中，然後處理中一路攜帶者，處理過程中如果需要用到這個編號，直接從口袋中獲取就可以了。那麼剛好java中執行緒設計的時候也考慮到了這些問題，Thread物件中就有很多口袋，用來放東西。Thread類中有這麼一個變數：

ThreadLocal.ThreadLocalMap threadLocals = null;

這個就是用來操作Thread中所有口袋的東西，ThreadLocalMap原始碼中有一個陣列（有興趣的可以去看一下原始碼），對應處理者身上很多口袋一樣，陣列中的每個元素對應一個口袋。

如何來操作Thread中的這些口袋呢，java為我們提供了一個類ThreadLocal，ThreadLocal物件用來操作Thread中的某一個口袋，可以向這個口袋中放東西、獲取裡面的東西、清除裡面的東西，這個口袋一次性只能放一個東西，重複放東西會將裡面已經存在的東西覆蓋掉。

常用的3個方法：

//向Thread中某個口袋中放東西
public void set(T value);
//獲取這個口袋中目前放的東西
public T get();
//清空這個口袋中放的東西
public void remove()

我們使用ThreadLocal來改造一下上面的程式碼，如下：

package com.itsoku.chat24;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.LinkedBlockingDeque;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * 跟著阿里p7學併發，微信公眾號：javacode2018
 */
public class Demo3 {

    //建立一個操作Thread中存放請求任務追蹤id口袋的物件
    static ThreadLocal<String> traceIdKD = new ThreadLocal<>();

    static AtomicInteger threadIndex = new AtomicInteger(1);
    //建立處理請求的執行緒池子
    static ThreadPoolExecutor disposeRequestExecutor = new ThreadPoolExecutor(3,
            3,
            60,
            TimeUnit.SECONDS,
            new LinkedBlockingDeque<>(),
            r -> {
                Thread thread = new Thread(r);
                thread.setName("disposeRequestThread-" + threadIndex.getAndIncrement());
                return thread;
            });

    //記錄日誌
    public static void log(String msg) {
        StackTraceElement stack[] = (new Throwable()).getStackTrace();
        //獲取當前執行緒存放tranceId口袋中的內容
        String traceId = traceIdKD.get();
        System.out.println("****" + System.currentTimeMillis() + "[traceId:" + traceId + "],[執行緒:" + Thread.currentThread().getName() + "]," + stack[1] + ":" + msg);
    }

    //模擬controller
    public static void controller(List<String> dataList) {
        log("接受請求");
        service(dataList);
    }

    //模擬service
    public static void service(List<String> dataList) {
        log("執行業務");
        dao(dataList);
    }

    //模擬dao
    public static void dao(List<String> dataList) {
        log("執行資料庫操作");
        //模擬插入資料
        for (String s : dataList) {
            log("插入資料" + s + "成功");
        }
    }

    public static void main(String[] args) {
        //需要插入的資料
        List<String> dataList = new ArrayList<>();
        for (int i = 0; i < 3; i++) {
            dataList.add("資料" + i);
        }

        //模擬5個請求
        int requestCount = 5;
        for (int i = 0; i < requestCount; i++) {
            String traceId = String.valueOf(i);
            disposeRequestExecutor.execute(() -> {
                //把traceId放入口袋中
                traceIdKD.set(traceId);
                try {
                    controller(dataList);
                } finally {
                    //將tranceId從口袋中移除
                    traceIdKD.remove();
                }
            });
        }

        disposeRequestExecutor.shutdown();
    }
}

輸出：

****1565339644214[traceId:1],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo3.controller(Demo3.java:41):接受請求
****1565339644214[traceId:2],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo3.controller(Demo3.java:41):接受請求
****1565339644214[traceId:0],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo3.controller(Demo3.java:41):接受請求
****1565339644214[traceId:2],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo3.service(Demo3.java:47):執行業務
****1565339644214[traceId:1],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo3.service(Demo3.java:47):執行業務
****1565339644214[traceId:2],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo3.dao(Demo3.java:53):執行資料庫操作
****1565339644214[traceId:0],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo3.service(Demo3.java:47):執行業務
****1565339644214[traceId:2],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo3.dao(Demo3.java:56):插入資料資料0成功
****1565339644214[traceId:0],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo3.dao(Demo3.java:53):執行資料庫操作
****1565339644214[traceId:1],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo3.dao(Demo3.java:53):執行資料庫操作
****1565339644215[traceId:0],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo3.dao(Demo3.java:56):插入資料資料0成功
****1565339644215[traceId:2],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo3.dao(Demo3.java:56):插入資料資料1成功
****1565339644215[traceId:0],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo3.dao(Demo3.java:56):插入資料資料1成功
****1565339644215[traceId:1],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo3.dao(Demo3.java:56):插入資料資料0成功
****1565339644215[traceId:0],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo3.dao(Demo3.java:56):插入資料資料2成功
****1565339644215[traceId:2],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo3.dao(Demo3.java:56):插入資料資料2成功
****1565339644215[traceId:1],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo3.dao(Demo3.java:56):插入資料資料1成功
****1565339644215[traceId:4],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo3.controller(Demo3.java:41):接受請求
****1565339644215[traceId:3],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo3.controller(Demo3.java:41):接受請求
****1565339644215[traceId:4],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo3.service(Demo3.java:47):執行業務
****1565339644215[traceId:1],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo3.dao(Demo3.java:56):插入資料資料2成功
****1565339644215[traceId:4],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo3.dao(Demo3.java:53):執行資料庫操作
****1565339644215[traceId:3],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo3.service(Demo3.java:47):執行業務
****1565339644215[traceId:4],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo3.dao(Demo3.java:56):插入資料資料0成功
****1565339644215[traceId:3],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo3.dao(Demo3.java:53):執行資料庫操作
****1565339644215[traceId:4],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo3.dao(Demo3.java:56):插入資料資料1成功
****1565339644215[traceId:3],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo3.dao(Demo3.java:56):插入資料資料0成功
****1565339644215[traceId:4],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo3.dao(Demo3.java:56):插入資料資料2成功
****1565339644215[traceId:3],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo3.dao(Demo3.java:56):插入資料資料1成功
****1565339644215[traceId:3],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo3.dao(Demo3.java:56):插入資料資料2成功

可以看出輸出和剛才使用traceId引數的方式結果一致，但是卻簡單了很多。不用去修改controller、service、dao程式碼了，風險也減少了很多。

程式碼中建立了一個ThreadLocal traceIdKD，這個物件用來操作Thread中一個口袋，用這個口袋來存放tranceId。在main方法中通過traceIdKD.set(traceId)方法將traceId放入口袋，log方法中通traceIdKD.get()獲取口袋中的traceId，最後任務處理完之後，main中的finally中呼叫traceIdKD.remove();將口袋中的traceId清除。

ThreadLocal的官方API解釋為：

“該類提供了執行緒區域性 (thread-local) 變數。這些變數不同於它們的普通對應物，因為訪問某個變數（通過其 get 或 set 方法）的每個執行緒都有自己的區域性變數，它獨立於變數的初始化副本。ThreadLocal 例項通常是類中的 private static 欄位，它們希望將狀態與某一個執行緒（例如，使用者 ID 或事務 ID）相關聯。”

InheritableThreadLocal

繼續上面的例項，dao中迴圈處理dataList的內容，假如dataList處理比較耗時，我們想加快處理速度有什麼辦法麼？大家已經想到了，用多執行緒並行處理dataList，那麼我們把程式碼改一下，如下：

package com.itsoku.chat24;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.LinkedBlockingDeque;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * 跟著阿里p7學併發，微信公眾號：javacode2018
 */
public class Demo4 {

    //建立一個操作Thread中存放請求任務追蹤id口袋的物件
    static ThreadLocal<String> traceIdKD = new ThreadLocal<>();

    static AtomicInteger threadIndex = new AtomicInteger(1);
    //建立處理請求的執行緒池子
    static ThreadPoolExecutor disposeRequestExecutor = new ThreadPoolExecutor(3,
            3,
            60,
            TimeUnit.SECONDS,
            new LinkedBlockingDeque<>(),
            r -> {
                Thread thread = new Thread(r);
                thread.setName("disposeRequestThread-" + threadIndex.getAndIncrement());
                return thread;
            });

    //記錄日誌
    public static void log(String msg) {
        StackTraceElement stack[] = (new Throwable()).getStackTrace();
        //獲取當前執行緒存放tranceId口袋中的內容
        String traceId = traceIdKD.get();
        System.out.println("****" + System.currentTimeMillis() + "[traceId:" + traceId + "],[執行緒:" + Thread.currentThread().getName() + "]," + stack[1] + ":" + msg);
    }

    //模擬controller
    public static void controller(List<String> dataList) {
        log("接受請求");
        service(dataList);
    }

    //模擬service
    public static void service(List<String> dataList) {
        log("執行業務");
        dao(dataList);
    }

    //模擬dao
    public static void dao(List<String> dataList) {
        CountDownLatch countDownLatch = new CountDownLatch(dataList.size());

        log("執行資料庫操作");
        String threadName = Thread.currentThread().getName();
        //模擬插入資料
        for (String s : dataList) {
            new Thread(() -> {
                try {
                    //模擬資料庫操作耗時100毫秒
                    TimeUnit.MILLISECONDS.sleep(100);
                    log("插入資料" + s + "成功,主執行緒：" + threadName);
                } catch (InterruptedException e) {
                    e.printStackTrace();
                } finally {
                    countDownLatch.countDown();
                }
            }).start();
        }
        //等待上面的dataList處理完畢
        try {
            countDownLatch.await();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }

    public static void main(String[] args) {
        //需要插入的資料
        List<String> dataList = new ArrayList<>();
        for (int i = 0; i < 3; i++) {
            dataList.add("資料" + i);
        }

        //模擬5個請求
        int requestCount = 5;
        for (int i = 0; i < requestCount; i++) {
            String traceId = String.valueOf(i);
            disposeRequestExecutor.execute(() -> {
                //把traceId放入口袋中
                traceIdKD.set(traceId);
                try {
                    controller(dataList);
                } finally {
                    //將tranceId從口袋中移除
                    traceIdKD.remove();
                }
            });
        }

        disposeRequestExecutor.shutdown();
    }
}

輸出：

****1565339904279[traceId:0],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo4.controller(Demo4.java:42):接受請求
****1565339904279[traceId:0],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo4.service(Demo4.java:48):執行業務
****1565339904279[traceId:1],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo4.controller(Demo4.java:42):接受請求
****1565339904279[traceId:1],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo4.service(Demo4.java:48):執行業務
****1565339904279[traceId:2],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo4.controller(Demo4.java:42):接受請求
****1565339904279[traceId:2],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo4.service(Demo4.java:48):執行業務
****1565339904279[traceId:0],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo4.dao(Demo4.java:56):執行資料庫操作
****1565339904279[traceId:1],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo4.dao(Demo4.java:56):執行資料庫操作
****1565339904279[traceId:2],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo4.dao(Demo4.java:56):執行資料庫操作
****1565339904281[traceId:null],[執行緒:Thread-3],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:62):插入資料資料0成功,主執行緒：disposeRequestThread-1
****1565339904281[traceId:null],[執行緒:Thread-5],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:62):插入資料資料0成功,主執行緒：disposeRequestThread-2
****1565339904281[traceId:null],[執行緒:Thread-4],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:62):插入資料資料0成功,主執行緒：disposeRequestThread-3
****1565339904281[traceId:null],[執行緒:Thread-6],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:62):插入資料資料1成功,主執行緒：disposeRequestThread-3
****1565339904281[traceId:null],[執行緒:Thread-9],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:62):插入資料資料2成功,主執行緒：disposeRequestThread-3
****1565339904282[traceId:null],[執行緒:Thread-8],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:62):插入資料資料1成功,主執行緒：disposeRequestThread-1
****1565339904282[traceId:null],[執行緒:Thread-10],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:62):插入資料資料2成功,主執行緒：disposeRequestThread-1
****1565339904282[traceId:3],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo4.controller(Demo4.java:42):接受請求
****1565339904282[traceId:null],[執行緒:Thread-7],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:62):插入資料資料1成功,主執行緒：disposeRequestThread-2
****1565339904282[traceId:null],[執行緒:Thread-11],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:62):插入資料資料2成功,主執行緒：disposeRequestThread-2
****1565339904282[traceId:3],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo4.service(Demo4.java:48):執行業務
****1565339904282[traceId:4],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo4.controller(Demo4.java:42):接受請求
****1565339904283[traceId:3],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo4.dao(Demo4.java:56):執行資料庫操作
****1565339904283[traceId:4],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo4.service(Demo4.java:48):執行業務
****1565339904283[traceId:4],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo4.dao(Demo4.java:56):執行資料庫操作
****1565339904283[traceId:null],[執行緒:Thread-12],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:62):插入資料資料0成功,主執行緒：disposeRequestThread-3
****1565339904283[traceId:null],[執行緒:Thread-13],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:62):插入資料資料1成功,主執行緒：disposeRequestThread-3
****1565339904283[traceId:null],[執行緒:Thread-14],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:62):插入資料資料0成功,主執行緒：disposeRequestThread-1
****1565339904284[traceId:null],[執行緒:Thread-15],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:62):插入資料資料2成功,主執行緒：disposeRequestThread-3
****1565339904284[traceId:null],[執行緒:Thread-17],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:62):插入資料資料2成功,主執行緒：disposeRequestThread-1
****1565339904284[traceId:null],[執行緒:Thread-16],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:62):插入資料資料1成功,主執行緒：disposeRequestThread-1

看一下上面的輸出，有些traceId為null，這是為什麼呢？這是因為dao中為了提升處理速度，建立了子執行緒來並行處理，子執行緒呼叫log的時候，去自己的存放traceId的口袋中拿去東西，肯定是空的了。

那有什麼辦法麼？可不可以這樣？

父執行緒相當於主管，子執行緒相當於幹活的小弟，主管讓小弟們幹活的時候，將自己兜裡面的東西複製一份給小弟們使用，主管兜裡面可能有很多牛逼的工具，為了提升小弟們的工作效率，給小弟們都複製一個，丟到小弟們的兜裡，然後小弟就可以從自己的兜裡拿去這些東西使用了，也可以清空自己兜裡面的東西。

Thread物件中有個inheritableThreadLocals變數，程式碼如下：

ThreadLocal.ThreadLocalMap inheritableThreadLocals = null;

inheritableThreadLocals相當於執行緒中另外一種兜，這種兜有什麼特徵呢，當建立子執行緒的時候，子執行緒會將父執行緒這種型別兜的東西全部複製一份放到自己的inheritableThreadLocals兜中，使用InheritableThreadLocal物件可以操作執行緒中的inheritableThreadLocals兜。

InheritableThreadLocal常用的方法也有3個：

//向Thread中某個口袋中放東西
public void set(T value);
//獲取這個口袋中目前放的東西
public T get();
//清空這個口袋中放的東西
public void remove()

使用InheritableThreadLocal解決上面子執行緒中無法輸出traceId的問題，只需要將上一個示例程式碼中的ThreadLocal替換成InheritableThreadLocal即可，程式碼如下：

package com.itsoku.chat24;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.LinkedBlockingDeque;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * 跟著阿里p7學併發，微信公眾號：javacode2018
 */
public class Demo4 {

    //建立一個操作Thread中存放請求任務追蹤id口袋的物件,子執行緒可以繼承父執行緒中內容
    static InheritableThreadLocal<String> traceIdKD = new InheritableThreadLocal<>();

    static AtomicInteger threadIndex = new AtomicInteger(1);
    //建立處理請求的執行緒池子
    static ThreadPoolExecutor disposeRequestExecutor = new ThreadPoolExecutor(3,
            3,
            60,
            TimeUnit.SECONDS,
            new LinkedBlockingDeque<>(),
            r -> {
                Thread thread = new Thread(r);
                thread.setName("disposeRequestThread-" + threadIndex.getAndIncrement());
                return thread;
            });

    //記錄日誌
    public static void log(String msg) {
        StackTraceElement stack[] = (new Throwable()).getStackTrace();
        //獲取當前執行緒存放tranceId口袋中的內容
        String traceId = traceIdKD.get();
        System.out.println("****" + System.currentTimeMillis() + "[traceId:" + traceId + "],[執行緒:" + Thread.currentThread().getName() + "]," + stack[1] + ":" + msg);
    }

    //模擬controller
    public static void controller(List<String> dataList) {
        log("接受請求");
        service(dataList);
    }

    //模擬service
    public static void service(List<String> dataList) {
        log("執行業務");
        dao(dataList);
    }

    //模擬dao
    public static void dao(List<String> dataList) {
        CountDownLatch countDownLatch = new CountDownLatch(dataList.size());

        log("執行資料庫操作");
        String threadName = Thread.currentThread().getName();
        //模擬插入資料
        for (String s : dataList) {
            new Thread(() -> {
                try {
                    //模擬資料庫操作耗時100毫秒
                    TimeUnit.MILLISECONDS.sleep(100);
                    log("插入資料" + s + "成功,主執行緒：" + threadName);
                } catch (InterruptedException e) {
                    e.printStackTrace();
                } finally {
                    countDownLatch.countDown();
                }
            }).start();
        }
        //等待上面的dataList處理完畢
        try {
            countDownLatch.await();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }

    public static void main(String[] args) {
        //需要插入的資料
        List<String> dataList = new ArrayList<>();
        for (int i = 0; i < 3; i++) {
            dataList.add("資料" + i);
        }

        //模擬5個請求
        int requestCount = 5;
        for (int i = 0; i < requestCount; i++) {
            String traceId = String.valueOf(i);
            disposeRequestExecutor.execute(() -> {
                //把traceId放入口袋中
                traceIdKD.set(traceId);
                try {
                    controller(dataList);
                } finally {
                    //將tranceId從口袋中移除
                    traceIdKD.remove();
                }
            });
        }

        disposeRequestExecutor.shutdown();
    }
}

輸出：

****1565341611454[traceId:1],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo4.controller(Demo4.java:42):接受請求
****1565341611454[traceId:2],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo4.controller(Demo4.java:42):接受請求
****1565341611454[traceId:0],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo4.controller(Demo4.java:42):接受請求
****1565341611454[traceId:2],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo4.service(Demo4.java:48):執行業務
****1565341611454[traceId:1],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo4.service(Demo4.java:48):執行業務
****1565341611454[traceId:0],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo4.service(Demo4.java:48):執行業務
****1565341611454[traceId:2],[執行緒:disposeRequestThread-3],com.itsoku.chat24.Demo4.dao(Demo4.java:56):執行資料庫操作
****1565341611454[traceId:1],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo4.dao(Demo4.java:56):執行資料庫操作
****1565341611454[traceId:0],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo4.dao(Demo4.java:56):執行資料庫操作
****1565341611557[traceId:2],[執行緒:Thread-5],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:64):插入資料資料0成功,主執行緒：disposeRequestThread-3
****1565341611557[traceId:0],[執行緒:Thread-4],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:64):插入資料資料0成功,主執行緒：disposeRequestThread-1
****1565341611557[traceId:1],[執行緒:Thread-11],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:64):插入資料資料2成功,主執行緒：disposeRequestThread-2
****1565341611557[traceId:1],[執行緒:Thread-3],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:64):插入資料資料0成功,主執行緒：disposeRequestThread-2
****1565341611557[traceId:1],[執行緒:Thread-8],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:64):插入資料資料1成功,主執行緒：disposeRequestThread-2
****1565341611557[traceId:0],[執行緒:Thread-6],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:64):插入資料資料1成功,主執行緒：disposeRequestThread-1
****1565341611557[traceId:0],[執行緒:Thread-10],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:64):插入資料資料2成功,主執行緒：disposeRequestThread-1
****1565341611557[traceId:3],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo4.controller(Demo4.java:42):接受請求
****1565341611557[traceId:2],[執行緒:Thread-9],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:64):插入資料資料2成功,主執行緒：disposeRequestThread-3
****1565341611558[traceId:2],[執行緒:Thread-7],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:64):插入資料資料1成功,主執行緒：disposeRequestThread-3
****1565341611557[traceId:3],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo4.service(Demo4.java:48):執行業務
****1565341611557[traceId:4],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo4.controller(Demo4.java:42):接受請求
****1565341611558[traceId:3],[執行緒:disposeRequestThread-2],com.itsoku.chat24.Demo4.dao(Demo4.java:56):執行資料庫操作
****1565341611558[traceId:4],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo4.service(Demo4.java:48):執行業務
****1565341611558[traceId:4],[執行緒:disposeRequestThread-1],com.itsoku.chat24.Demo4.dao(Demo4.java:56):執行資料庫操作
****1565341611659[traceId:3],[執行緒:Thread-15],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:64):插入資料資料2成功,主執行緒：disposeRequestThread-2
****1565341611659[traceId:4],[執行緒:Thread-14],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:64):插入資料資料0成功,主執行緒：disposeRequestThread-1
****1565341611659[traceId:3],[執行緒:Thread-13],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:64):插入資料資料1成功,主執行緒：disposeRequestThread-2
****1565341611659[traceId:3],[執行緒:Thread-12],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:64):插入資料資料0成功,主執行緒：disposeRequestThread-2
****1565341611660[traceId:4],[執行緒:Thread-16],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:64):插入資料資料1成功,主執行緒：disposeRequestThread-1
****1565341611660[traceId:4],[執行緒:Thread-17],com.itsoku.chat24.Demo4.lambda$dao$1(Demo4.java:64):插入資料資料2成功,主執行緒：disposeRequestThread-1

輸出中都有traceId了，和期望的結果一致。

希望通過這篇文章可以學會使用InheritableThreadLocal和InheritableThreadLocal。有問題可以加我微信itsoku交流，也可以留言，謝謝。

java高併發系列目錄

java高併發系列連載中，總計估計會有四五十篇文章。

阿里p7一起學併發，公眾號：路人甲java，每天獲取最新文章！

java高併發系列 - 第24天：ThreadLocal、InheritableThreadLocal（通俗易懂）

java高併發系列 - 第21天：java中的CAS操作，java併發的基石
2019-08-05
Java
java高併發系列 - 第12天JUC:ReentrantLock重入鎖
2019-07-17
JavaReentrantLock
Java併發——ThreadLocal分析
2018-09-07
Javathread
ThreadLocal及InheritableThreadLocal的原理剖析
2019-03-28
thread
java高併發核心要點|系列1
2019-06-13
Java
Java高併發系列——檢視閱讀
2020-09-11
Java
Java併發程式設計—ThreadLocal
2019-03-01
Java程式設計thread
Java併發程式設計 -- ThreadLocal
2018-08-26
Java程式設計thread
Java併發程式設計——ThreadLocal
2020-10-12
Java程式設計thread
java高併發系列 - 第14天：JUC中的LockSupport工具類，必備技能
2019-07-20
Java
Java~“全域性資料盒“ --類ThreadLocal和InheritableThreadLocal的使用
2020-10-10
Javathread
java高併發系列 - 第23天：JUC中原子類，一篇就夠了
2019-08-07
Java
java高併發系列 - 第22天：java中底層工具類Unsafe，高手必須要了解
2019-08-06
Java
Java併發：ThreadLocal的簡單介紹
2021-05-27
Javathread
Java併發程式設計：深入剖析ThreadLocal
2020-09-25
Java程式設計thread
JAVA併發-自問自答學ThreadLocal
2017-11-17
Javathread
Java 高併發思路
2019-02-28
Java
Java高併發綜合
2017-10-13
Java
Java多執行緒與併發之ThreadLocal
2020-02-17
Java執行緒thread
併發-5-ThreadLocal
2018-10-17
thread
併發容器之ThreadLocal
2018-05-06
thread
面試系列<3>——java併發
2021-04-22
面試Java
Java併發系列—併發程式設計挑戰
2018-01-22
Java程式設計
java併發包學習系列：jdk併發容器
2016-07-13
JavaJDK
java高併發系列 - 第16天：JUC中等待多執行緒完成的工具類CountDownLatch，必備技能
2019-07-22
Java執行緒CountDownLatch
坑系列 —— 快取 + 雜湊 = 高併發？
2016-07-08
快取
java併發系列——底層CPU
2022-01-04
Java
Java併發系列之volatile
2018-11-07
Java
Java併發系列—工具類：Semaphore
2018-05-15
Java
java併發程式設計系列：java併發程式設計背景知識
2019-04-17
Java程式設計
併發程式設計之：ThreadLocal
2021-08-31
程式設計thread
（四）Java高併發秒殺API之高併發優化
2018-12-12
JavaAPI優化
Java高併發測試框架JCStress
2021-04-07
Java框架
Java高併發之CyclicBarrier簡介
2023-03-13
Java
通俗易懂，JDK 併發容器總結
2019-01-19
JDK
[Java併發系列] 1.Java併發機制的底層實現
2017-11-11
Java
高併發程式設計系列：4種Java執行緒鎖全面詳解
2023-04-23
程式設計Java執行緒
Java併發系列 — 執行緒池
2019-01-04
Java執行緒

java高併發系列 - 第24天：ThreadLocal、InheritableThreadLocal（通俗易懂）

本文內容

需要解決的問題

ThreadLocal

InheritableThreadLocal

java高併發系列目錄

相關文章